Skip to content

Commit 83e8833

Browse files
committed
Update: 10-10-2024
1 parent 61fabc6 commit 83e8833

Some content is hidden

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

56 files changed

+177
-246
lines changed

access-iam-rbac.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2024, 2024
5-
lastupdated: "2024-10-07"
5+
lastupdated: "2024-10-10"
66

77

88
keywords: openshift, {{site.data.keyword.openshiftlong_notm}}, kubernetes, infrastructure, rbac, policy, role-based access control
@@ -120,7 +120,7 @@ To create custom RBAC permissions,
120120
| `rules.apiGroups` | Specify the Kubernetes [API groups](https://kubernetes.io/docs/reference/using-api/#api-groups){: external} that you want users to be able to interact with, such as `"apps"`, `"batch"`, or `"extensions"`. For access to the core API group at REST path `api/v1`, leave the group blank: `[""]`. |
121121
| `rules.resources` | Specify the Kubernetes [resource types](https://kubernetes.io/docs/reference/kubectl/quick-reference/){: external} to which you want to grant access, such as `"daemonsets"`, `"deployments"`, `"events"`, or `"ingresses"`. If you specify `"nodes"`, then the kind must be `ClusterRole`. |
122122
| `rules.verbs` | Specify the types of [actions](https://kubectl.docs.kubernetes.io/){: external} that you want users to be able to do, such as `"get"`, `"list"`, `"describe"`, `"create"`, or `"delete"`. |
123-
{: caption="Table 3. Understanding the YAML parameters" caption-side="bottom"}
123+
{: caption="Understanding the YAML parameters" caption-side="bottom"}
124124

125125
1. Create the role or cluster role in your cluster.
126126

@@ -180,7 +180,7 @@ To create custom RBAC permissions,
180180
| `roleRef.kind` | Enter the same value as the `kind` in the role `.yaml` file: `Role` or `ClusterRole`. |
181181
| `roleRef.name` | Enter the name of the role `.yaml` file. |
182182
| `roleRef.apiGroup` | Use `rbac.authorization.k8s.io`. |
183-
{: caption="Table 3. Understanding the YAML parameters" caption-side="bottom"}
183+
{: caption="Understanding the YAML parameters" caption-side="bottom"}
184184

185185
1. Create the role binding or cluster role binding resource in your cluster.
186186

@@ -265,7 +265,7 @@ Before you begin: [Access your {{site.data.keyword.redhat_openshift_notm}} clust
265265
| `rules.apiGroups` | Specify the Kubernetes [API groups](https://kubernetes.io/docs/reference/using-api/#api-groups){: external} that you want users to be able to interact with, such as `"apps"`, `"batch"`, or `"extensions"`. For access to the core API group at REST path `api/v1`, leave the group blank: `[""]`. |
266266
| `rules.resources` | Specify the Kubernetes [resource types](https://kubernetes.io/docs/reference/kubectl/quick-reference/){: external} to which you want to grant access, such as `"daemonsets"`, `"deployments"`, `"events"`, or `"ingresses"`. |
267267
| `rules.verbs` | Specify the types of [actions](https://kubectl.docs.kubernetes.io/){: external} that you want users to be able to do, such as `"get"`, `"list"`, `"describe"`, `"create"`, or `"delete"`. |
268-
{: caption="Table 4. Understanding the YAML parameters" caption-side="bottom"}
268+
{: caption="Understanding the YAML parameters" caption-side="bottom"}
269269

270270
2. Create the cluster role in your cluster. Any users that have a role binding to the `admin` cluster role now have the additional permissions from the `view-pod-metrics` cluster role.
271271
```sh
@@ -369,7 +369,7 @@ The following table shows the Kubernetes resource permissions that are granted b
369369
| Writer role | When scoped to one namespace: **`edit`** cluster role applied by the **`ibm-edit`** role binding in that namespace. \n \n When scoped to all namespaces: **`edit`** cluster role applied by the **`ibm-edit`** role binding in each namespace of the cluster | - Read/write access to resources in a namespace \n - No read/write access to roles and role bindings< \n - Access the Kubernetes dashboard to view resources in a namespace. |
370370
| Manager role | When scoped to one namespace: **`admin`** cluster role applied by the **`ibm-operate`** role binding in that namespace \n \n When scoped to all namespaces: **`cluster-admin`** cluster role applied by the **`ibm-admin`** cluster role binding that applies to all namespaces | When scoped to one namespace: \n - Read/write access to all resources in a namespace but not to resource quota or the namespace itself \n - Create RBAC roles and role bindings in a namespace \n - Access the Kubernetes dashboard to view all resources in a namespace \n When scoped to all namespaces: \n - Read/write access to all resources in every namespace \n - Create RBAC roles and role bindings in a namespace or cluster roles and cluster role bindings in all namespaces \n - Access the Kubernetes dashboard \n - Create an Ingress resource that makes apps publicly available \n - Review cluster metrics such as with the `oc top pods`, `oc top nodes`, or `oc get nodes` commands |
371371
| Any service access role | All users of a {{site.data.keyword.redhat_openshift_notm}} cluster are given the `basic-users`. | | - Get basic information about projects that the user has access to. \n - Create authorized resources in the projects that the user has access to. \n - For more information, see the [{{site.data.keyword.redhat_openshift_notm}} docs](https://docs.openshift.com/container-platform/4.16/authentication/using-rbac.html){: external} |
372-
{: caption="Table 1. Kubernetes resource permissions by service and corresponding RBAC roles" caption-side="bottom"}
372+
{: caption="Kubernetes resource permissions by service and corresponding RBAC roles" caption-side="bottom"}
373373

374374
### Kubernetes resource permissions per RBAC role
375375
{: #rbac_ref}
@@ -436,7 +436,7 @@ The following table shows the permissions that are granted by each RBAC role to
436436
| `services/proxy` | - | create, delete, `deletecollection`, get, list, patch, update, watch | create, delete, `deletecollection`, get, list, patch, update, watch |
437437
| `statefulsets.apps` | get, list, watch | create, delete, `deletecollection`, get, list, patch, update, watch | create, delete, `deletecollection`, get, list, patch, update, watch |
438438
| `statefulsets.apps/scale` | get, list, watch | create, delete, `deletecollection`, get, list, patch, update, watch | create, delete, `deletecollection`, get, list, patch, update, watch |
439-
{: caption="Table 1. Kubernetes resource permissions granted by each predefined RBAC role" caption-side="bottom"}
439+
{: caption="Kubernetes resource permissions granted by each predefined RBAC role" caption-side="bottom"}
440440

441441

442442

app-plan.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2014, 2024
5-
lastupdated: "2024-10-07"
5+
lastupdated: "2024-10-10"
66

77

88
keywords: kubernetes, deploy, app, openshift
@@ -326,7 +326,7 @@ The more widely you distribute your setup across multiple worker nodes and clust
326326
327327
Review the following potential app setups that are ordered with increasing degrees of availability.
328328
329-
![Stages of high availability for an app](images/cs_app_ha_roadmap-mz.png){: caption="Figure 1. Stages of high availability for an app" caption-side="bottom"}
329+
![Stages of high availability for an app](images/cs_app_ha_roadmap-mz.png){: caption="Stages of high availability for an app" caption-side="bottom"}
330330
331331
1. A deployment with n+2 pods that are managed by a replica set on a single node.
332332
2. A deployment with n+2 pods that are managed by a replica set and spread across multiple nodes (anti-affinity) in a single zone cluster.

app-update.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2014, 2024
5-
lastupdated: "2024-08-06"
5+
lastupdated: "2024-10-10"
66

77

88
keywords: kubernetes, openshift, red hat, red hat openshift, update, upgrade, openshift
@@ -78,7 +78,7 @@ To scale your apps:
7878
| `--cpu-percent` | The average CPU utilization that is maintained by the Horizontal Pod Autoscaler, which is specified as a percentage. |
7979
| `--min` | The minimum number of deployed pods that are used to maintain the specified CPU utilization percentage. |
8080
| `--max` | The maximum number of deployed pods that are used to maintain the specified CPU utilization percentage. |
81-
{: caption="Table 2. Understanding your command options" caption-side="bottom"}
81+
{: caption="Understanding your command options" caption-side="bottom"}
8282

8383
## Managing rolling deployments to update your apps
8484
{: #app_rolling}
@@ -284,7 +284,3 @@ Before you begin, you need two clusters and the **Manager** [service access role
284284
oc get all
285285
```
286286
{: pre}
287-
288-
289-
290-

benchmarks_415_co.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2024, 2024
5-
lastupdated: "2024-06-03"
5+
lastupdated: "2024-10-10"
66

77

88
keywords: openshift, benchmarks, 4.15, compliance operator, compliance
@@ -73,7 +73,7 @@ The master node configuration is not stored as a set of files; therefore, rules
7373
| 1.2.33|Ensure that the `--encryption-provider-config` argument is set as appropriate|Manual|1|[Not checked](#co-benchmark-415-remdiations) |
7474
| 1.2.34|Ensure that encryption providers are appropriately configured|Manual|1|[Not checked](#co-benchmark-415-remdiations) |
7575
| 1.2.35|Ensure that the API Server only makes use of Strong Cryptographic Ciphers|Manual|1|Pass |
76-
{: caption="Table 1. Benchmarks for api server." caption-side="top"}
76+
{: caption="Benchmarks for api server." caption-side="top"}
7777
{: caption="Section 1.2 API server benchmark results"}
7878

7979
### 1.3 Controller manager
@@ -229,6 +229,3 @@ Follow the instruction in [Using the compliance operator](/docs/openshift?topic=
229229
| 5.2.8 | {{site.data.keyword.openshiftlong_notm}} installs custom SCCs. |
230230
| 5.3.2 | {{site.data.keyword.openshiftlong_notm}} has a set of default Calico network policies defined and additional network policies can optionally be added. |
231231
{: caption="Remediations and explanations"}
232-
233-
234-

cluster-plan-network-classic.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2022, 2024
5-
lastupdated: "2024-08-12"
5+
lastupdated: "2024-10-10"
66

77

88
keywords: kubernetes, openshift network, classic
@@ -151,7 +151,7 @@ For example, if your worker nodes are connected to a private VLAN only, but you
151151
In this scenario, you want to run workloads in a classic cluster that are accessible to requests from the Internet so that end users can access your apps. You want the option of isolating public access in your cluster and of controlling what public requests are permitted to your cluster. Additionally, your workers have automatic access to any {{site.data.keyword.cloud_notm}} services that you want to connect with your cluster.
152152
{: shortdesc}
153153

154-
![Architecture image for a cluster that runs internet-facing workloads.](images/cs_clusters_planning_internet.png){: caption="Figure 1. Network setup for a cluster that runs internet-facing workloads" caption-side="bottom"}
154+
![Architecture image for a cluster that runs internet-facing workloads.](images/cs_clusters_planning_internet.png){: caption="Network setup for a cluster that runs internet-facing workloads" caption-side="bottom"}
155155

156156
### Worker-to-worker communication in classic clusters with internet-facing workloads
157157
{: #internet-facing-worker}
@@ -188,7 +188,7 @@ Ready to get started with a cluster for this scenario? After you plan your [high
188188
In this scenario, you want to run workloads in a classic cluster that are accessible to services, databases, or other resources in your on-premises data center. However, you might need to provide limited public access to your cluster, and want to ensure that any public access is controlled and isolated in your cluster. For example, you might need your workers to access an {{site.data.keyword.cloud_notm}} service that does not support private cloud service endpoints, and must be accessed over the public network. Or you might need to provide limited public access to an app that runs in your cluster. To achieve this cluster setup, you can configure a gateway appliance, such as a Virtual Router Appliance (Vyatta), as a public gateway and firewall.
189189
{: shortdesc}
190190

191-
![Architecture image for a cluster that uses a gateway appliance for secure public access.](images/cs_clusters_planning_gateway.png){: caption="Figure 1. Network setup for a cluster that uses a gateway appliance for secure public access" caption-side="bottom"}
191+
![Architecture image for a cluster that uses a gateway appliance for secure public access.](images/cs_clusters_planning_gateway.png){: caption="Network setup for a cluster that uses a gateway appliance for secure public access" caption-side="bottom"}
192192

193193
### Worker-to-worker communication, worker-to-master and user-to-master communication with a gateway appliance
194194
{: #limited-public-gw-worker}

cluster-plan-network-vpc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2022, 2024
5-
lastupdated: "2024-09-23"
5+
lastupdated: "2024-10-10"
66

77

88
keywords: kubernetes, openshift network
@@ -189,7 +189,7 @@ In this scenario, you run workloads in a VPC cluster that are accessible to requ
189189
{: shortdesc}
190190

191191

192-
![Network setup for a VPC cluster that runs internet-facing app workloads.](images/roks_ov_vpc_pub.png){: caption="Figure 1. Network setup for a VPC cluster that runs internet-facing app workloads" caption-side="bottom"}
192+
![Network setup for a VPC cluster that runs internet-facing app workloads.](images/roks_ov_vpc_pub.png){: caption="Network setup for a VPC cluster that runs internet-facing app workloads" caption-side="bottom"}
193193

194194
### Worker-to-worker communication
195195
{: #vpc-no-pgw-worker}

costs-reserved.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2014, 2024
5-
lastupdated: "2024-09-10"
5+
lastupdated: "2024-10-10"
66

77

88
keywords: openshift, reservations, worker node
@@ -40,7 +40,7 @@ A reservation is a type of {{site.data.keyword.cloud_notm}} resource that you se
4040

4141
Review the following diagram for an example scenario of how you might set up your reservation and contracts to use across clusters.
4242

43-
![Overview of reservations for {{site.data.keyword.openshiftlong_notm}}.](images/reservations-ov.png "Overview of reservations for {{site.data.keyword.openshiftlong_notm}}"){: caption="Figure 1. An example scenario of using a reservation for worker nodes in your clusters." caption-side="bottom"}
43+
![Overview of reservations for {{site.data.keyword.openshiftlong_notm}}.](images/reservations-ov.png "Overview of reservations for {{site.data.keyword.openshiftlong_notm}}"){: caption="An example scenario of using a reservation for worker nodes in your clusters." caption-side="bottom"}
4444

4545
**Reservation**: The reservation contains details such as the container platform, worker node flavor, location, and infrastructure provider.
4646

data-security.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2014, 2024
5-
lastupdated: "2024-02-28"
5+
lastupdated: "2024-10-10"
66

77

88
keywords: openshift dedicated hosts
@@ -28,7 +28,7 @@ For each cluster that you create with {{site.data.keyword.openshiftlong_notm}},
2828
|-------|----------|
2929
|Personal information|The email address of the {{site.data.keyword.cloud_notm}} account that created the cluster.|
3030
|Sensitive information| - The TLS certificate and secret that is used for the assigned Ingress subdomain. \n - The certificate authority that is used for the TLS certificate. \n - The certificate authority, private keys, and TLS certificates for the {{site.data.keyword.redhat_openshift_notm}} master components, including the {{site.data.keyword.redhat_openshift_notm}} API server, etcd data store, and VPN. \n - A customer root key in {{site.data.keyword.keymanagementservicelong_notm}} for each {{site.data.keyword.cloud_notm}} account that is used to encrypt personal and sensitive information.|
31-
{: caption="Table 1. Information that is stored with IBM" caption-side="bottom"}
31+
{: caption="Information that is stored with IBM" caption-side="bottom"}
3232

3333
## How is my information stored and encrypted?
3434
{: #pi-storage}
@@ -60,5 +60,3 @@ What options do I have to permanently remove my data?
6060

6161
- **Open an {{site.data.keyword.cloud_notm}} support case**: Contact IBM Support to remove your personal and sensitive information from {{site.data.keyword.openshiftlong_notm}}. For more information, see [Getting support](/docs/get-support?topic=get-support-using-avatar).
6262
- **End your {{site.data.keyword.cloud_notm}} subscription**: After you end your {{site.data.keyword.cloud_notm}} subscription, {{site.data.keyword.openshiftlong_notm}} removes the customer root key in {{site.data.keyword.keymanagementservicelong_notm}} that IBM created and managed for you as well as all the personal and sensitive information from the etcd data store and {{site.data.keyword.cos_short}} backup.
63-
64-

document-environment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2024, 2024
5-
lastupdated: "2024-08-06"
5+
lastupdated: "2024-10-10"
66

77

88
keywords: kubernetes, help, connectivity, debugging, openshift, apps, support, network
@@ -75,14 +75,14 @@ Each of these VPC ALBs is a part of a separate cluster in the respective region.
7575

7676
Note that some of these connections are over the public network. Some are over a private network in the same VPC, and some use the private network in {{site.data.keyword.cloud_notm}} between components in a VPC and a service in {{site.data.keyword.cloud_notm}}.
7777

78-
![Multi-cluster Diagram](images/multi-cluster-with-glb-architecture.jpg){: caption="Figure 1. Multi-cluster architecture" caption-side="bottom"}
78+
![Multi-cluster Diagram](images/multi-cluster-with-glb-architecture.jpg){: caption="Multi-cluster architecture" caption-side="bottom"}
7979

8080
### Example 3: A VSI client contacting a VPC network load balancer with an external service backend
8181
{: #example-arch-3}
8282

8383
In the following example, the client is a Classic VSI in {{site.data.keyword.cloud_notm}}. The VSI connects via the private network to a private VPC network load balancer (NLB) created for an VPC cluster. This NLB balances traffic to one of the three VPC worker nodes via the NodePort for the cluster Load Balancer service. The cluster Load Balancer service then sends the traffic to one of the app pods which connect to an external cloud service outside of {{site.data.keyword.cloud_notm}} over the public network.
8484

85-
![NLB with an external service](images/vsi-nlb-external-service-architecture.jpg){: caption="Figure 2. NLB with external service" caption-side="bottom"}
85+
![NLB with an external service](images/vsi-nlb-external-service-architecture.jpg){: caption="NLB with external service" caption-side="bottom"}
8686

8787

8888
## Step 2: Choose a tool

encryption.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2014, 2024
5-
lastupdated: "2024-08-21"
5+
lastupdated: "2024-10-10"
66

77

88
keywords: openshift, {{site.data.keyword.openshiftlong_notm}}, kubernetes, red hat, encrypt, security, kms, root key, crk
@@ -36,7 +36,7 @@ The following table outlines the encryption options for {{site.data.keyword.open
3636
| [Worker node disks](#worker-node-encryption) | Yes | Yes | During cluster creation or worker pool creation. | - {{site.data.keyword.hscrypto}} \n - {{site.data.keyword.keymanagementserviceshort}} | Yes |
3737
| [Cluster secrets](#cluster-secret-encryption) | No | Yes | After cluster creation by using `kms enable`. | - {{site.data.keyword.hscrypto}} \n - {{site.data.keyword.keymanagementserviceshort}} | Cross account supported for Classic and VPC clusters only. |
3838
| [Persistent storage](#persistent-encryption) | Depends on the storage provider. | Depends on provider | After cluster creation, when setting up storage. | - {{site.data.keyword.hscrypto}} \n - {{site.data.keyword.keymanagementserviceshort}} | Depends on the storage provider. |
39-
{: caption="Table 1. Default and optional data encryption" caption-side="bottom"}
39+
{: caption="Default and optional data encryption" caption-side="bottom"}
4040

4141

4242

0 commit comments

Comments
 (0)