Skip to content

Commit f78ed8a

Browse files
committed
[OSDOCS-3599] OSD Restructure
1 parent e802aaa commit f78ed8a

File tree

86 files changed

+868
-206
lines changed

Some content is hidden

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

86 files changed

+868
-206
lines changed

_topic_maps/_topic_map_osd.yml

+85-99
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,40 @@ Topics:
3232
File: legal-notice
3333
Distros: openshift-dedicated
3434
---
35-
Name: Architecture
35+
Name: Introduction to OpenShift Dedicated
3636
Dir: osd_architecture
3737
Distros: openshift-dedicated
3838
Topics:
39-
- Name: Introduction to OpenShift Dedicated
39+
- Name: Understanding OpenShift Dedicated
4040
File: osd-understanding
4141
- Name: Architecture concepts
4242
File: osd-architecture
43+
- Name: Policies and service definition
44+
Dir: osd_policy
45+
Distros: openshift-dedicated
46+
Topics:
47+
- Name: OpenShift Dedicated service definition
48+
File: osd-service-definition
49+
- Name: Responsibility assignment matrix
50+
File: policy-responsibility-matrix
51+
- Name: Understanding process and security for OpenShift Dedicated
52+
File: policy-process-security
53+
- Name: About availability for OpenShift Dedicated
54+
File: policy-understand-availability
55+
- Name: Update life cycle
56+
File: osd-life-cycle
57+
- Name: Support for OpenShift Dedicated
58+
File: osd-support
59+
Distros: openshift-dedicated
4360
---
44-
Name: Planning
61+
Name: Red Hat OpenShift Cluster Manager
62+
Dir: ocm
63+
Distros: openshift-dedicated
64+
Topics:
65+
- Name: Red Hat OpenShift Cluster Manager
66+
File: ocm-overview
67+
---
68+
Name: Planning your environment
4569
Dir: osd_planning
4670
Distros: openshift-dedicated
4771
Topics:
@@ -51,45 +75,71 @@ Topics:
5175
File: gcp-ccs
5276
---
5377
Name: Getting started
54-
Dir: osd_quickstart
78+
Dir: osd_getting_started
5579
Distros: openshift-dedicated
5680
Topics:
81+
- Name: Understanding your cloud deployment options
82+
File: osd-understanding-your-cloud-deployment-options
5783
- Name: Getting started with OpenShift Dedicated
58-
File: osd-quickstart
84+
File: osd-getting-started
5985
---
60-
Name: Red Hat OpenShift Cluster Manager
61-
Dir: ocm
86+
Name: Installing, accessing, and deleting OpenShift Dedicated clusters
87+
Dir: osd_install_access_delete_cluster
6288
Distros: openshift-dedicated
6389
Topics:
64-
- Name: Red Hat OpenShift Cluster Manager
65-
File: ocm-overview
66-
---
67-
Name: Creating a cluster
68-
Dir: osd_cluster_create
69-
Distros: openshift-dedicated
70-
Topics:
71-
- Name: Understanding your cloud deployment options
72-
File: osd-understanding-your-cloud-deployment-options
7390
- Name: Creating a cluster on AWS
7491
File: creating-an-aws-cluster
7592
- Name: Creating a cluster on GCP
7693
File: creating-a-gcp-cluster
77-
---
78-
Name: Configuring identity providers
79-
Dir: identity_providers
80-
Distros: openshift-dedicated
81-
Topics:
8294
- Name: Configuring your identity providers
8395
File: config-identity-providers
96+
- Name: Notifications for OpenShift Dedicated clusters
97+
File: notifications
8498
---
85-
Name: Administering your cluster
86-
Dir: administering_a_cluster
99+
Name: Cluster administration
100+
Dir: osd_cluster_admin
87101
Distros: openshift-dedicated
88102
Topics:
89103
- Name: Managing administration roles and users
90104
File: osd-admin-roles
105+
- Name: Configuring private connections
106+
Dir: osd_private_connections
107+
Distros: openshift-dedicated
108+
Topics:
109+
- Name: Configuring private connections for AWS
110+
File: aws-private-connections
111+
- Name: Configuring a private cluster
112+
File: private-cluster
113+
- Name: Nodes
114+
Dir: osd_nodes
115+
Distros: openshift-dedicated
116+
Topics:
117+
- Name: About machine pools
118+
File: osd-nodes-machinepools-about
119+
- Name: Managing compute nodes
120+
File: osd-managing-worker-nodes
121+
- Name: About autoscaling nodes on a cluster
122+
File: osd-nodes-about-autoscaling-nodes
123+
- Name: Monitoring user-defined projects
124+
Dir: osd_monitoring
125+
Distros: openshift-dedicated
126+
Topics:
127+
- Name: Understanding the monitoring stack
128+
File: osd-understanding-the-monitoring-stack
129+
- Name: Configuring the monitoring stack
130+
File: osd-configuring-the-monitoring-stack
131+
- Name: Accessing monitoring for user-defined projects
132+
File: osd-accessing-monitoring-for-user-defined-projects
133+
- Name: Managing metrics
134+
File: osd-managing-metrics
135+
- Name: Managing alerts
136+
File: osd-managing-alerts
137+
- Name: Reviewing monitoring dashboards
138+
File: osd-reviewing-monitoring-dashboards
139+
- Name: Troubleshooting monitoring issues
140+
File: osd-troubleshooting-monitoring-issues
91141
---
92-
Name: Authentication and authorization
142+
Name: Cluster security
93143
Dir: authentication
94144
Distros: openshift-dedicated
95145
Topics:
@@ -107,13 +157,6 @@ Topics:
107157
File: osd-upgrades
108158
Distros: openshift-dedicated
109159
---
110-
Name: Cluster notifications
111-
Dir: osd_notifications
112-
Distros: openshift-dedicated
113-
Topics:
114-
- Name: Notifications for OpenShift Dedicated clusters
115-
File: notifications
116-
---
117160
Name: Add-on services
118161
Dir: adding_service_cluster
119162
Distros: openshift-dedicated
@@ -124,14 +167,16 @@ Topics:
124167
File: available-services
125168
Distros: openshift-dedicated
126169
---
127-
Name: Configuring private connections
128-
Dir: osd_private_connections
170+
Name: Storage
171+
Dir: storage
129172
Distros: openshift-dedicated
130173
Topics:
131-
- Name: Configuring private connections for AWS
132-
File: aws-private-connections
133-
- Name: Configuring a private cluster
134-
File: private-cluster
174+
- Name: Persistent storage
175+
Dir: persistent_storage
176+
Distros: openshift-dedicated
177+
Topics:
178+
- Name: Persistent storage using AWS EFS
179+
File: osd-persistent-storage-aws
135180
---
136181
Name: Networking
137182
Dir: networking
@@ -147,47 +192,6 @@ Topics:
147192
- Name: CIDR range definitions
148193
File: cidr-range-definitions
149194
---
150-
Name: Nodes
151-
Dir: nodes
152-
Distros: openshift-dedicated
153-
Topics:
154-
- Name: About machine pools
155-
File: nodes-machinepools-about
156-
- Name: Managing compute nodes
157-
File: rosa-managing-worker-nodes
158-
- Name: About autoscaling nodes on a cluster
159-
File: nodes-about-autoscaling-nodes
160-
---
161-
Name: Monitoring user-defined projects
162-
Dir: monitoring
163-
Distros: openshift-dedicated
164-
Topics:
165-
- Name: Understanding the monitoring stack
166-
File: osd-understanding-the-monitoring-stack
167-
- Name: Configuring the monitoring stack
168-
File: osd-configuring-the-monitoring-stack
169-
- Name: Accessing monitoring for user-defined projects
170-
File: osd-accessing-monitoring-for-user-defined-projects
171-
- Name: Managing metrics
172-
File: osd-managing-metrics
173-
- Name: Managing alerts
174-
File: osd-managing-alerts
175-
- Name: Reviewing monitoring dashboards
176-
File: osd-reviewing-monitoring-dashboards
177-
- Name: Troubleshooting monitoring issues
178-
File: osd-troubleshooting-monitoring-issues
179-
---
180-
Name: Storage
181-
Dir: storage
182-
Distros: openshift-dedicated
183-
Topics:
184-
- Name: Persistent storage
185-
Dir: persistent_storage
186-
Distros: openshift-dedicated
187-
Topics:
188-
- Name: Persistent storage using AWS EFS
189-
File: osd-persistent-storage-aws
190-
---
191195
Name: Applications
192196
Dir: applications
193197
Distros: openshift-dedicated
@@ -199,21 +203,6 @@ Topics:
199203
- Name: Configuring custom domains for applications
200204
File: osd-config-custom-domains-applications
201205
---
202-
Name: Policies and service definition
203-
Dir: osd_policy
204-
Distros: openshift-dedicated
205-
Topics:
206-
- Name: OpenShift Dedicated service definition
207-
File: osd-service-definition
208-
- Name: Responsibility assignment matrix
209-
File: policy-responsibility-matrix
210-
- Name: Understanding process and security for OpenShift Dedicated
211-
File: policy-process-security
212-
- Name: About availability for OpenShift Dedicated
213-
File: policy-understand-availability
214-
- Name: Update life cycle
215-
File: osd-life-cycle
216-
---
217206
Name: Serverless
218207
Dir: serverless
219208
Distros: openshift-dedicated
@@ -363,13 +352,10 @@ Topics:
363352
- Name: Functions development reference guide
364353
File: serverless-functions-reference-guide
365354
---
366-
Name: Support
367-
Dir: support
355+
Name: Troubleshooting
356+
Dir: osd_support
368357
Distros: openshift-dedicated
369358
Topics:
370-
- Name: Getting support
371-
File: getting-support
372-
Distros: openshift-dedicated
373359
- Name: Remote health monitoring with connected clusters
374360
Dir: remote_health_monitoring
375361
Distros: openshift-dedicated
@@ -383,7 +369,7 @@ Topics:
383369
- Name: Using Insights to identify issues with your cluster
384370
File: using-insights-to-identify-issues-with-your-cluster
385371
- Name: Summarizing cluster specifications
386-
File: summarizing-cluster-specifications
372+
File: osd-summarizing-cluster-specifications
387373
Distros: openshift-dedicated
388374
- Name: OpenShift Dedicated managed resources
389375
File: osd-managed-resources
32.7 KB
Loading

modules/access-cluster.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * osd_quickstart/osd-quickstart.adoc
3+
// * osd_getting_started/osd-getting-started.adoc
44
// * identity_providers/config-identity-providers.adoc
55

66
:_content-type: PROCEDURE

modules/config-idp.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * osd_quickstart/osd-quickstart.adoc
3+
// * osd_getting_started/osd-getting-started.adoc
44

55
:_content-type: PROCEDURE
66
[id="config-idp_{context}"]

modules/deleting-cluster.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
// Module included in the following assemblies:
33
//
4-
// * osd_quickstart/osd-quickstart.adoc
4+
// * osd_getting_started/osd-getting-started.adoc
55

66
:_content-type: PROCEDURE
77
[id="deleting-cluster_{context}"]

modules/deploy-app.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * rosa_getting_started/rosa-getting-started.adoc
4-
// * osd_quickstart/osd-quickstart.adoc
4+
// * osd_getting_started/osd-getting-started.adoc
55

66
:_content-type: PROCEDURE
77
[id="deploy-app_{context}"]

modules/osd-create-cluster-ccs.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * osd_quickstart/osd-quickstart.adoc
3+
// * osd_getting_started/osd-getting-started.adoc
44
// * osd_cluster_create/creating-an-aws-cluster.adoc
55
// * osd_cluster_create/creating-a-gcp-cluster.adoc
66

modules/osd-create-cluster-red-hat-account.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * osd_quickstart/osd-quickstart.adoc
3+
// * osd_getting_started/osd-getting-started.adoc
44
// * osd_cluster_create/creating-an-aws-cluster.adoc
55
// * osd_cluster_create/creating-a-gcp-cluster.adoc
66

modules/osd-intro.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
// * assemblies/osd-architecture.adoc
55

66
[id="osd-intro_{context}"]
7-
= Introduction to {product-title}
7+
= An overview of {product-title}
88

99
{product-title} is professionally managed by Red Hat and hosted on {AWS} or {GCP}. Each {product-title} cluster comes with a fully managed link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.7/html/architecture/control-plane[control plane] (Control and Infrastructure nodes), application nodes, installation and management by Red Hat Site Reliability Engineers (SRE), premium Red Hat Support, and cluster services such as logging, metrics, monitoring, notifications portal, and a cluster portal.
1010

modules/scaling-cluster.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * osd_quickstart/osd-quickstart.adoc
3+
// * osd_getting_started/osd-getting-started.adoc
44

55
:_content-type: PROCEDURE
66
[id="scaling-cluster_{context}"]

modules/upgrade.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Automatic upgrade policies are optional and if they are not set, the upgrade pol
3232
[id="upgrade-manual_upgrades_{context}"]
3333
== Manual upgrades
3434

35-
If you opt for manual upgrades, you are responsible for updating your cluster. If your cluster version falls too far behind, it will transition to a limited support status. For more information on OpenShift life cycle policies, see xref:../osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
35+
If you opt for manual upgrades, you are responsible for updating your cluster. If your cluster version falls too far behind, it will transition to a limited support status. For more information on OpenShift life cycle policies, see xref:../osd_architecture/osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
3636

3737
[id="upgrade-notifications_{context}"]
3838
== Upgrade notifications

networking/configuring-cluster-wide-proxy.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ ifdef::openshift-rosa[]
2929
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[]
32-
For more information, see xref:../osd_quickstart/osd-quickstart.adoc#osd-getting-started[Getting started with {product-title}] for a basic cluster installation workflow.
32+
For more information, see xref:../osd_getting_started/osd-getting-started.adoc#osd-getting-started[Getting started with {product-title}] for a basic cluster installation workflow.
3333
endif::[]
3434

3535
//OSDOCS-3290 Transparent Proxy Update

osd_architecture/osd-support.adoc

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
:_content-type: ASSEMBLY
2+
[id="osd-getting-support"]
3+
= Getting support
4+
include::_attributes/common-attributes.adoc[]
5+
ifdef::openshift-dedicated[]
6+
include::_attributes/attributes-openshift-dedicated.adoc[]
7+
endif::[]
8+
:context: osd-getting-support
9+
10+
toc::[]
11+
12+
Get support for {product-title}.
13+
14+
include::modules/support.adoc[leveloffset=+1]
15+
include::modules/support-knowledgebase-about.adoc[leveloffset=+1]
16+
include::modules/support-knowledgebase-search.adoc[leveloffset=+1]
17+
include::modules/support-submitting-a-case.adoc[leveloffset=+1]
18+
19+
[id="osd-getting-support-additional-resources"]
20+
[role="_additional-resources"]
21+
== Additional resources
22+
23+
* For details about identifying issues with your cluster, see xref:../osd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster].

osd_architecture/osd-understanding.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
22
[id="osd-understanding"]
3-
= Introduction to {product-title}
3+
= Understanding {product-title}
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: osd-understanding
66

@@ -13,4 +13,4 @@ include::modules/osd-intro.adoc[leveloffset=+1]
1313
[role="_additional-resources"]
1414
.Additional resources
1515

16-
* For more information about Telemetry and remote health monitoring for {product-title} clusters, see xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]
16+
* For more information about Telemetry and remote health monitoring for {product-title} clusters, see xref:../osd_support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images/
+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules/

0 commit comments

Comments
 (0)