Skip to content

docs: Document automatic DevWorkspace Operator TLS certificate configuration #3128

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

Draft
tolusha wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −0
Draft

docs: Document automatic DevWorkspace Operator TLS certificate configuration #3128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions modules/administration-guide/pages/importing-untrusted-tls-certificates.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Therefore, you must import into {prod-short} all untrusted CA chains in use by a
* A proxy
* An identity provider (OIDC)
* A source code repositories provider (Git)
* A parent devfile referenced via URI with untrusted TLS

{prod-short} uses labeled ConfigMaps in {prod-short} {orch-namespace} as sources for TLS certificates.
The ConfigMaps can have an arbitrary amount of keys with an arbitrary amount of certificates each.
Expand All @@ -40,6 +41,9 @@ spec:
On OpenShift cluster, {prod-short} operator automatically adds Red Hat Enterprise Linux CoreOS (RHCOS) trust bundle into mounted certificates.
====

When certificates are imported, the {prod-short} operator automatically configures the {devworkspace} Operator to trust these certificates by setting the `tlsCertificateConfigmapRef` field in the {devworkspace} Operator configuration to reference the `ca-certs-merged` ConfigMap.
This enables the {devworkspace} Operator to trust the certificates when resolving parent devfile references via URI that use untrusted TLS certificates.

.Prerequisites
* An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster.
See {orch-cli-link}.
Expand Down Expand Up @@ -113,6 +117,24 @@ This command returns {prod-short} CA bundle certificates in PEM format:
--output='jsonpath={.data.tls-ca-bundle\.pem}'
----

. Verify that the {devworkspace} Operator is configured to trust the imported certificates.
This command returns the TLS certificate ConfigMap reference in the {devworkspace} Operator configuration:
+
[subs="+attributes,+quotes",options="nowrap",role=white-space-pre]
----
{orch-cli} get devworkspaceoperatorconfig \
--namespace={prod-namespace} \
devworkspace-config \
--output='jsonpath={.config.routing.tlsCertificateConfigmapRef}'
----
+
The output should show the reference to the `ca-certs-merged` ConfigMap:
+
[subs="+attributes,+quotes",options="nowrap",role=white-space-pre]
----
{"name":"ca-certs-merged","namespace":"__<prod-namespace>__"}
----

. Verify that the workspace pod mounts the `ca-certs-merged` ConfigMap:
+
[subs="+attributes,+quotes",options="nowrap",role=white-space-pre]
Expand Down
Loading