Custom configurations

The custom configurations of MOSN.

This topic describes custom configurations of MOSN.

Duration String

  • A string that consists of a decimal digit and a time unit suffix. Valid time units: ns, us (or µs), ms, s, m, and h. For example, 1 h, 3s, and 500 ms.

metadata

metadata is used for matching MOSN routes and cluster hosts.

  1. {
  2.   "filter_metadata":{
  3.     "mosn.lb":{}
  4.   }
  5. }

mosn.lb corresponds to any string-string content.

tls_context

  1. {
  2.   "status":"",
  3.   "type":"",
  4.   "server_name":"",
  5.   "ca_cert":"",
  6.   "cert_chain":"",
  7.   "private_key":"",
  8.   "verify_client":"",
  9.   "require_client_cert":"",
  10.   "insecure_skip":"",
  11.   "cipher_suites":"",
  12.   "ecdh_curves":"",
  13.   "min_version":"",
  14.   "max_version":"",
  15.   "alpn":"",
  16.   "fall_back":"",
  17.   "extend_verify":"",
  18.   "sds_source":{}
  19. }
  • status: Boolean. Indicates whether TLS is enabled. Default value: false.
  • type: String. Specifies the type of tls_context. tls_context supports extension implementation. Different types correspond to different implementation methods. Default value:”” (empty string).
  • server_name: Used to verify the hostname of the certificate returned by the server when insecure_skip is not configured. Valid when configured at a cluster.
  • ca_cert: The root certificate issued by a trusted certificate authority (CA).
  • cert_chain: The TLS certificate chain.
  • private_key: The private key of a certificate.
  • verify_client: Boolean. Specifies whether to verify a client certificate. Valid when configured at a listener.
  • require_client_cert: Boolean. Specifies whether the client certificate is required.
  • insecure_skip: Boolean. Specifies whether to skip server certificate verification. Valid when configured at a cluster.
  • cipher_suites: Specifies the cipher suites to be supported by TLS connections. If this parameter is specified, TLS connections support only the specified cipher suites and use them according to the order of how they are specified. Separate different cipher suites with a comma. Valid values:
  1. ECDHE-ECDSA-AES256-GCM-SHA384
  2. ECDHE-RSA-AES256-GCM-SHA384
  3. ECDHE-ECDSA-AES128-GCM-SHA256
  4. ECDHE-RSA-AES128-GCM-SHA256
  5. ECDHE-ECDSA-WITH-CHACHA20-POLY1305
  6. ECDHE-RSA-WITH-CHACHA20-POLY1305
  7. ECDHE-RSA-AES256-CBC-SHA
  8. ECDHE-RSA-AES128-CBC-SHA
  9. ECDHE-ECDSA-AES256-CBC-SHA
  10. ECDHE-ECDSA-AES128-CBC-SHA
  11. RSA-AES256-CBC-SHA
  12. RSA-AES128-CBC-SHA
  13. ECDHE-RSA-3DES-EDE-CBC-SHA
  14. RSA-3DES-EDE-CBC-SHA
  15. ECDHE-RSA-SM4-SM3
  16. ECDHE-ECDSA-SM4-SM3

  • ecdh_curves: If this parameter is used, TLS connections support only the specified curves.

    • Valid values: x25519, p256, p384, and p521.

  • min_version: The earliest TLS version supported.

    • Valid values: TLS1.0, TLS1.1, and TLS1.2. Default value: TLS1.0.
    • Available TLS versions will be automatically identified by default.

  • max_version: The latest TLS version supported.

    • Valid values: TLS1.0, TLS1.1, and TLS1.2. Default value: TLS1.2.
    • Available TLS versions will be automatically identified by default.

  • alpn: Specifies the protocol supported by ALPN on TLS connections.

    • Valid values: H2, HTTP/1.1, and SOFA.

  • fall_back: Boolean. Specifies whether to fall back when certificate verification fails, without returning an error. This is equivalent to the case when TLS is not enabled. Valid values: True and False.

  • extend_verify: JSON. Specifies the extension of tls_context when type is not empty.

  • sds_source: Specifies parameters required for accessing the SDS API. If sds_source is configured, the ca_cert, cert_chain, and private_key parameters will be ignored, but other configurations will remain valid.

sds_source

  1. {
  2.   "CertificateConfig":{},
  3.   "ValidationConfig":{}
  4. }
  • CertificateConfig: Specifies how to obtain the values of cert_chain and private_key.
  • ValidationConfig: Specifies how to obtain the value of ca_cert.
  • For details about the configurations, see envoy: sds_secret_config.

Last modified October 28, 2022: docs: Changes to the v1.2.0 configuration (#217) (d237414)