Skip to content

Commit

Permalink
ROSA topic map restructure
Browse files Browse the repository at this point in the history
  • Loading branch information
bmcelvee committed Mar 16, 2022
1 parent 137c30d commit 54cbdf1
Show file tree
Hide file tree
Showing 98 changed files with 897 additions and 311 deletions.
378 changes: 198 additions & 180 deletions _topic_maps/_topic_map_rosa.yml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion adding_service_cluster/adding-service.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ include::modules/deleting-service-cli.adoc[leveloffset=+1]
ifdef::openshift-rosa[]
[role="_additional-resources"]
== Additional resources
* For information about the `cluster-logging-operator` and the AWS CloudWatch log forwarding service, see xref:../logging/rosa-install-logging.adoc#rosa-install-logging[Install the logging add-on service]
* For information about the `cluster-logging-operator` and the AWS CloudWatch log forwarding service, see xref:../rosa_cluster_admin/rosa_logging/rosa-install-logging.adoc#rosa-install-logging[Install the logging add-on service]
endif::[]
7 changes: 7 additions & 0 deletions adding_service_cluster/rosa-available-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,12 @@ These services can also be installed xref:../rosa_cli/rosa-manage-objects-cli.ad


include::modules/aws-cloudwatch.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../rosa_cluster_admin/rosa_logging/rosa-install-logging.adoc#rosa-install-logging[Installing the CloudWatch logging service]
* link:https://aws.amazon.com/cloudwatch/[Amazon CloudWatch product information]
include::modules/codeready-workspaces.adoc[leveloffset=+1]
include::modules/osd-rhoam.adoc[leveloffset=+1]
3 changes: 1 addition & 2 deletions modules/aws-cloudwatch.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,4 @@ Amazon CloudWatch forwards logs from {product-title} (ROSA) to the AWS console f
[role="_additional-resources"]
.Additional resources

* See xref:../logging/rosa-install-logging.adoc#rosa-install-logging[Install the logging add-on service] for information about the Amazon CloudWatch log forwarding service.
* See link:https://aws.amazon.com/cloudwatch/[Amazon CloudWatch product information] for general details about Amazon Cloudwatch.
* link:https://aws.amazon.com/cloudwatch/[Amazon CloudWatch product information]
2 changes: 1 addition & 1 deletion modules/rosa-create-cluster-admins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@


:_content-type: PROCEDURE
[id="rosa-create-cluster-admins"]
[id="rosa-create-cluster-admins_{context}"]
= Granting `cluster-admin` access

As the user who created the cluster, add the `cluster-admin` user role to your account to have the maximum administrator privileges. These privileges are not automatically assigned to your user account when you create the cluster.
Expand Down
2 changes: 1 addition & 1 deletion modules/rosa-create-dedicated-cluster-admins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@


:_content-type: PROCEDURE
[id="rosa-create-dedicated-cluster-admins"]
[id="rosa-create-dedicated-cluster-admins_{context}"]
= Granting `dedicated-admin` access
Only the user who created the cluster can grant cluster access to other `cluster-admin` or `dedicated-admin` users. Users with `dedicated-admin` access have fewer privileges. As a best practice, grant `dedicated-admin` access to most of your administrators.

Expand Down
2 changes: 1 addition & 1 deletion modules/rosa-delete-cluster-admins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@


:_content-type: PROCEDURE
[id="rosa-delete-cluster-admins"]
[id="rosa-delete-cluster-admins_{context}"]
= Revoking `cluster-admin` access using the `rosa` CLI
Only the user who created the cluster can revoke access for `cluster-admin` users.

Expand Down
2 changes: 1 addition & 1 deletion modules/rosa-delete-dedicated-admins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@


:_content-type: PROCEDURE
[id="rosa-delete-dedicated-admins"]
[id="rosa-delete-dedicated-admins_{context}"]
= Revoking `dedicated-admin` access using the `rosa` CLI
You can revoke access for a `dedicated-admin` user if you are the user who created the cluster, the organization administrator user, or the super administrator user.

Expand Down
2 changes: 1 addition & 1 deletion monitoring/osd-configuring-the-monitoring-stack.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

This document explains what is supported for the monitoring of user-defined projects. It also shows how to configure the monitoring stack, and demonstrates several common configuration scenarios.
After you configure the monitoring stack, you can review common configuration scenarios and configure monitoring of user-defined projects.

// Maintenance and support for monitoring
include::modules/osd-monitoring-maintenance-and-support.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion monitoring/osd-managing-alerts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

Alerts for monitoring workloads in user-defined projects are not currently supported in this product.
Alerts for monitoring workloads in user-defined projects are not currently supported in this {product-title}.

[id="alerts-next-steps"]
== Next steps
Expand Down
2 changes: 1 addition & 1 deletion monitoring/osd-managing-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

This document provides an overview about how {product-title} metrics are collected, queried and visualized.
{product-title} collects metrics for <noun_goes_here>, and you can use <noun_goes_here> to query and visualize them.

// Understanding metrics
include::modules/osd-monitoring-understanding-metrics.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion monitoring/osd-troubleshooting-monitoring-issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

This document describes how to troubleshoot common monitoring issues for user-defined projects.
Find troubleshooting steps for common monitoring issues with user-defined projects.

include::modules/osd-monitoring-troubleshooting-issues.adoc[leveloffset=+1]
2 changes: 1 addition & 1 deletion networking/configuring-cluster-wide-proxy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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_getting_started/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_getting_started_sts/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prerequisites[AWS prerequisites for ROSA with STS].
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].
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.
Expand Down
6 changes: 3 additions & 3 deletions nodes/nodes-machinepools-about.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The primary resources are machines, machine sets, and machine pools.
A machine is a fundamental unit that describes the host for a worker node.

== Machine sets
`MachineSet` resources are groups of machines. If you need more machines or must scale them down, this is done by configuring the number of replicas in the machine pool to which the machine sets belong.
`MachineSet` resources are groups of machines. If you need more machines or must scale them down, change the number of replicas in the machine pool to which the machine sets belong.

ifdef::openshift-rosa[]
Machine sets are not directly modifiable in ROSA.
Expand All @@ -22,9 +22,9 @@ endif::[]
== Machine pools
Machine pools are a higher level construct to machine sets.

A machine pool creates machine sets that are all clones of the same configuration across availability zones. Machine pools perform all of the host node provisioning management actions on a worker node. If you need more machines or must scale them down, change the number of replicas in the machine pool to meet your compute needs. Scaling can be configured manually or you can set autoscaling.
A machine pool creates machine sets that are all clones of the same configuration across availability zones. Machine pools perform all of the host node provisioning management actions on a worker node. If you need more machines or must scale them down, change the number of replicas in the machine pool to meet your compute needs. You can manually configure scaling or set autoscaling.

By default, a cluster is created with one machine pool. Additional machine pools can be added later to an existing cluster and you can modify the default machine pool. Machine pools can also be deleted.
By default, a cluster is created with one machine pool. You can add additional machine pools to an existing cluster, modify the default machine pool, and delete machine pools.

Multiple machine pools can exist on a single cluster, and they can each have different types or different size nodes.

Expand Down
10 changes: 10 additions & 0 deletions rosa_architecture/rosa-getting-support.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:_content-type: ASSEMBLY
[id="rosa-getting-support"]
= Getting support for {product-title}
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: rosa-getting-support
toc::[]

Get support for {product-title} (ROSA).

include::modules/rosa-getting-support.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ toc::[]

include::modules/life-cycle-overview.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../rosa_policy/rosa-service-definition.adoc#rosa-service-definition[{product-title} service definition]
* xref:../rosa_architecture/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]
Expand All @@ -20,7 +19,7 @@ include::modules/life-cycle-minor-versions.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources

* xref:../rosa_policy/rosa-life-cycle.adoc#rosa-limited-support_rosa-life-cycle[{product-title} limited support status]
* xref:../rosa_architecture/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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,8 @@ include::modules/rosa-policy-security-regulation-compliance.adoc[leveloffset=+1]
include::modules/rosa-policy-disaster-recovery.adoc[leveloffset=+1]


[role="_additional-resources"]
== Additional resources

* For more information about customer or shared responsibilities, see the xref:../rosa_policy/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_architecture/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_policy/rosa-service-definition.adoc#rosa-service-definition[ROSA Service Definition].
* For more information about ROSA and its components, see the xref:../rosa_architecture/rosa-service-definition.adoc#rosa-service-definition[ROSA Service Definition].
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ include::modules/rosa-sdpolicy-platform.adoc[leveloffset=+1]
include::modules/rosa-sdpolicy-security.adoc[leveloffset=+1]


[role="_additional-resources"]
== Additional resources

* See xref:../rosa_policy/rosa-policy-process-security.adoc#rosa-policy-process-security[Understanding process and security for ROSA] for the latest compliance information.
* See xref:../rosa_policy/rosa-life-cycle.adoc#rosa-life-cycle[ROSA life cycle]
* 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]
32 changes: 32 additions & 0 deletions rosa_architecture/rosa-sts-getting-started-workflow.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
:_content-type: ASSEMBLY
[id="rosa-sts-understanding-the-deployment-workflow"]
= Understanding the ROSA with STS deployment workflow
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: rosa-sts-overview-of-the-deployment-workflow

toc::[]

Before you create a {product-title} (ROSA) cluster, you must complete the AWS prerequisites, verify that the required AWS service quotas are available, and set up your environment.

This document provides an overview of the ROSA with STS deployment workflow stages and refers to detailed resources for each stage.

[id="rosa-sts-overview-of-the-deployment-workflow"]
== Overview of the ROSA with STS deployment workflow

The AWS Security Token Service (STS) is a global web service that provides short-term credentials for IAM or federated users. You can use AWS STS with {product-title} (ROSA) to allocate temporary, limited-privilege credentials for component-specific IAM roles. The service enables cluster components to make AWS API calls using secure cloud resource management practices.

You can follow the workflow stages outlined in this section to set up and access a ROSA cluster that uses STS.

. xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prereqs[Complete the AWS prerequisites for ROSA with STS]. To deploy a ROSA cluster with STS, your AWS account must meet the prerequisite requirements.
. xref:../rosa_getting_started/rosa-sts-required-aws-service-quotas.adoc#rosa-sts-required-aws-service-quotas[Review the required AWS service quotas]. To prepare for your cluster deployment, review the AWS service quotas that are required to run a ROSA cluster.
. xref:../rosa_getting_started/rosa-sts-setting-up-environment.adoc#rosa-sts-setting-up-environment[Set up the environment and install ROSA using STS]. Before you create a ROSA with STS cluster, you must enable ROSA in your AWS account, install and configure the required CLI tools, and verify the configuration of the CLI tools. You must also verify that the AWS Elastic Load Balancing (ELB) service role exists and that the required AWS resource quotas are available.
. xref:../rosa_getting_started/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-a-cluster-quickly[Create a ROSA cluster with STS quickly] or xref:../rosa_getting_started/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-sts-creating-a-cluster-with-customizations[create a cluster using customizations]. Use the ROSA CLI (`rosa`) to create a cluster with STS. You can create a cluster by using the default options, or you can apply customizations to suit the needs of your organization.
. xref:../rosa_getting_started/rosa-sts-accessing-cluster.adoc#rosa-sts-accessing-cluster[Access your cluster]. You can configure an identity provider and grant cluster administrator privileges to the identity provider users as required. You can also access a newly-deployed cluster quickly by configuring a `cluster-admin` user.
. xref:../rosa_getting_started/rosa-sts-deleting-access-cluster.adoc#rosa-sts-deleting-access-cluster[Revoke access to a ROSA cluster for a user]. You can revoke access to a ROSA with STS cluster from a user by using the ROSA CLI or the web console.
. xref:../rosa_getting_started/rosa-sts-deleting-cluster.adoc#rosa-sts-deleting-cluster[Delete a ROSA cluster]. You can delete a ROSA with STS cluster by using the ROSA CLI (`rosa`). After deleting a cluster, you can delete the STS resources by using the AWS Identity and Access Management (IAM) Console.

[id="additional_resources_{context}"]
[role="_additional-resources"]
== Additional resources

* For information about using the ROSA deployment workflow to create a cluster that does not use AWS STS, see xref:../rosa_getting_started/rosa_getting_started_iam/rosa-getting-started-workflow.adoc#rosa-understanding-the-deployment-workflow[Understanding the ROSA deployment workflow].
2 changes: 1 addition & 1 deletion rosa_architecture/rosa-understanding.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_content-type: ASSEMBLY
[id="rosa-understanding"]
= Introduction to ROSA
= Understanding ROSA
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: rosa-understanding
toc::[]
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ include::modules/rosa-enable-private-cluster-existing.adoc[leveloffset=+1]
[role="_additional-resources"]
== Additional resources

* xref:../rosa_getting_started/rosa-aws-privatelink-creating-cluster.adoc#rosa-aws-privatelink-creating-cluster[Creating an AWS PrivateLink cluster on ROSA]
* xref:../../rosa_getting_started/rosa_getting_started_iam/rosa-aws-privatelink-creating-cluster.adoc#rosa-aws-privatelink-creating-cluster[Creating an AWS PrivateLink cluster on ROSA]
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ include::modules/rosa-install-logging-addon.adoc[leveloffset=+1]
[role="_additional-resources"]
[id="additional-resources_adding-service"]
== Additional resources
* xref:../adding_service_cluster/adding-service.adoc#adding-service[Adding services to your cluster]
* xref:../../adding_service_cluster/adding-service.adoc#adding-service[Adding services to your cluster]
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions rosa_cluster_admin/rosa_monitoring/images
1 change: 1 addition & 0 deletions rosa_cluster_admin/rosa_monitoring/modules
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
:_content-type: ASSEMBLY
[id="rosa-accessing-monitoring-for-user-defined-projects"]
= Accessing monitoring for user-defined projects
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: rosa-accessing-monitoring-for-user-defined-projects

toc::[]

By default, centralized monitoring for user-defined projects and platform monitoring are enabled. You can monitor your own projects in {product-title} without the need for an additional monitoring solution.

The monitoring of user-defined projects cannot be disabled.

The `dedicated-admin` user has default permissions to configure and access monitoring for user-defined projects.

[NOTE]
====
Custom Prometheus instances and the Prometheus Operator installed through Operator Lifecycle Manager (OLM) can cause issues with user-defined project monitoring if it is enabled. Custom Prometheus instances are not supported.
====

[id="accessing-user-defined-monitoring-next-steps"]
== Next steps

* xref:../rosa_monitoring/rosa-managing-metrics.adoc#rosa-managing-metrics[Managing metrics]
Loading

0 comments on commit 54cbdf1

Please sign in to comment.