Skip to content

Commit e9404c7

Browse files
authored
Merge pull request #71256 from bergerhoffer/OSDOCS-8971
OSDOCS#8971: Docs for change in secret generation behavior when the i…
2 parents c26c7f2 + 8382b4f commit e9404c7

File tree

3 files changed

+23
-3
lines changed

3 files changed

+23
-3
lines changed

installing/cluster-capabilities.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ include::modules/cluster-image-registry-operator.adoc[leveloffset=+2]
118118
[role="_additional-resources"]
119119
.Additional resources
120120
* xref:../registry/configuring-registry-operator.adoc#configuring-registry-operator[Image Registry Operator in {product-title}]
121+
* xref:../nodes/pods/nodes-pods-secrets.adoc#auto-generated-sa-token-secrets_nodes-pods-secrets[Automatically generated secrets]
121122
122123
[role="_additional-resources"]
123124
[id="additional-resources_{context}"]

modules/cluster-image-registry-operator.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,13 @@ If insufficient information is available to define a complete `image-registry` r
3434
The Cluster Image Registry Operator runs in the `openshift-image-registry` namespace and it also manages the registry instance in that location. All configuration and workload resources for the registry reside in that namespace.
3535

3636
ifdef::cluster-caps[]
37+
In order to integrate the image registry into the cluster's user authentication and authorization system, a service account token secret and an image pull secret are generated for each service account in the cluster.
38+
39+
[IMPORTANT]
40+
====
41+
If you disable the `ImageRegistry` capability or if you disable the integrated {product-registry} in the Cluster Image Registry Operator's configuration, the service account token secret and image pull secret are not generated for each service account.
42+
====
43+
3744
If you disable the `ImageRegistry` capability, you can reduce the overall resource footprint of {product-title} in Telco environments. Depending on your deployment, you can disable this component if you do not need it.
3845
endif::[]
3946

@@ -47,4 +54,4 @@ ifeval::["{context}" == "cluster-operators-ref"]
4754
endif::[]
4855
ifeval::["{context}" == "cluster-capabilities"]
4956
:!cluster-caps:
50-
endif::[]
57+
endif::[]

modules/service-account-auto-secret-removed.adoc

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,13 @@
55

66
:_mod-docs-content-type: CONCEPT
77
[id="auto-generated-sa-token-secrets_{context}"]
8-
= About automatically generated service account token secrets
8+
= Automatically generated secrets
99

10-
When a service account is created, a service account token secret is automatically generated for it. This service account token secret, along with an automatically generated docker configuration secret, is used to authenticate to the internal {product-title} registry. Do not rely on these automatically generated secrets for your own use; they might be removed in a future {product-title} release.
10+
By default, {product-title} creates the following secrets for each service account:
1111

12+
* A dockercfg image pull secret
13+
* A service account token secret
14+
+
1215
[NOTE]
1316
====
1417
Prior to {product-title} 4.11, a second service account token secret was generated when a service account was created. This service account token secret was used to access the Kubernetes API.
@@ -18,6 +21,15 @@ Starting with {product-title} 4.11, this second service account token secret is
1821
After upgrading to {product-version}, any existing service account token secrets are not deleted and continue to function.
1922
====
2023

24+
This service account token secret and docker configuration image pull secret are necessary to integrate the {product-registry} into the cluster's user authentication and authorization system.
25+
26+
However, if you do not enable the `ImageRegistry` capability or if you disable the integrated {product-registry} in the Cluster Image Registry Operator's configuration, these secrets are not generated for each service account.
27+
28+
[WARNING]
29+
====
30+
Do not rely on these automatically generated secrets for your own use; they might be removed in a future {product-title} release.
31+
====
32+
2133
Workloads are automatically injected with a projected volume to obtain a bound service account token. If your workload needs an additional service account token, add an additional projected volume in your workload manifest. Bound service account tokens are more secure than service account token secrets for the following reasons:
2234

2335
* Bound service account tokens have a bounded lifetime.

0 commit comments

Comments
 (0)