OSDOCS-3390: ROSA documentation restructure updates

adellape · Apr 13, 2022 · 84daf50 · 84daf50
1 parent 8345034
commit 84daf50
Show file tree

Hide file tree

Showing 63 changed files with 331 additions and 360 deletions.
diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -35,40 +35,48 @@ Distros: openshift-rosa
 Topics:
 - Name: Understanding ROSA
   File: rosa-understanding
-- Name: Architecture models
-  File: rosa-architecture-models
-- Name: Architecture concepts
-  File: rosa-basic-architecture-concepts
-- Name: ROSA service definition
-  File: rosa-service-definition
-- Name: Responsibility assignment matrix
-  File: rosa-policy-responsibility-matrix
-- Name: Understanding the ROSA with STS deployment workflow
-  File: rosa-sts-getting-started-workflow
-- Name: Understanding process and security for ROSA
-  File: rosa-policy-process-security
-- Name: About availability for ROSA
-  File: rosa-policy-understand-availability
-- Name: ROSA update life cycle
-  File: rosa-life-cycle
+- Name: ROSA architecture
+  Dir: rosa_architecture_sub
+  Distros: openshift-rosa
+  Topics:
+  - Name: Architecture concepts
+    File: rosa-basic-architecture-concepts
+  - Name: Architecture models
+    File: rosa-architecture-models
+- Name: Policies and service definition
+  Dir: rosa_policy_service_definition
+  Distros: openshift-rosa
+  Topics:
+  - Name: About availability for ROSA
+    File: rosa-policy-understand-availability
+  - Name: Responsibility assignment matrix
+    File: rosa-policy-responsibility-matrix
+  - Name: ROSA service definition
+    File: rosa-service-definition
+  - Name: ROSA update life cycle
+    File: rosa-life-cycle
+  - Name: Understanding process and security for ROSA
+    File: rosa-policy-process-security
+- Name: About IAM resources for ROSA with STS
+  File: rosa-sts-about-iam-resources
 - Name: Support for ROSA
   File: rosa-getting-support
 # - Name: Training for ROSA
 #   File: rosa-training
 ---
-Name: ROSA CLI tools
+Name: ROSA CLI
 Dir: rosa_cli
 Distros: openshift-rosa
 Topics:
 # - Name: CLI and web console
 #   File: rosa-cli-penshift-console
-- Name: Getting started with the rosa CLI
+- Name: Getting started with the ROSA CLI
   File: rosa-get-started-cli
-- Name: Managing objects with the rosa CLI
+- Name: Managing objects with the ROSA CLI
   File: rosa-manage-objects-cli
-- Name: Checking account and version information with the rosa CLI
+- Name: Checking account and version information with the ROSA CLI
   File: rosa-checking-acct-version-cli
-- Name: Checking logs with the rosa CLI
+- Name: Checking logs with the ROSA CLI
   File: rosa-checking-logs-cli
 ---
 Name: Red Hat OpenShift Cluster Manager
@@ -88,31 +96,36 @@ Distros: openshift-rosa
 Topics:
 - Name: AWS prerequisites for ROSA with STS
   File: rosa-sts-aws-prereqs
-- Name: AWS prerequisites for ROSA
-  File: rosa-aws-prereqs
 - Name: Limits and scalability
   File: rosa-limits-scalability
 - Name: Planning your environment
   File: rosa-planning-environment
+- Name: Required AWS service quotas
+  File: rosa-sts-required-aws-service-quotas
+- Name: Setting up your environment
+  File: rosa-sts-setting-up-environment
 ---
 Name: Getting started
 Dir: rosa_getting_started
 Distros: openshift-rosa
 Topics:
+- Name: Understanding the ROSA with STS deployment workflow
+  File: rosa-sts-getting-started-workflow
 - Name: Getting started with ROSA
   File: rosa-getting-started
-- Name: Required AWS service quotas
-  File: rosa-sts-required-aws-service-quotas
-- Name: Setting up the environment for using STS
-  File: rosa-sts-setting-up-environment
+---
+Name: Installing, accessing, and deleting ROSA clusters
+Dir: rosa_install_access_delete_clusters
+Distros: openshift-rosa
+Topics:
 - Name: Creating a ROSA cluster with STS quickly
   File: rosa-sts-creating-a-cluster-quickly
 - Name: Creating a ROSA cluster with STS using customizations
   File: rosa-sts-creating-a-cluster-with-customizations
-- Name: About IAM resources for ROSA with STS
-  File: rosa-sts-about-iam-resources
 - Name: Interactive cluster creation mode reference
   File: rosa-sts-interactive-mode-reference
+- Name: Creating an AWS PrivateLink cluster on ROSA
+  File: rosa-aws-privatelink-creating-cluster
 - Name: Accessing a ROSA cluster
   File: rosa-sts-accessing-cluster
 - Name: Configuring identity providers using Red Hat OpenShift Cluster Manager
@@ -125,24 +138,24 @@ Topics:
   Dir: rosa_getting_started_iam
   Distros: openshift-rosa
   Topics:
+  - Name: AWS prerequisites for ROSA
+    File: rosa-aws-prereqs
   - Name: Understanding the ROSA deployment workflow
     File: rosa-getting-started-workflow
   - Name: Required AWS service quotas
     File: rosa-required-aws-service-quotas
   - Name: Configuring your AWS account
     File: rosa-config-aws-account
-  - Name: Installing ROSA
+  - Name: Installing the ROSA CLI
     File: rosa-installing-rosa
-  - Name: Creating a ROSA cluster
+  - Name: Creating a ROSA cluster without AWS STS
     File: rosa-creating-cluster
 # - Name: Creating a ROSA cluster using the web console
 #   File: rosa-creating-cluster-console
-  - Name: Creating an AWS PrivateLink cluster on ROSA
-    File: rosa-aws-privatelink-creating-cluster
-  - Name: Accessing a ROSA cluster
-    File: rosa-accessing-cluster
-  - Name: Configuring identity providers using the Red Hat OpenShift Cluster Manager
-    File: rosa-config-identity-providers
+#  - Name: Accessing a ROSA cluster
+#    File: rosa-accessing-cluster
+#  - Name: Configuring identity providers using the Red Hat OpenShift Cluster Manager
+#    File: rosa-config-identity-providers
   - Name: Deleting access to a ROSA cluster
     File: rosa-deleting-access-cluster
   - Name: Deleting a ROSA cluster
@@ -160,6 +173,31 @@ Topics:
 #   File: rosa-cluster-auth
 # - Name: Authorization and RBAC
 #   File: rosa-auth-rbac
+- Name: Configuring private connections
+  Dir: cloud_infrastructure_access
+  Distros: openshift-rosa
+  Topics:
+  - Name: Configuring private connections
+    File: rosa-configuring-private-connections
+  - Name: Configuring AWS VPC peering
+    File: dedicated-aws-peering
+  - Name: Configuring AWS VPN
+    File: dedicated-aws-vpn
+  - Name: Configuring AWS Direct Connect
+    File: dedicated-aws-dc
+  - Name: Configuring a private cluster
+    File: rosa-private-cluster
+- Name: Nodes
+  Dir: rosa_nodes
+  Distros: openshift-rosa
+  Topics:
+  - Name: About machine pools
+    File: rosa-nodes-machinepools-about
+  - Name: Managing compute nodes
+    File: rosa-managing-worker-nodes
+    Distros: openshift-rosa
+  - Name: About autoscaling nodes on a cluster
+    File: rosa-nodes-about-autoscaling-nodes
 - Name: Logging
   Dir: rosa_logging
   Distros: openshift-rosa
@@ -186,31 +224,6 @@ Topics:
     File: rosa-reviewing-monitoring-dashboards
   - Name: Troubleshooting monitoring issues
     File: rosa-troubleshooting-monitoring-issues
-- Name: Configuring private connections
-  Dir: cloud_infrastructure_access
-  Distros: openshift-rosa
-  Topics:
-  - Name: Configuring private connections
-    File: rosa-configuring-private-connections
-  - Name: Configuring AWS VPC peering
-    File: dedicated-aws-peering
-  - Name: Configuring AWS VPN
-    File: dedicated-aws-vpn
-  - Name: Configuring AWS Direct Connect
-    File: dedicated-aws-dc
-  - Name: Configuring a private cluster
-    File: rosa-private-cluster
-- Name: Nodes
-  Dir: rosa_nodes
-  Distros: openshift-rosa
-  Topics:
-  - Name: About machine pools
-    File: rosa-nodes-machinepools-about
-  - Name: Managing compute nodes
-    File: rosa-managing-worker-nodes
-    Distros: openshift-rosa
-  - Name: About autoscaling nodes on a cluster
-    File: rosa-nodes-about-autoscaling-nodes
 ---
 Name: Cluster security
 Dir: authentication
@@ -230,10 +243,10 @@ Topics:
 #- Name: Preparing to upgrade ROSA to 4.9
 #  File: rosa-upgrading-cluster-prepare
 #  Distros: openshift-rosa
-- Name: Upgrading ROSA
-  File: rosa-upgrading
 - Name: Upgrading ROSA with STS
   File: rosa-upgrading-sts
+- Name: Upgrading ROSA
+  File: rosa-upgrading
 ---
   Name: Add-on services
   Dir: adding_service_cluster
@@ -244,29 +257,6 @@ Topics:
   - Name: Available services
     File: rosa-available-services
 ---
-Name: Application development
-Dir: applications
-Distros: openshift-rosa
-Topics:
-- Name: Deployments
-  Dir: deployments
-  Distros: openshift-rosa
-  Topics:
-    - Name: Configuring custom domains for applications
-      File: osd-config-custom-domains-applications
-# - Name: Application GitOps workflows
-#   File: rosa-app-gitops-workflows
-# - Name: Application logging
-#   File: rosa-app-logging
-# - Name: Applications
-#   File: rosa-apps
-# - Name: Application metrics and alerts
-#   File: rosa-app-metrics and alerts
-# - Name: Projects
-#   File: rosa-projects
-# - Name: Using the internal registry
-#   File: rosa-using-internal-registry
----
 Name: Storage and registry
 Dir: storage
 Distros: openshift-rosa
@@ -296,6 +286,29 @@ Topics:
 - Name: CIDR range definitions
   File: cidr-range-definitions
 ---
+Name: Application development
+Dir: applications
+Distros: openshift-rosa
+Topics:
+- Name: Deployments
+  Dir: deployments
+  Distros: openshift-rosa
+  Topics:
+    - Name: Configuring custom domains for applications
+      File: osd-config-custom-domains-applications
+# - Name: Application GitOps workflows
+#   File: rosa-app-gitops-workflows
+# - Name: Application logging
+#   File: rosa-app-logging
+# - Name: Applications
+#   File: rosa-apps
+# - Name: Application metrics and alerts
+#   File: rosa-app-metrics and alerts
+# - Name: Projects
+#   File: rosa-projects
+# - Name: Using the internal registry
+#   File: rosa-using-internal-registry
+---
 Name: Troubleshooting
 Dir: rosa_support
 Distros: openshift-rosa

diff --git a/networking/configuring-cluster-wide-proxy.adoc b/networking/configuring-cluster-wide-proxy.adoc
@@ -26,7 +26,7 @@ include::modules/cluster-wide-proxy-preqs.adoc[leveloffset=+1]
 
 .Additional Resources
 ifdef::openshift-rosa[]
-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].
+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].
 endif::[]
 ifdef::openshift-dedicated[]
 For more information, see xref:../osd_quickstart/osd-quickstart.adoc#osd-getting-started[Getting started with {product-title}] for a basic cluster installation workflow.

diff --git a/...started/rosa-sts-about-iam-resources.adoc → ...tecture/rosa-sts-about-iam-resources.adoc b/...started/rosa-sts-about-iam-resources.adoc → ...tecture/rosa-sts-about-iam-resources.adoc
@@ -17,15 +17,15 @@ This document provides reference information about the IAM resources that you mu
 [role="_additional-resources"]
 .Additional resources
 
-* 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].
-* 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].
+* 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].
+* 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].
 
 include::modules/rosa-sts-account-wide-roles-and-policies.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
 
-* 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].
+* 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].
 
 include::modules/rosa-sts-account-wide-role-and-policy-commands.adoc[leveloffset=+2]
 include::modules/rosa-sts-operator-roles.adoc[leveloffset=+1]

diff --git a/rosa_architecture/rosa-sts-getting-started-workflow.adoc b/rosa_architecture/rosa-sts-getting-started-workflow.adoc
diff --git a/rosa_architecture/rosa_architecture_sub/_attributes b/rosa_architecture/rosa_architecture_sub/_attributes
@@ -0,0 +1 @@
+../_attributes/
diff --git a/...g_started/rosa_getting_started_iam/images → ...architecture/rosa_architecture_sub/images b/...g_started/rosa_getting_started_iam/images → ...architecture/rosa_architecture_sub/images
diff --git a/..._started/rosa_getting_started_iam/modules → ...rchitecture/rosa_architecture_sub/modules b/..._started/rosa_getting_started_iam/modules → ...rchitecture/rosa_architecture_sub/modules
diff --git a/...rchitecture/rosa-architecture-models.adoc → ...tecture_sub/rosa-architecture-models.adoc b/...rchitecture/rosa-architecture-models.adoc → ...tecture_sub/rosa-architecture-models.adoc
diff --git a/...ure/rosa-basic-architecture-concepts.adoc → ...sub/rosa-basic-architecture-concepts.adoc b/...ure/rosa-basic-architecture-concepts.adoc → ...sub/rosa-basic-architecture-concepts.adoc
diff --git a/...started/rosa_getting_started_iam/snippets → ...chitecture/rosa_architecture_sub/snippets b/...started/rosa_getting_started_iam/snippets → ...chitecture/rosa_architecture_sub/snippets
diff --git a/rosa_architecture/rosa_policy_service_definition/_attributes b/rosa_architecture/rosa_policy_service_definition/_attributes
@@ -0,0 +1 @@
+../_attributes/
diff --git a/rosa_architecture/rosa_policy_service_definition/images b/rosa_architecture/rosa_policy_service_definition/images
@@ -0,0 +1 @@
+../images
diff --git a/rosa_architecture/rosa_policy_service_definition/modules b/rosa_architecture/rosa_policy_service_definition/modules
@@ -0,0 +1 @@
+../modules
diff --git a/rosa_architecture/rosa-life-cycle.adoc → ...y_service_definition/rosa-life-cycle.adoc b/rosa_architecture/rosa-life-cycle.adoc → ...y_service_definition/rosa-life-cycle.adoc
@@ -10,7 +10,7 @@ include::modules/life-cycle-overview.adoc[leveloffset=+1]
 
 .Additional resources
 
-* xref:../rosa_architecture/rosa-service-definition.adoc#rosa-service-definition[{product-title} service definition]
+* xref:../rosa_policy_service_definition/rosa-service-definition.adoc#rosa-service-definition[{product-title} service definition]
 
 include::modules/life-cycle-definitions.adoc[leveloffset=+1]
 include::modules/life-cycle-major-versions.adoc[leveloffset=+1]
@@ -19,7 +19,7 @@ include::modules/life-cycle-minor-versions.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../rosa_architecture/rosa-life-cycle.adoc#rosa-limited-support_rosa-life-cycle[{product-title} limited support status]
+* xref:../rosa_policy_service_definition/rosa-life-cycle.adoc#rosa-limited-support_rosa-life-cycle[{product-title} limited support status]
 
 include::modules/life-cycle-patch-versions.adoc[leveloffset=+1]
 include::modules/life-cycle-limited-support.adoc[leveloffset=+1]

diff --git a/...tecture/rosa-policy-process-security.adoc → ...inition/rosa-policy-process-security.adoc b/...tecture/rosa-policy-process-security.adoc → ...inition/rosa-policy-process-security.adoc
@@ -28,6 +28,6 @@ include::modules/rosa-policy-disaster-recovery.adoc[leveloffset=+1]
 
 == Additional resources
 
-* For more information about customer or shared responsibilities, see the xref:../rosa_architecture/rosa-policy-responsibility-matrix.adoc#rosa-policy-responsibilities_rosa-policy-responsibility-matrix[ROSA Responsibilities] document.
+* For more information about customer or shared responsibilities, see the xref:../rosa_policy_service_definition/rosa-policy-responsibility-matrix.adoc#rosa-policy-responsibilities_rosa-policy-responsibility-matrix[ROSA Responsibilities] document.
 
-* For more information about ROSA and its components, see the xref:../rosa_architecture/rosa-service-definition.adoc#rosa-service-definition[ROSA Service Definition].
+* For more information about ROSA and its components, see the xref:../rosa_policy_service_definition/rosa-service-definition.adoc#rosa-service-definition[ROSA Service Definition].
diff --git a/...re/rosa-policy-responsibility-matrix.adoc → ...on/rosa-policy-responsibility-matrix.adoc b/...re/rosa-policy-responsibility-matrix.adoc → ...on/rosa-policy-responsibility-matrix.adoc
diff --git a/.../rosa-policy-understand-availability.adoc → .../rosa-policy-understand-availability.adoc b/.../rosa-policy-understand-availability.adoc → .../rosa-policy-understand-availability.adoc
diff --git a/...architecture/rosa-service-definition.adoc → ...e_definition/rosa-service-definition.adoc b/...architecture/rosa-service-definition.adoc → ...e_definition/rosa-service-definition.adoc
@@ -19,5 +19,5 @@ include::modules/rosa-sdpolicy-security.adoc[leveloffset=+1]
 
 == Additional resources
 
-* See xref:../rosa_architecture/rosa-policy-process-security.adoc#rosa-policy-process-security[Understanding process and security for ROSA] for the latest compliance information.
-* See xref:../rosa_architecture/rosa-life-cycle.adoc#rosa-life-cycle[ROSA life cycle]
+* See xref:../rosa_policy_service_definition/rosa-policy-process-security.adoc#rosa-policy-process-security[Understanding process and security for ROSA] for the latest compliance information.
+* See xref:../rosa_policy_service_definition/rosa-life-cycle.adoc#rosa-life-cycle[ROSA life cycle]
diff --git a/rosa_architecture/rosa_policy_service_definition/snippets b/rosa_architecture/rosa_policy_service_definition/snippets
@@ -0,0 +1 @@
+../snippets