Skip to content

Add limitiations doc for manageTLS #562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add limitiations doc for manageTLS #562

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
734be06
Add limitiations doc for manageTLS
idlewis Jul 20, 2023
952d7ed
Remove 0.5.0 known issues
idlewis Sep 19, 2023
25602ee
reword to show that 'true' is the default for manageTLS
idlewis Sep 20, 2023
89eb9cd
Update troubleshooting.adoc
idlewis Sep 20, 2023
2475d43
Add some alternatives.
idlewis Sep 21, 2023
31b9d04
spelling
idlewis Sep 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions doc/user-guide-v1.adoc
View file
Open in desktop
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.
Copy link
Member

@leochr leochr Sep 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

manageTLS is true by default - even if it's not specified in CR YAML. It'll be good to mention/clarify so that users don't remove it and expect manageTLS to be false

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.