Skip to content

Commit 4d4a0ca

Browse files
authored
Merge pull request #46692 from bmcelvee/OSDOCS-3735
OSDOCS-3735: Clarify ROSA and OSD process security documentation
2 parents 698649b + 4bda25e commit 4d4a0ca

File tree

2 files changed

+32
-71
lines changed

2 files changed

+32
-71
lines changed

modules/policy-change-management.adoc

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,51 +6,32 @@
66
[id="policy-change-management_{context}"]
77
= Change management
88

9+
This section describes the policies about how cluster and configuration changes, patches, and releases are managed.
910

10-
Cluster changes are initiated in one of two ways:
11+
[id="policy-customer-initiated-changes_{context}"]
12+
== Customer-initiated changes
1113

12-
* A customer initiates changes through self-service capabilities like cluster deployment, worker node scaling, and cluster deletion.
13-
* An SRE initiates a change through Operator-driven capabilities like configuration, upgrade, patching, or configuration changes.
14+
You can initiate changes using self-service capabilities such as cluster deployment, worker node scaling, or cluster deletion.
1415

15-
Change history is captured in the *Cluster History* section in {cluster-manager} *Overview* tab and is available to customers. This includes logs from the following changes:
16+
Change history is captured in the *Cluster History* section in the OpenShift Cluster Manager *Overview tab*, and is available for you to view. The change history includes, but is not limited to, logs from the following changes:
1617

1718
* Adding or removing identity providers
18-
* Adding or removing users to/from the dedicated-admins group
19+
* Adding or removing users to or from the `dedicated-admins` group
1920
* Scaling the cluster compute nodes
2021
* Scaling the cluster load balancer
2122
* Scaling the cluster persistent storage
2223
* Upgrading the cluster
2324

24-
SRE-initiated changes that require manual intervention generally follow the below procedure:
25+
[id="policy-red-hat-initiated-changes_{context}"]
26+
== Red Hat-initiated changes
2527

26-
* Preparing for change
27-
** Change characteristics are identified and a gap analysis against current state is performed.
28-
** Change steps are documented and validated.
29-
** Communication plan and schedule is shared with all stakeholders.
30-
** CICD and end-to-end tests are updated to automate change validation.
31-
** Change request capturing change details is submitted for management approval.
32-
* Managing change
33-
** Automated nightly CI/CD jobs pick up the change and run tests.
34-
** The change is made to integration and stage environments, and manually validated before updating the customer cluster.
35-
** Major change notifications are sent before and after the event.
36-
* Reinforcing the change
37-
** Feedback on the change is collected and analyzed.
38-
** Potential gaps are diagnosed in order to understand resistance and automate similar change requests.
39-
** Corrective actions are implemented.
28+
Red Hat site reliability engineering (SRE) manages the infrastructure, code, and configuration of {product-title} using a GitOps workflow and fully automated CI/CD pipelines. This process ensures that Red Hat can safely introduce service improvements on a continuous basis without negatively impacting customers.
4029

41-
[NOTE]
42-
====
43-
SREs consider manual changes a failure and this is only used as a fallback process.
44-
====
30+
Every proposed change undergoes a series of automated verifications immediately upon check-in. Changes are then deployed to a staging environment where they undergo automated integration testing. Finally, changes are deployed to the production environment. Each step is fully automated.
4531

46-
[id="config-management_{context}"]
47-
== Configuration management
32+
An authorized SRE reviewer must approve advancement to each step. The reviewer cannot be the same individual who proposed the change. All changes and approvals are fully auditable as part of the GitOps workflow.
4833

49-
The infrastructure and configuration of the {product-title} environment is managed as code. Red Hat SRE manages changes to the {product-title} environment using a GitOps workflow and automated CI/CD pipeline.
50-
51-
Each proposed change undergoes a series of automated verifications immediately upon check-in. Changes are then deployed to a staging environment where they undergo automated integration testing. Finally, changes are deployed to the production environment. Each step is fully automated.
52-
53-
An authorized SRE reviewer must approve advancement to each step. The reviewer might not be the same individual who proposed the change. All changes and approvals are fully auditable as part of the GitOps workflow.
34+
Some changes are released to production incrementally, using feature flags to control availability of new features to specified clusters or customers.
5435

5536
[id="patch-management_{context}"]
5637
== Patch management

modules/rosa-policy-change-management.adoc

Lines changed: 20 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7,53 +7,33 @@
77
= Change management
88

99

10-
This section describes the policies about how cluster changes, configuration changes, patches, and releases are managed.
11-
12-
Cluster changes are initiated in one of two ways:
13-
14-
1. A customer initiates changes through self-service capabilities such as cluster deployment, worker node scaling, or cluster deletion.
15-
2. Red Hat site reliability engineering (SRE) initiates a change through Operator-driven capabilities such as configuration, upgrade, patching, or configuration changes.
16-
17-
Change history is captured in the Cluster History section in {cluster-manager} Overview tab and is available to customers. The change history includes, but is not limited to, logs from the following changes:
18-
19-
- Adding or removing identity providers
20-
- Adding or removing users to or from the `dedicated-admins` group
21-
- Scaling the cluster compute nodes
22-
- Scaling the cluster load balancer
23-
- Scaling the cluster persistent storage
24-
- Upgrading the cluster
25-
26-
The SRE-initiated changes that require manual intervention by SRE generally follow this process:
27-
28-
- Preparing for change
29-
* Change characteristics are identified and a gap analysis is performed against current state.
30-
* Change steps are documented and validated.
31-
* A communication plan and schedule are shared with all stakeholders.
32-
* CI/CD and end-to-end tests are updated to automate change validation.
33-
* A change request that captures change details is submitted for management approval.
34-
- Managing change
35-
* Automated nightly CI/CD jobs pick up the change and run tests.
36-
* The change is made to integration and stage environments, and manually validated before updating the customer cluster.
37-
* Major change notifications are sent before and after the event.
38-
- Reinforcing the change
39-
* Feedback on the change is collected and analyzed.
40-
* Potential gaps are diagnosed to understand resistance and automate similar change requests.
41-
* Corrective actions are implemented.
10+
This section describes the policies about how cluster and configuration changes, patches, and releases are managed.
4211

43-
[NOTE]
44-
====
45-
SRE only uses manual changes as a fallback process because manual intervention is considered to be a failure of change management.
46-
====
12+
[id="rosa-policy-customer-initiated-changes_{context}"]
13+
== Customer-initiated changes
14+
15+
You can initiate changes using self-service capabilities such as cluster deployment, worker node scaling, or cluster deletion.
4716

48-
[id="rosa-policy-configuration-management_{context}"]
49-
== Configuration management
17+
Change history is captured in the *Cluster History* section in the OpenShift Cluster Manager *Overview tab*, and is available for you to view. The change history includes, but is not limited to, logs from the following changes:
5018

51-
The infrastructure and configuration of the {product-title} environment is managed as code. SRE manages changes to the {product-title} environment using a GitOps workflow and automated CI/CD pipeline.
19+
* Adding or removing identity providers
20+
* Adding or removing users to or from the `dedicated-admins` group
21+
* Scaling the cluster compute nodes
22+
* Scaling the cluster load balancer
23+
* Scaling the cluster persistent storage
24+
* Upgrading the cluster
5225

53-
Each proposed change undergoes a series of automated verifications immediately upon check-in. Changes are then deployed to a staging environment where they undergo automated integration testing. Finally, changes are deployed to the production environment. Each step is fully automated.
26+
[id="rosa-policy-red-hat-initiated-changes_{context}"]
27+
== Red Hat-initiated changes
28+
29+
Red Hat site reliability engineering (SRE) manages the infrastructure, code, and configuration of {product-title} using a GitOps workflow and fully automated CI/CD pipelines. This process ensures that Red Hat can safely introduce service improvements on a continuous basis without negatively impacting customers.
30+
31+
Every proposed change undergoes a series of automated verifications immediately upon check-in. Changes are then deployed to a staging environment where they undergo automated integration testing. Finally, changes are deployed to the production environment. Each step is fully automated.
5432

5533
An authorized SRE reviewer must approve advancement to each step. The reviewer cannot be the same individual who proposed the change. All changes and approvals are fully auditable as part of the GitOps workflow.
5634

35+
Some changes are released to production incrementally, using feature flags to control availability of new features to specified clusters or customers.
36+
5737
[id="rosa-policy-patch-management_{context}"]
5838
== Patch management
5939

0 commit comments

Comments
 (0)