diff options
| author |   Vijay VK <vv770d@att.com> | 2018-11-02 05:07:27 +0100 |
|---|---|---|
| committer | VENKATESH KUMAR <vv770d@att.com> | 2018-11-02 00:08:41 -0400 |
| commit | f6659fc784a6e088fd2eac79efe40e48991014f7 (patch) | |
| tree | 999a0b6716f9224758fc61e8cee8d62fdc5b2936 /docs/sections/tls_enablement.rst | |
| parent | 0854090a69fa3016c33c33beedae7a032fbaf029 (diff) | |
dcae doc updates
Change-Id: Ia63b7669d55c929d729663418747ab7e52ae89d4
Signed-off-by: VENKATESH KUMAR <vv770d@att.com>
Issue-ID: DCAEGEN2-772
Diffstat (limited to 'docs/sections/tls_enablement.rst')
| -rw-r--r-- | docs/sections/tls_enablement.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/sections/tls_enablement.rst b/docs/sections/tls_enablement.rst index 577dc8e5..2d7b0071 100644 --- a/docs/sections/tls_enablement.rst +++ b/docs/sections/tls_enablement.rst @@ -17,6 +17,16 @@ Solution overview * A boolean (``use_tls``) that indicates whether the component uses TLS. * A string (``cert_directory``) that indicates where the component expects to find certificate artifacts. + Example +.. code-block:: yaml + + tls_info: + cert_directory: '/opt/app/dh/etc/cert/' + use_tls: true + +For this example the certificates are mounted into /opt/app/dh/etc/cert directory within the conainer. + + During deployment Kubernetes plugin (referenced in blueprint) will check if the ``tls_info`` property is set and ``use_tls`` is set to true, then the plugin will add some elements to the Kubernetes Deployment for the component: * A Kubernetes volume (``tls-info``) that will hold the certificate artifacts * A Kubernetes initContainer (``tls-init``) |