Skip to content

Commit

Permalink
Add limitiations doc for manageTLS
Browse files Browse the repository at this point in the history
Document that runtime components are responsible for making use
of the TLS certificates created by the operator when
mangeTLS=true
  • Loading branch information
idlewis committed Sep 15, 2023
1 parent 055a7d0 commit 734be06
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/user-guide-v1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -343,3 +343,10 @@ NOTE: The `RuntimeOperation` CR must be created in the same namespace as the Pod
=== Troubleshooting

See the link:++troubleshooting.adoc++[troubleshooting guide] for information on how to investigate and resolve deployment problems.

== Limitations
=== Using certificates when manageTLS=true
If `manageTLS=true` is specified in the CR YAML file, then the operator will manage the creation of a TLS secret for the runtime component.
However, it is the responsibility of the runtime component to make appropriate use of the secret. The runtime component can use the
value of the `TLS_DIR` environment variable to discover the directory where the certificate files are mounted inside the runtime component's
pods.

0 comments on commit 734be06

Please sign in to comment.