Skip to content

Commit 7340af3

Browse files
Merge pull request #411 from syedriko/syedriko-ols-1863
OLS-1863: OCP docs and Python deps update, week of 2025/06/23
2 parents 226711f + d3ef30e commit 7340af3

File tree

169 files changed

+5383
-1306
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

169 files changed

+5383
-1306
lines changed

ocp-product-docs-plaintext/4.15/installing/installing_openstack/installing-openstack-user.txt

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,19 @@ The bootstrap machine requires:
9696

9797
# Downloading playbook dependencies
9898

99-
The Ansible playbooks that simplify the installation process on user-provisioned
100-
infrastructure require several Python modules. On the machine where you will run the installer,
101-
add the modules' repositories and then download them.
99+
The Ansible playbooks that simplify the installation process on user-provisioned infrastructure require several ansible collections and Python modules. On the machine where you will run the installation program, add the Red Hat OpenStack Platform (RHOSP) repositories and then install the packages.
100+
101+
The following dependencies are required:
102+
103+
* Python modules:
104+
* openstackclient
105+
* openstacksdk
106+
* netaddr
107+
* pip
108+
* Ansible collections:
109+
* ansible-collections-openstack, which installs Ansible Core
110+
* ansible-collection-community-general
111+
* ansible-collection-ansible-netcommon
102112

103113

104114
[NOTE]
@@ -131,16 +141,21 @@ $ sudo subscription-manager repos --disable=* # If not done already
131141

132142
```terminal
133143
$ sudo subscription-manager repos \
134-
--enable=rhel-8-for-x86_64-baseos-rpms \
135-
--enable=openstack-16-tools-for-rhel-8-x86_64-rpms \
136-
--enable=ansible-2.9-for-rhel-8-x86_64-rpms \
137-
--enable=rhel-8-for-x86_64-appstream-rpms
144+
--enable=rhel-9-for-x86_64-appstream-rpms \
145+
--enable=rhel-9-for-x86_64-baseos-rpms \
146+
--enable=openstack-17.1-for-rhel-9-x86_64-rpms
138147
```
139148

140149
2. Install the modules:
141150

142151
```terminal
143-
$ sudo yum install python3-openstackclient ansible python3-openstacksdk python3-netaddr ansible-collections-openstack
152+
$ sudo dnf install ansible-collection-ansible-netcommon \
153+
ansible-collection-community-general \
154+
ansible-collections-openstack \
155+
python3-netaddr \
156+
python3-openstackclient \
157+
python3-openstacksdk \
158+
python3-pip
144159
```
145160

146161
3. Ensure that the python command points to python3:

ocp-product-docs-plaintext/4.15/installing/installing_openstack/uninstalling-openstack-user.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,9 @@ $ sudo subscription-manager repos --disable=* # If not done already
4040

4141
```terminal
4242
$ sudo subscription-manager repos \
43-
--enable=rhel-8-for-x86_64-baseos-rpms \
44-
--enable=openstack-16-tools-for-rhel-8-x86_64-rpms \
45-
--enable=ansible-2.9-for-rhel-8-x86_64-rpms \
46-
--enable=rhel-8-for-x86_64-appstream-rpms
43+
--enable=rhel-9-for-x86_64-appstream-rpms \
44+
--enable=rhel-9-for-x86_64-baseos-rpms \
45+
--enable=openstack-17.1-for-rhel-9-x86_64-rpms
4746
```
4847

4948
2. Install the modules:

ocp-product-docs-plaintext/4.15/networking/ovn_kubernetes_network_provider/migrate-from-openshift-sdn.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,12 @@ $ oc get network.config cluster -o=jsonpath='{.status.conditions}' | jq .
313313

314314

315315
You can check limited live migration metrics for troubleshooting issues. For more information, see "Checking limited live migration metrics".
316+
3. After a successful migration operation, remove the network.openshift.io/network-type-migration- annotation from the network.config custom resource by entering the following command:
317+
318+
```terminal
319+
$ oc annotate network.config cluster network.openshift.io/network-type-migration-
320+
```
321+
316322

317323
### Patching OVN-Kubernetes address ranges
318324

@@ -1124,6 +1130,12 @@ $ oc patch Network.operator.openshift.io cluster --type='merge' \
11241130
$ oc delete namespace openshift-sdn
11251131
```
11261132

1133+
4. After a successful migration operation, remove the network.openshift.io/network-type-migration- annotation from the network.config custom resource by entering the following command:
1134+
1135+
```terminal
1136+
$ oc annotate network.config cluster network.openshift.io/network-type-migration-
1137+
```
1138+
11271139

11281140
* Optional: After cluster migration, you can convert your IPv4 single-stack cluster to a dual-network cluster network that supports IPv4 and IPv6 address families. For more information, see "Converting to IPv4/IPv6 dual-stack networking".
11291141

ocp-product-docs-plaintext/4.15/observability/distr_tracing/distr-tracing-rn.txt

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,57 @@ You can use the Red Hat OpenShift distributed tracing platform (Tempo) in combin
2121
Only supported features are documented. Undocumented features are currently unsupported. If you need assistance with a feature, contact Red Hat's support.
2222
----
2323

24+
# Release notes for distributed tracing platform 3.6
25+
26+
## Red Hat OpenShift distributed tracing platform (Tempo)
27+
28+
The Red Hat OpenShift distributed tracing platform (Tempo) 3.6 is provided through the Tempo Operator 0.16.0.
29+
30+
The Red Hat OpenShift distributed tracing platform (Tempo) 3.6 is based on the open source Grafana Tempo 2.7.2.
31+
32+
33+
[WARNING]
34+
----
35+
This is the first release of the Red Hat OpenShift distributed tracing platform that is shipped only with the Red Hat OpenShift distributed tracing platform (Tempo) and without the deprecated Red Hat OpenShift distributed tracing platform (Jaeger).
36+
If you have not migrated from the deprecated Red Hat OpenShift distributed tracing platform (Jaeger) Operator to the Tempo Operator and the Red Hat build of OpenTelemetry Operator for distributed tracing collection and storage, see "Release notes for Red Hat OpenShift distributed tracing platform 3.5".
37+
----
38+
39+
### Technology Preview features
40+
41+
This update introduces the following Technology Preview feature:
42+
43+
* TempoStack deployment combined with the distributed tracing UI plugin of the Cluster Observability Operator (COO) supports fine-grained query role-based access control (RBAC). With the enabled RBAC, your users can see the attributes only from the namespaces to which they are given access.
44+
45+
46+
[IMPORTANT]
47+
----
48+
{FeatureName} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
49+
For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.
50+
----
51+
52+
### New features and enhancements
53+
54+
This update introduces the following enhancements:
55+
56+
* Support for authentication using the Google Cloud Platform (GCP) Workload Identity Federation short-lived tokens. This enables secure and temporary credential access for workloads running with the GCP.
57+
* Support for authentication using the Azure Workload Identity Federation short-lived tokens. This allows secure and temporary access for workloads federated with the Azure Active Directory.
58+
* Support for the AWS Security Token Service (STS) through the CloudCredential Operator. This allows the use of dynamic and temporary AWS credentials for workloads.
59+
60+
### Bug fixes
61+
62+
This update introduces the following bug fixes:
63+
64+
* Before this update, the per-tenant retention configuration was not properly configured in the TempoStack instance. With this update, the per-tenant retention is properly configured in the TempoStack deployment.
65+
* Before this update, the oauth-proxy container did not have any compute resources assigned to it. With this update, the container correctly sets the resources as specified in the TempoStack custom resource.
66+
67+
### Known issues
68+
69+
The Red Hat OpenShift distributed tracing platform (Tempo) 3.6 has the following known issue:
70+
71+
* Currently, when the OpenShift tenancy mode is enabled, the ServiceAccount object of the gateway component of either a TempoStack or TempoMonolithic instance requires the TokenReview and SubjectAccessReview permissions for authorization.
72+
73+
Workaround: Deploy the instance in a dedicated namespace, and carefully audit which users have the permission to read the secrets in this namespace.
74+
2475
# Release notes for Red Hat OpenShift distributed tracing platform 3.5
2576

2677
This release of the Red Hat OpenShift distributed tracing platform includes the Red Hat OpenShift distributed tracing platform (Tempo) and the deprecated Red Hat OpenShift distributed tracing platform (Jaeger).

ocp-product-docs-plaintext/4.15/observability/distr_tracing/distr-tracing-tempo-configuring.txt

Lines changed: 101 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ spec: 5
2222
storage: {} 6
2323
resources: {} 7
2424
replicationFactor: 1 8
25-
retention: {} 9
25+
retention: 9
26+
global:
27+
traces: 48h
28+
perTenant: {}
2629
template:
2730
distributor: {} 10
2831
ingester: {} 11
@@ -51,7 +54,7 @@ Contains all of the configuration parameters of the TempoStack instance. When a
5154
Storage is specified at instance deployment. See the installation page for information about storage options for the instance.
5255
Defines the compute resources for the Tempo container.
5356
Integer value for the number of ingesters that must acknowledge the data from the distributors before accepting a span.
54-
Configuration options for retention of traces.
57+
Configuration options for retention of traces. The default value is 48h.
5558
Configuration options for the Tempo distributor component.
5659
Configuration options for the Tempo ingester component.
5760
Configuration options for the Tempo compactor component.
@@ -367,6 +370,102 @@ Minimal configuration for the TLS at the Tempo Distributor.
367370
* Understanding service serving certificates
368371
* Service CA certificates
369372

373+
# Configuring the query RBAC
374+
375+
As an administrator, you can set up the query role-based access control (RBAC) to filter the span attributes for your users by the namespaces for which you granted them permissions.
376+
377+
378+
[NOTE]
379+
----
380+
When you enable the query RBAC, users can still access traces from all namespaces, and the service.name and k8s.namespace.name attributes are also visible to all users.
381+
----
382+
383+
* An active OpenShift CLI (`oc`) session by a cluster administrator with the cluster-admin role.
384+
385+
[TIP]
386+
----
387+
* Ensure that your OpenShift CLI (`oc`) version is up to date and matches your Red Hat OpenShift Container Platform version.
388+
* Run oc login:
389+
390+
```terminal
391+
$ oc login --username=<your_username>
392+
```
393+
394+
----
395+
396+
1. Enable multitenancy and query RBAC in the TempoStack custom resource (CR), for example:
397+
398+
```yaml
399+
apiVersion: tempo.grafana.com/v1alpha1
400+
kind: TempoStack
401+
metadata:
402+
name: simplest
403+
namespace: chainsaw-multitenancy
404+
spec:
405+
storage:
406+
secret:
407+
name: minio
408+
type: s3
409+
storageSize: 1Gi
410+
resources:
411+
total:
412+
limits:
413+
memory: 2Gi
414+
cpu: 2000m
415+
tenants:
416+
mode: openshift
417+
authentication:
418+
- tenantName: dev
419+
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfb"
420+
template:
421+
gateway:
422+
enabled: true 1
423+
rbac:
424+
enabled: true 2
425+
queryFrontend:
426+
jaegerQuery:
427+
enabled: false 3
428+
```
429+
430+
Always set to true.
431+
Always set to true.
432+
Always set to false.
433+
2. Create a cluster role and cluster role binding to grant the target users the permissions to access the tenant that you specified in the TempoStack CR, for example:
434+
435+
```yaml
436+
apiVersion: rbac.authorization.k8s.io/v1
437+
kind: ClusterRole
438+
metadata:
439+
name: tempo-dev-read
440+
rules:
441+
- apiGroups: [tempo.grafana.com]
442+
resources: [dev] 1
443+
resourceNames: [traces]
444+
verbs: [get]
445+
---
446+
apiVersion: rbac.authorization.k8s.io/v1
447+
kind: ClusterRoleBinding
448+
metadata:
449+
name: tempo-dev-read
450+
roleRef:
451+
apiGroup: rbac.authorization.k8s.io
452+
kind: ClusterRole
453+
name: tempo-dev-read
454+
subjects:
455+
- kind: Group
456+
apiGroup: rbac.authorization.k8s.io
457+
name: system:authenticated 2
458+
```
459+
460+
Tenant name in the TempoStack CR.
461+
Means all authenticated OpenShift users.
462+
3. Grant the target users the permissions to read attributes for the project. You can do this by running the following command:
463+
464+
```bash
465+
$ oc adm policy add-role-to-user view <username> -n <project>
466+
```
467+
468+
370469
# Using taints and tolerations
371470

372471
To schedule the TempoStack pods on dedicated nodes, see How to deploy the different TempoStack components on infra nodes using nodeSelector and tolerations in OpenShift 4.

ocp-product-docs-plaintext/4.15/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44

55
[WARNING]
66
----
7-
The Red Hat OpenShift distributed tracing platform (Jaeger) 3.5 is the last release of the Red Hat OpenShift distributed tracing platform (Jaeger) that Red Hat plans to support.
8-
In the Red Hat OpenShift distributed tracing platform 3.5, Jaeger and support for Elasticsearch remain deprecated.
9-
Support for the Red Hat OpenShift distributed tracing platform (Jaeger) ends on November 3, 2025.
7+
The deprecated Red Hat OpenShift distributed tracing platform (Jaeger) 3.5 was the last release of the Red Hat OpenShift distributed tracing platform (Jaeger) that Red Hat supports.
8+
Support for the deprecated Red Hat OpenShift distributed tracing platform (Jaeger) ends on November 3, 2025.
109
The Red Hat OpenShift distributed tracing platform Operator (Jaeger) will be removed from the redhat-operators catalog on November 3, 2025. For more information, see the Red Hat Knowledgebase solution Jaeger Deprecation and Removal in OpenShift.
1110
You must migrate to the Red Hat build of OpenTelemetry Operator and the Tempo Operator for distributed tracing collection and storage. For more information, see "Migrating" in the Red Hat build of OpenTelemetry documentation, "Installing" in the Red Hat build of OpenTelemetry documentation, and "Installing" in the distributed tracing platform (Tempo) documentation.
1211
----

ocp-product-docs-plaintext/4.15/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44

55
[WARNING]
66
----
7-
The Red Hat OpenShift distributed tracing platform (Jaeger) 3.5 is the last release of the Red Hat OpenShift distributed tracing platform (Jaeger) that Red Hat plans to support.
8-
In the Red Hat OpenShift distributed tracing platform 3.5, Jaeger and support for Elasticsearch remain deprecated.
9-
Support for the Red Hat OpenShift distributed tracing platform (Jaeger) ends on November 3, 2025.
7+
The deprecated Red Hat OpenShift distributed tracing platform (Jaeger) 3.5 was the last release of the Red Hat OpenShift distributed tracing platform (Jaeger) that Red Hat supports.
8+
Support for the deprecated Red Hat OpenShift distributed tracing platform (Jaeger) ends on November 3, 2025.
109
The Red Hat OpenShift distributed tracing platform Operator (Jaeger) will be removed from the redhat-operators catalog on November 3, 2025. For more information, see the Red Hat Knowledgebase solution Jaeger Deprecation and Removal in OpenShift.
1110
You must migrate to the Red Hat build of OpenTelemetry Operator and the Tempo Operator for distributed tracing collection and storage. For more information, see "Migrating" in the Red Hat build of OpenTelemetry documentation, "Installing" in the Red Hat build of OpenTelemetry documentation, and "Installing" in the distributed tracing platform (Tempo) documentation.
1211
----

ocp-product-docs-plaintext/4.15/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44

55
[WARNING]
66
----
7-
The Red Hat OpenShift distributed tracing platform (Jaeger) 3.5 is the last release of the Red Hat OpenShift distributed tracing platform (Jaeger) that Red Hat plans to support.
8-
In the Red Hat OpenShift distributed tracing platform 3.5, Jaeger and support for Elasticsearch remain deprecated.
9-
Support for the Red Hat OpenShift distributed tracing platform (Jaeger) ends on November 3, 2025.
7+
The deprecated Red Hat OpenShift distributed tracing platform (Jaeger) 3.5 was the last release of the Red Hat OpenShift distributed tracing platform (Jaeger) that Red Hat supports.
8+
Support for the deprecated Red Hat OpenShift distributed tracing platform (Jaeger) ends on November 3, 2025.
109
The Red Hat OpenShift distributed tracing platform Operator (Jaeger) will be removed from the redhat-operators catalog on November 3, 2025. For more information, see the Red Hat Knowledgebase solution Jaeger Deprecation and Removal in OpenShift.
1110
You must migrate to the Red Hat build of OpenTelemetry Operator and the Tempo Operator for distributed tracing collection and storage. For more information, see "Migrating" in the Red Hat build of OpenTelemetry documentation, "Installing" in the Red Hat build of OpenTelemetry documentation, and "Installing" in the distributed tracing platform (Tempo) documentation.
1211
----

ocp-product-docs-plaintext/4.15/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44

55
[WARNING]
66
----
7-
The Red Hat OpenShift distributed tracing platform (Jaeger) 3.5 is the last release of the Red Hat OpenShift distributed tracing platform (Jaeger) that Red Hat plans to support.
8-
In the Red Hat OpenShift distributed tracing platform 3.5, Jaeger and support for Elasticsearch remain deprecated.
9-
Support for the Red Hat OpenShift distributed tracing platform (Jaeger) ends on November 3, 2025.
7+
The deprecated Red Hat OpenShift distributed tracing platform (Jaeger) 3.5 was the last release of the Red Hat OpenShift distributed tracing platform (Jaeger) that Red Hat supports.
8+
Support for the deprecated Red Hat OpenShift distributed tracing platform (Jaeger) ends on November 3, 2025.
109
The Red Hat OpenShift distributed tracing platform Operator (Jaeger) will be removed from the redhat-operators catalog on November 3, 2025. For more information, see the Red Hat Knowledgebase solution Jaeger Deprecation and Removal in OpenShift.
1110
You must migrate to the Red Hat build of OpenTelemetry Operator and the Tempo Operator for distributed tracing collection and storage. For more information, see "Migrating" in the Red Hat build of OpenTelemetry documentation, "Installing" in the Red Hat build of OpenTelemetry documentation, and "Installing" in the distributed tracing platform (Tempo) documentation.
1211
----

ocp-product-docs-plaintext/4.15/observability/monitoring/configuring-core-platform-monitoring/configuring-alerts-and-notifications.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,8 +242,8 @@ Alertmanager does not send notifications by default. It is strongly recommended
242242
----
243243

244244
* Sending notifications to external systems
245-
* PagerDuty (PagerDuty official site)
246-
* Prometheus Integration Guide (PagerDuty official site)
245+
* PagerDuty website
246+
* Prometheus Integration Guide (PagerDuty documentation)
247247
* Support version matrix for monitoring components
248248
* Enabling alert routing for user-defined projects
249249

0 commit comments

Comments
 (0)