Skip to content

Commit 499129e

Browse files
authored
Merge pull request #44581 from openshift-cherrypick-robot/cherry-pick-43807-to-enterprise-4.10
[enterprise-4.10] OSDOCS-3390: ROSA documentation restructure updates
2 parents b7519cd + 849c009 commit 499129e

File tree

63 files changed

+331
-360
lines changed

Some content is hidden

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

63 files changed

+331
-360
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 100 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -35,40 +35,48 @@ Distros: openshift-rosa
3535
Topics:
3636
- Name: Understanding ROSA
3737
File: rosa-understanding
38-
- Name: Architecture models
39-
File: rosa-architecture-models
40-
- Name: Architecture concepts
41-
File: rosa-basic-architecture-concepts
42-
- Name: ROSA service definition
43-
File: rosa-service-definition
44-
- Name: Responsibility assignment matrix
45-
File: rosa-policy-responsibility-matrix
46-
- Name: Understanding the ROSA with STS deployment workflow
47-
File: rosa-sts-getting-started-workflow
48-
- Name: Understanding process and security for ROSA
49-
File: rosa-policy-process-security
50-
- Name: About availability for ROSA
51-
File: rosa-policy-understand-availability
52-
- Name: ROSA update life cycle
53-
File: rosa-life-cycle
38+
- Name: ROSA architecture
39+
Dir: rosa_architecture_sub
40+
Distros: openshift-rosa
41+
Topics:
42+
- Name: Architecture concepts
43+
File: rosa-basic-architecture-concepts
44+
- Name: Architecture models
45+
File: rosa-architecture-models
46+
- Name: Policies and service definition
47+
Dir: rosa_policy_service_definition
48+
Distros: openshift-rosa
49+
Topics:
50+
- Name: About availability for ROSA
51+
File: rosa-policy-understand-availability
52+
- Name: Responsibility assignment matrix
53+
File: rosa-policy-responsibility-matrix
54+
- Name: ROSA service definition
55+
File: rosa-service-definition
56+
- Name: ROSA update life cycle
57+
File: rosa-life-cycle
58+
- Name: Understanding process and security for ROSA
59+
File: rosa-policy-process-security
60+
- Name: About IAM resources for ROSA with STS
61+
File: rosa-sts-about-iam-resources
5462
- Name: Support for ROSA
5563
File: rosa-getting-support
5664
# - Name: Training for ROSA
5765
# File: rosa-training
5866
---
59-
Name: ROSA CLI tools
67+
Name: ROSA CLI
6068
Dir: rosa_cli
6169
Distros: openshift-rosa
6270
Topics:
6371
# - Name: CLI and web console
6472
# File: rosa-cli-penshift-console
65-
- Name: Getting started with the rosa CLI
73+
- Name: Getting started with the ROSA CLI
6674
File: rosa-get-started-cli
67-
- Name: Managing objects with the rosa CLI
75+
- Name: Managing objects with the ROSA CLI
6876
File: rosa-manage-objects-cli
69-
- Name: Checking account and version information with the rosa CLI
77+
- Name: Checking account and version information with the ROSA CLI
7078
File: rosa-checking-acct-version-cli
71-
- Name: Checking logs with the rosa CLI
79+
- Name: Checking logs with the ROSA CLI
7280
File: rosa-checking-logs-cli
7381
---
7482
Name: Red Hat OpenShift Cluster Manager
@@ -88,31 +96,36 @@ Distros: openshift-rosa
8896
Topics:
8997
- Name: AWS prerequisites for ROSA with STS
9098
File: rosa-sts-aws-prereqs
91-
- Name: AWS prerequisites for ROSA
92-
File: rosa-aws-prereqs
9399
- Name: Limits and scalability
94100
File: rosa-limits-scalability
95101
- Name: Planning your environment
96102
File: rosa-planning-environment
103+
- Name: Required AWS service quotas
104+
File: rosa-sts-required-aws-service-quotas
105+
- Name: Setting up your environment
106+
File: rosa-sts-setting-up-environment
97107
---
98108
Name: Getting started
99109
Dir: rosa_getting_started
100110
Distros: openshift-rosa
101111
Topics:
112+
- Name: Understanding the ROSA with STS deployment workflow
113+
File: rosa-sts-getting-started-workflow
102114
- Name: Getting started with ROSA
103115
File: rosa-getting-started
104-
- Name: Required AWS service quotas
105-
File: rosa-sts-required-aws-service-quotas
106-
- Name: Setting up the environment for using STS
107-
File: rosa-sts-setting-up-environment
116+
---
117+
Name: Installing, accessing, and deleting ROSA clusters
118+
Dir: rosa_install_access_delete_clusters
119+
Distros: openshift-rosa
120+
Topics:
108121
- Name: Creating a ROSA cluster with STS quickly
109122
File: rosa-sts-creating-a-cluster-quickly
110123
- Name: Creating a ROSA cluster with STS using customizations
111124
File: rosa-sts-creating-a-cluster-with-customizations
112-
- Name: About IAM resources for ROSA with STS
113-
File: rosa-sts-about-iam-resources
114125
- Name: Interactive cluster creation mode reference
115126
File: rosa-sts-interactive-mode-reference
127+
- Name: Creating an AWS PrivateLink cluster on ROSA
128+
File: rosa-aws-privatelink-creating-cluster
116129
- Name: Accessing a ROSA cluster
117130
File: rosa-sts-accessing-cluster
118131
- Name: Configuring identity providers using Red Hat OpenShift Cluster Manager
@@ -125,24 +138,24 @@ Topics:
125138
Dir: rosa_getting_started_iam
126139
Distros: openshift-rosa
127140
Topics:
141+
- Name: AWS prerequisites for ROSA
142+
File: rosa-aws-prereqs
128143
- Name: Understanding the ROSA deployment workflow
129144
File: rosa-getting-started-workflow
130145
- Name: Required AWS service quotas
131146
File: rosa-required-aws-service-quotas
132147
- Name: Configuring your AWS account
133148
File: rosa-config-aws-account
134-
- Name: Installing ROSA
149+
- Name: Installing the ROSA CLI
135150
File: rosa-installing-rosa
136-
- Name: Creating a ROSA cluster
151+
- Name: Creating a ROSA cluster without AWS STS
137152
File: rosa-creating-cluster
138153
# - Name: Creating a ROSA cluster using the web console
139154
# File: rosa-creating-cluster-console
140-
- Name: Creating an AWS PrivateLink cluster on ROSA
141-
File: rosa-aws-privatelink-creating-cluster
142-
- Name: Accessing a ROSA cluster
143-
File: rosa-accessing-cluster
144-
- Name: Configuring identity providers using the Red Hat OpenShift Cluster Manager
145-
File: rosa-config-identity-providers
155+
# - Name: Accessing a ROSA cluster
156+
# File: rosa-accessing-cluster
157+
# - Name: Configuring identity providers using the Red Hat OpenShift Cluster Manager
158+
# File: rosa-config-identity-providers
146159
- Name: Deleting access to a ROSA cluster
147160
File: rosa-deleting-access-cluster
148161
- Name: Deleting a ROSA cluster
@@ -160,6 +173,31 @@ Topics:
160173
# File: rosa-cluster-auth
161174
# - Name: Authorization and RBAC
162175
# File: rosa-auth-rbac
176+
- Name: Configuring private connections
177+
Dir: cloud_infrastructure_access
178+
Distros: openshift-rosa
179+
Topics:
180+
- Name: Configuring private connections
181+
File: rosa-configuring-private-connections
182+
- Name: Configuring AWS VPC peering
183+
File: dedicated-aws-peering
184+
- Name: Configuring AWS VPN
185+
File: dedicated-aws-vpn
186+
- Name: Configuring AWS Direct Connect
187+
File: dedicated-aws-dc
188+
- Name: Configuring a private cluster
189+
File: rosa-private-cluster
190+
- Name: Nodes
191+
Dir: rosa_nodes
192+
Distros: openshift-rosa
193+
Topics:
194+
- Name: About machine pools
195+
File: rosa-nodes-machinepools-about
196+
- Name: Managing compute nodes
197+
File: rosa-managing-worker-nodes
198+
Distros: openshift-rosa
199+
- Name: About autoscaling nodes on a cluster
200+
File: rosa-nodes-about-autoscaling-nodes
163201
- Name: Logging
164202
Dir: rosa_logging
165203
Distros: openshift-rosa
@@ -186,31 +224,6 @@ Topics:
186224
File: rosa-reviewing-monitoring-dashboards
187225
- Name: Troubleshooting monitoring issues
188226
File: rosa-troubleshooting-monitoring-issues
189-
- Name: Configuring private connections
190-
Dir: cloud_infrastructure_access
191-
Distros: openshift-rosa
192-
Topics:
193-
- Name: Configuring private connections
194-
File: rosa-configuring-private-connections
195-
- Name: Configuring AWS VPC peering
196-
File: dedicated-aws-peering
197-
- Name: Configuring AWS VPN
198-
File: dedicated-aws-vpn
199-
- Name: Configuring AWS Direct Connect
200-
File: dedicated-aws-dc
201-
- Name: Configuring a private cluster
202-
File: rosa-private-cluster
203-
- Name: Nodes
204-
Dir: rosa_nodes
205-
Distros: openshift-rosa
206-
Topics:
207-
- Name: About machine pools
208-
File: rosa-nodes-machinepools-about
209-
- Name: Managing compute nodes
210-
File: rosa-managing-worker-nodes
211-
Distros: openshift-rosa
212-
- Name: About autoscaling nodes on a cluster
213-
File: rosa-nodes-about-autoscaling-nodes
214227
---
215228
Name: Cluster security
216229
Dir: authentication
@@ -230,10 +243,10 @@ Topics:
230243
#- Name: Preparing to upgrade ROSA to 4.9
231244
# File: rosa-upgrading-cluster-prepare
232245
# Distros: openshift-rosa
233-
- Name: Upgrading ROSA
234-
File: rosa-upgrading
235246
- Name: Upgrading ROSA with STS
236247
File: rosa-upgrading-sts
248+
- Name: Upgrading ROSA
249+
File: rosa-upgrading
237250
---
238251
Name: Add-on services
239252
Dir: adding_service_cluster
@@ -244,29 +257,6 @@ Topics:
244257
- Name: Available services
245258
File: rosa-available-services
246259
---
247-
Name: Application development
248-
Dir: applications
249-
Distros: openshift-rosa
250-
Topics:
251-
- Name: Deployments
252-
Dir: deployments
253-
Distros: openshift-rosa
254-
Topics:
255-
- Name: Configuring custom domains for applications
256-
File: osd-config-custom-domains-applications
257-
# - Name: Application GitOps workflows
258-
# File: rosa-app-gitops-workflows
259-
# - Name: Application logging
260-
# File: rosa-app-logging
261-
# - Name: Applications
262-
# File: rosa-apps
263-
# - Name: Application metrics and alerts
264-
# File: rosa-app-metrics and alerts
265-
# - Name: Projects
266-
# File: rosa-projects
267-
# - Name: Using the internal registry
268-
# File: rosa-using-internal-registry
269-
---
270260
Name: Storage and registry
271261
Dir: storage
272262
Distros: openshift-rosa
@@ -296,6 +286,29 @@ Topics:
296286
- Name: CIDR range definitions
297287
File: cidr-range-definitions
298288
---
289+
Name: Application development
290+
Dir: applications
291+
Distros: openshift-rosa
292+
Topics:
293+
- Name: Deployments
294+
Dir: deployments
295+
Distros: openshift-rosa
296+
Topics:
297+
- Name: Configuring custom domains for applications
298+
File: osd-config-custom-domains-applications
299+
# - Name: Application GitOps workflows
300+
# File: rosa-app-gitops-workflows
301+
# - Name: Application logging
302+
# File: rosa-app-logging
303+
# - Name: Applications
304+
# File: rosa-apps
305+
# - Name: Application metrics and alerts
306+
# File: rosa-app-metrics and alerts
307+
# - Name: Projects
308+
# File: rosa-projects
309+
# - Name: Using the internal registry
310+
# File: rosa-using-internal-registry
311+
---
299312
Name: Troubleshooting
300313
Dir: rosa_support
301314
Distros: openshift-rosa

networking/configuring-cluster-wide-proxy.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ include::modules/cluster-wide-proxy-preqs.adoc[leveloffset=+1]
2626

2727
.Additional Resources
2828
ifdef::openshift-rosa[]
29-
For information about standard installation prerequisites, see xref:../rosa_planning/rosa-aws-prereqs.adoc#prerequisites[AWS prerequisites for ROSA]. For information about the prerequisites for installation using AWS Security Token Service (STS), see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prerequisites[AWS prerequisites for ROSA with STS].
29+
For information about standard installation prerequisites, see xref:../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-aws-prereqs.adoc#prerequisites[AWS prerequisites for ROSA]. For information about the prerequisites for installation using AWS Security Token Service (STS), see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prerequisites[AWS prerequisites for ROSA with STS].
3030
endif::[]
3131
ifdef::openshift-dedicated[]
3232
For more information, see xref:../osd_quickstart/osd-quickstart.adoc#osd-getting-started[Getting started with {product-title}] for a basic cluster installation workflow.

rosa_getting_started/rosa-sts-about-iam-resources.adoc renamed to rosa_architecture/rosa-sts-about-iam-resources.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ This document provides reference information about the IAM resources that you mu
1717
[role="_additional-resources"]
1818
.Additional resources
1919

20-
* For steps to quickly create a ROSA cluster with STS, including the AWS IAM resources, see xref:../rosa_getting_started/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-a-cluster-quickly[Creating a ROSA cluster with STS quickly].
21-
* For steps to create a ROSA cluster with STS using customizations, including the AWS IAM resources, see xref:../rosa_getting_started/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-sts-creating-a-cluster-with-customizations[Creating a ROSA cluster with STS using customizations].
20+
* For steps to quickly create a ROSA cluster with STS, including the AWS IAM resources, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-a-cluster-quickly[Creating a ROSA cluster with STS quickly].
21+
* For steps to create a ROSA cluster with STS using customizations, including the AWS IAM resources, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-sts-creating-a-cluster-with-customizations[Creating a ROSA cluster with STS using customizations].
2222
2323
include::modules/rosa-sts-account-wide-roles-and-policies.adoc[leveloffset=+1]
2424

2525
[role="_additional-resources"]
2626
.Additional resources
2727

28-
* For a definition of OpenShift major, minor, and patch versions, see xref:../rosa_architecture/rosa-life-cycle.adoc#rosa-life-cycle-definitions_rosa-life-cycle[the {product-title} update life cycle].
28+
* For a definition of OpenShift major, minor, and patch versions, see xref:../rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc#rosa-life-cycle-definitions_rosa-life-cycle[the {product-title} update life cycle].
2929
3030
include::modules/rosa-sts-account-wide-role-and-policy-commands.adoc[leveloffset=+2]
3131
include::modules/rosa-sts-operator-roles.adoc[leveloffset=+1]

rosa_architecture/rosa-sts-getting-started-workflow.adoc

Lines changed: 0 additions & 32 deletions
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes/
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)