Supplies a private key and its certificate chain directly as PEM blocks, as an alternative to loading them from a keystore file. See tutorials/ssl-tls/10-TLS-Termination.yaml.


 key:
   private:
     location: <file> | content: <PEM text>
   certificates:
     - location: <file> | content: <PEM text>
     ...
   [ password: <password> ]   # only if the private key PEM is encrypted

Example Configuration

ssl:
   key:
     private:
       location: membrane-key.pem
     certificates:
       - location: membrane.pem

ssl:
   key:
     private:
       location: membrane-key.pem
     certificates:
       - location: membrane.pem

Syntax

key:
  certificates: # required
    - <certificate>
  '$ref': <string>
  password: <string>
  private: {}

key:
  certificates: # required
    - <certificate>
  '$ref': <string>
  password: <string>
  private: {}

Attributes

Name	Required	Default	Description	Examples
$ref	false	-	Reference a component defined under components.	-
password	false	not set	Password protecting the private key, if the PEM block is encrypted. In YAML, this can be a SpEL expression reading an environment variable instead of a literal value, e.g. "#{env.KEY_PASSWORD}", so the password itself need not be checked into version control.	-

Child Structure

Element	Cardinality	Description
certificate	1..*	The certificate chain for the private key: the leaf certificate first, followed by any intermediates, each as its own PEM block either inline or loaded from a file.
private	0..1	The private key, as a PEM block either inline or loaded from a file.

Can be used in

components keyGenerator ssl