Skip to content

Commit 9e5b018

Browse files
authored
Merge pull request #101753 from skopacz1/100838_4.13
[enterprise-4.13] OSDOCS-16572: first batch of rec visibility changes
2 parents 9d2df81 + 5eea385 commit 9e5b018

6 files changed

+50
-9
lines changed

modules/authentication-authorization-common-terms.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,12 @@ manual mode::
4545
In manual mode, a user manages cloud credentials instead of the Cloud Credential Operator (CCO).
4646

4747
mint mode::
48-
Mint mode is the default and recommended best practice setting for the Cloud Credential Operator (CCO) to use on the platforms for which it is supported. In this mode, the CCO uses the provided administrator-level cloud credential to create new credentials for components in the cluster with only the specific permissions that are required.
48+
In mint mode, the Cloud Credential Operator (CCO) uses the provided administrator-level cloud credential to create new credentials for components in the cluster with only the specific permissions that are required.
49+
+
50+
[NOTE]
51+
====
52+
Mint mode is the default and the preferred setting for the CCO to use on the platforms for which it is supported.
53+
====
4954

5055
namespace::
5156
A namespace isolates specific system resources that are visible to all processes. Inside a namespace, only processes that are members of that namespace can see those resources.

modules/ldap-syncing-nesting.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,12 @@ values are ignored. `groupsQuery` must set a valid `derefAliases`.
129129
<2> The attribute that uniquely identifies a group on the LDAP server. It must be set to `dn`.
130130
<3> The attribute to use as the name of the group.
131131
<4> The attribute to use as the name of the user in the {product-title} group
132-
record. `mail` or `sAMAccountName` are preferred choices in most installations.
132+
record.
133+
+
134+
[NOTE]
135+
====
136+
`mail` or `sAMAccountName` are preferred choices in most installations.
137+
====
133138
<5> The attribute on the user that stores the membership information. Note the use
134139
of https://msdn.microsoft.com/en-us/library/aa746475(v=vs.85).aspx[`LDAP_MATCHING_RULE_IN_CHAIN`].
135140

modules/olm-accessing-images-private-registries.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ Repeat this step to create additional secrets for any other required private reg
117117

118118
. Create or update an existing `CatalogSource` object to reference one or more secrets:
119119
+
120+
--
120121
[source,yaml]
121122
----
122123
apiVersion: operators.coreos.com/v1alpha1
@@ -139,7 +140,13 @@ spec:
139140
interval: 30m
140141
----
141142
<1> Add a `spec.secrets` section and specify any required secrets.
142-
<2> Specify the value of `legacy` or `restricted`. If the field is not set, the default value is `legacy`. In a future {product-title} release, it is planned that the default value will be `restricted`. If your catalog cannot run with `restricted` permissions, it is recommended that you manually set this field to `legacy`.
143+
<2> Specify the value of `legacy` or `restricted`. If the field is not set, the default value is `legacy`. In a future {product-title} release, it is planned that the default value will be `restricted`.
144+
+
145+
[NOTE]
146+
====
147+
If your catalog cannot run with `restricted` permissions, it is recommended that you manually set this field to `legacy`.
148+
====
149+
--
143150

144151
. If any Operator or Operand images that are referenced by a subscribed Operator require access to a private registry, you can either provide access to all namespaces in the cluster, or individual target tenant namespaces.
145152

modules/olm-creating-catalog-from-index.adoc

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,10 @@ ifdef::olm-restricted-networks[]
6767
If you used the `oc adm catalog mirror` command to mirror your catalog to a target registry, you can use the generated `catalogSource.yaml` file in your manifests directory as a starting point.
6868
endif::[]
6969

70+
ifdef::olm-restricted-networks[]
7071
.. Modify the following to your specifications and save it as a `catalogSource.yaml` file:
7172
+
72-
ifdef::olm-restricted-networks[]
73+
--
7374
[source,yaml,subs="attributes+"]
7475
----
7576
apiVersion: operators.coreos.com/v1alpha1
@@ -90,12 +91,21 @@ spec:
9091
----
9192
<1> If you mirrored content to local files before uploading to a registry, remove any backslash (`/`) characters from the `metadata.name` field to avoid an "invalid resource name" error when you create the object.
9293
<2> If you want the catalog source to be available globally to users in all namespaces, specify the `{namespace}` namespace. Otherwise, you can specify a different namespace for the catalog to be scoped and available only for that namespace.
93-
<3> Specify the value of `legacy` or `restricted`. If the field is not set, the default value is `legacy`. In a future {product-title} release, it is planned that the default value will be `restricted`. If your catalog cannot run with `restricted` permissions, it is recommended that you manually set this field to `legacy`.
94+
<3> Specify the value of `legacy` or `restricted`. If the field is not set, the default value is `legacy`. In a future {product-title} release, it is planned that the default value will be `restricted`.
95+
+
96+
[NOTE]
97+
====
98+
If your catalog cannot run with `restricted` permissions, it is recommended that you manually set this field to `legacy`.
99+
====
94100
<4> Specify your index image. If you specify a tag after the image name, for example `:{tag}`, the catalog source pod uses an image pull policy of `Always`, meaning the pod always pulls the image prior to starting the container. If you specify a digest, for example `@sha256:<id>`, the image pull policy is `IfNotPresent`, meaning the pod pulls the image only if it does not already exist on the node.
95101
<5> Specify your name or an organization name publishing the catalog.
96102
<6> Catalog sources can automatically check for new versions to keep up to date.
103+
--
97104
endif::[]
98105
ifndef::olm-restricted-networks[]
106+
.. Modify the following to your specifications and save it as a `catalogSource.yaml` file:
107+
+
108+
--
99109
[source,yaml,subs="attributes+"]
100110
----
101111
apiVersion: operators.coreos.com/v1alpha1
@@ -119,10 +129,16 @@ spec:
119129
----
120130
<1> If you want the catalog source to be available globally to users in all namespaces, specify the `{namespace}` namespace. Otherwise, you can specify a different namespace for the catalog to be scoped and available only for that namespace.
121131
<2> Optional: Set the `olm.catalogImageTemplate` annotation to your index image name and use one or more of the Kubernetes cluster version variables as shown when constructing the template for the image tag.
122-
<3> Specify the value of `legacy` or `restricted`. If the field is not set, the default value is `legacy`. In a future {product-title} release, it is planned that the default value will be `restricted`. If your catalog cannot run with `restricted` permissions, it is recommended that you manually set this field to `legacy`.
132+
<3> Specify the value of `legacy` or `restricted`. If the field is not set, the default value is `legacy`. In a future {product-title} release, it is planned that the default value will be `restricted`.
133+
+
134+
[NOTE]
135+
====
136+
If your catalog cannot run with `restricted` permissions, it is recommended that you manually set this field to `legacy`.
137+
====
123138
<4> Specify your index image. If you specify a tag after the image name, for example `:{tag}`, the catalog source pod uses an image pull policy of `Always`, meaning the pod always pulls the image prior to starting the container. If you specify a digest, for example `@sha256:<id>`, the image pull policy is `IfNotPresent`, meaning the pod pulls the image only if it does not already exist on the node.
124139
<5> Specify your name or an organization name publishing the catalog.
125140
<6> Catalog sources can automatically check for new versions to keep up to date.
141+
--
126142
endif::[]
127143

128144
.. Use the file to create the `CatalogSource` object:

modules/olm-dependency-resolution-preferences.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@ spec:
2828
displayName: "My Operators"
2929
priority: 100
3030
----
31-
<1> Specify the value of `legacy` or `restricted`. If the field is not set, the default value is `legacy`. In a future {product-title} release, it is planned that the default value will be `restricted`. If your catalog cannot run with `restricted` permissions, it is recommended that you manually set this field to `legacy`.
31+
<1> Specify the value of `legacy` or `restricted`. If the field is not set, the default value is `legacy`. In a future {product-title} release, it is planned that the default value will be `restricted`.
32+
+
33+
[NOTE]
34+
====
35+
If your catalog cannot run with `restricted` permissions, it is recommended that you manually set this field to `legacy`.
36+
====
3237

3338
A `CatalogSource` object has a `priority` field, which is used by the resolver to know how to prefer options for a dependency.
3439

modules/telemetry-consequences-of-disabling-telemetry.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,19 @@
66
[id="telemetry-consequences-of-disabling-telemetry_{context}"]
77
= Consequences of disabling remote health reporting
88

9-
In {product-title}, customers can disable reporting usage information.
9+
In {product-title}, customers can disable reporting usage information.
1010

1111
Before you disable remote health reporting, read the following benefits of a connected cluster:
1212

1313
* Red{nbsp}Hat can react more quickly to problems and better support our customers.
14-
* Red{nbsp}Hat can better understand how product upgrades impact clusters.
14+
* Red{nbsp}Hat can better understand how product upgrades impact clusters.
1515
* Connected clusters help to simplify the subscription and entitlement process.
1616
* Connected clusters enable the {cluster-manager} service to offer an overview of your clusters and their subscription status.
1717
18+
[NOTE]
19+
====
1820
Consider leaving health and usage reporting enabled for pre-production, test, and production clusters. This means that Red{nbsp}Hat can participate in qualifying {product-title} in your environments and react more rapidly to product issues.
21+
====
1922

2023
The following lists some consequences of disabling remote health reporting on a connected cluster:
2124

0 commit comments

Comments
 (0)