Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ Ensure that you have the following resources and tools before starting this proc
* `oc` CLI
* `jq` CLI

[discrete]
[id="cloud-experts-aws-secret-manager-preparing-environment"]
=== Additional environment requirements

Expand Down Expand Up @@ -59,7 +58,7 @@ $ oc get authentication.config.openshift.io cluster -o json \
----
+
If your output is different, do not proceed.
See
See
ifndef::openshift-rosa-hcp[]
xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-a-cluster-quickly[Red{nbsp}Hat documentation on creating an STS cluster] before continuing this process.
endif::openshift-rosa-hcp[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ endif::openshift-rosa[]

. The OpenShift Command Line Interface (CLI)
+
For more information, see
For more information, see
ifdef::openshift-rosa-hcp[]
link:https://docs.openshift.com/rosa/cli_reference/openshift_cli/getting-started-cli.html#cli-getting-started[Getting started with the OpenShift CLI].
endif::openshift-rosa-hcp[]
Expand All @@ -35,5 +35,5 @@ endif::openshift-rosa-hcp[]
Use your existing GitHub account or register at link:https://github.com/signup[https://github.com/signup].

include::modules/rosa-sts-understanding-aws-account-association.adoc[leveloffset=+2]
[discrete]
include::modules/rosa-sts-associating-your-aws-account.adoc[leveloffset=+2]

include::modules/rosa-sts-associating-your-aws-account.adoc[leveloffset=+2]
47 changes: 23 additions & 24 deletions modules/rosa-hcp-create-network.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ If you do not specify a template, CloudFormation uses a default template that cr
| Availability zones
| 1

| Region
| Region
| `us-east-1`
| VPC CIDR
| `10.0.0.0/16`

| VPC CIDR
| `10.0.0.0/16`
|===

You can create and customize CloudFormation templates to use with the `rosa create network` command. See the additional resources of this section for information on the default VPC template.
Expand Down Expand Up @@ -339,25 +339,25 @@ endif::rosa-egress-lockdown[]
+
[source,bash]
----
INFO[0140] Resources created in stack:
INFO[0140] Resource: AttachGateway, Type: AWS::EC2::VPCGatewayAttachment, ID: <gateway_id>
INFO[0140] Resource: EC2VPCEndpoint, Type: AWS::EC2::VPCEndpoint, ID: <vpce_id>
INFO[0140] Resources created in stack:
INFO[0140] Resource: AttachGateway, Type: AWS::EC2::VPCGatewayAttachment, ID: <gateway_id>
INFO[0140] Resource: EC2VPCEndpoint, Type: AWS::EC2::VPCEndpoint, ID: <vpce_id>
INFO[0140] Resource: EcrApiVPCEndpoint, Type: AWS::EC2::VPCEndpoint, ID: <vpce_id>
INFO[0140] Resource: EcrDkrVPCEndpoint, Type: AWS::EC2::VPCEndpoint, ID: <vpce_id>
INFO[0140] Resource: EcrDkrVPCEndpoint, Type: AWS::EC2::VPCEndpoint, ID: <vpce_id>
INFO[0140] Resource: ElasticIP1, Type: AWS::EC2::EIP, ID: <IP>
INFO[0140] Resource: ElasticIP2, Type: AWS::EC2::EIP, ID: <IP>
INFO[0140] Resource: InternetGateway, Type: AWS::EC2::InternetGateway, ID: igw-016e1a71b9812464e
INFO[0140] Resource: KMSVPCEndpoint, Type: AWS::EC2::VPCEndpoint, ID: <vpce_id>
INFO[0140] Resource: NATGateway1, Type: AWS::EC2::NatGateway, ID: <nat-gateway_id>
INFO[0140] Resource: PrivateRoute, Type: AWS::EC2::Route, ID: <route_id>
INFO[0140] Resource: PrivateRouteTable, Type: AWS::EC2::RouteTable, ID: <route_id>
INFO[0140] Resource: ElasticIP2, Type: AWS::EC2::EIP, ID: <IP>
INFO[0140] Resource: InternetGateway, Type: AWS::EC2::InternetGateway, ID: igw-016e1a71b9812464e
INFO[0140] Resource: KMSVPCEndpoint, Type: AWS::EC2::VPCEndpoint, ID: <vpce_id>
INFO[0140] Resource: NATGateway1, Type: AWS::EC2::NatGateway, ID: <nat-gateway_id>
INFO[0140] Resource: PrivateRoute, Type: AWS::EC2::Route, ID: <route_id>
INFO[0140] Resource: PrivateRouteTable, Type: AWS::EC2::RouteTable, ID: <route_id>
INFO[0140] Resource: PrivateSubnetRouteTableAssociation1, Type: AWS::EC2::SubnetRouteTableAssociation, ID: <route_id>
INFO[0140] Resource: PublicRoute, Type: AWS::EC2::Route, ID: <route_id>
INFO[0140] Resource: PublicRouteTable, Type: AWS::EC2::RouteTable, ID: <route_id>
INFO[0140] Resource: PublicSubnetRouteTableAssociation1, Type: AWS::EC2::SubnetRouteTableAssociation, ID: <route_id>
INFO[0140] Resource: S3VPCEndpoint, Type: AWS::EC2::VPCEndpoint, ID: <vpce_id>
INFO[0140] Resource: STSVPCEndpoint, Type: AWS::EC2::VPCEndpoint, ID: <vpce_id>
INFO[0140] Resource: SecurityGroup, Type: AWS::EC2::SecurityGroup, ID: <security-group_id>
INFO[0140] Resource: PublicRoute, Type: AWS::EC2::Route, ID: <route_id>
INFO[0140] Resource: PublicRouteTable, Type: AWS::EC2::RouteTable, ID: <route_id>
INFO[0140] Resource: PublicSubnetRouteTableAssociation1, Type: AWS::EC2::SubnetRouteTableAssociation, ID: <route_id>
INFO[0140] Resource: S3VPCEndpoint, Type: AWS::EC2::VPCEndpoint, ID: <vpce_id>
INFO[0140] Resource: STSVPCEndpoint, Type: AWS::EC2::VPCEndpoint, ID: <vpce_id>
INFO[0140] Resource: SecurityGroup, Type: AWS::EC2::SecurityGroup, ID: <security-group_id>
INFO[0140] Resource: SubnetPrivate1, Type: AWS::EC2::Subnet, ID: <private_subnet_id-1> \ <1>
INFO[0140] Resource: SubnetPublic1, Type: AWS::EC2::Subnet, ID: <public_subnet_id-1> \ <1>
INFO[0140] Resource: VPC, Type: AWS::EC2::VPC, ID: <vpc_id>
Expand All @@ -367,7 +367,6 @@ INFO[0140] Stack rosa-network-stack-5555 created \ <2>
<2> The network stack name is used to delete the resource later.

ifdef::rosa-egress-lockdown[]
[discrete]
[id="rosa-hcp-vpc-subnet-tagging-rosa-network_{context}"]
== Tagging your subnets

Expand All @@ -380,11 +379,11 @@ Before you can use your VPC to create a {product-title} cluster, you must tag yo
| Value

| Public subnet
| `kubernetes.io/role/elb`
| `kubernetes.io/role/elb`
| `1` or no value

| Private subnet
| `kubernetes.io/role/internal-elb`
| Private subnet
| `kubernetes.io/role/internal-elb`
| `1` or no value

|===
Expand Down
7 changes: 3 additions & 4 deletions modules/rosa-hcp-vpc-manual.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ If you choose to manually create your AWS Virtual Private Cloud (VPC) instead of
include::snippets/rosa-existing-vpc-requirements.adoc[leveloffset=+0]

ifdef::rosa-egress-lockdown[]
[discrete]
[id="rosa-hcp-vpc-subnet-tagging-manual_{context}"]
== Tagging your subnets

Expand All @@ -31,11 +30,11 @@ Before you can use your VPC to create a {product-title} cluster, you must tag yo
| Value

| Public subnet
| `kubernetes.io/role/elb`
| `kubernetes.io/role/elb`
| `1` or no value

| Private subnet
| `kubernetes.io/role/internal-elb`
| Private subnet
| `kubernetes.io/role/internal-elb`
| `1` or no value

|===
Expand Down
7 changes: 3 additions & 4 deletions modules/rosa-hcp-vpc-terraform.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ $ subnet-0a6a57e0f784171aa,subnet-078e84e5b10ecf5b0

endif::rosa-egress-lockdown[]
ifdef::rosa-egress-lockdown[]
[discrete]
[id="rosa-hcp-vpc-subnet-tagging-terraform_{context}"]
== Tagging your subnets

Expand All @@ -139,11 +138,11 @@ Before you can use your VPC to create a {product-title} cluster, you must tag yo
| Value

| Public subnet
| `kubernetes.io/role/elb`
| `kubernetes.io/role/elb`
| `1` or no value

| Private subnet
| `kubernetes.io/role/internal-elb`
| Private subnet
| `kubernetes.io/role/internal-elb`
| `1` or no value

|===
Expand Down
2 changes: 0 additions & 2 deletions modules/rosa-sts-account-wide-role-and-policy-commands.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

This section lists the `aws` CLI commands that the `rosa` command generates in the terminal. You can run the command in either manual or automatic mode.

[discrete]
[id="rosa-sts-account-wide-role-and-policy-aws-cli-manual-mode_{context}"]
== Using manual mode for account role creation

Expand Down Expand Up @@ -92,7 +91,6 @@ aws iam create-policy \
--tags Key=rosa_openshift_version,Value=<openshift_version> Key=rosa_role_prefix,Value=ManagedOpenShift Key=operator_namespace,Value=openshift-image-registry Key=operator_name,Value=installer-cloud-credentials
----

[discrete]
[id="rosa-sts-account-wide-role-and-policy-aws-cli-auto-mode_{context}"]
== Using auto mode for role creation

Expand Down
3 changes: 0 additions & 3 deletions modules/rosa-sts-account-wide-roles-and-policies.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@ The account-wide roles and policies are specific to an {product-title} minor rel

You can create account-wide roles by using the {product-title} (ROSA) CLI, `rosa`, or the {cluster-manager-url} guided installation. You can create the roles manually or by using an automatic process that uses predefined names for these roles and policies.

[discrete]
[id="rosa-sts-account-wide-roles-and-policies-creation-methods-manual_{context}"]
=== Manual ocm-role resource creation

You can use the manual creation method if you have the necessary CLI access to create these roles on your system. You can run this option in your desired CLI tool or from {cluster-manager}. After you start the manual creation process, the CLI presents a series of commands for you to run that create the roles and link them to the needed policies.

[discrete]
[id="rosa-sts-account-wide-roles-and-policies-creation-methods-auto_{context}"]
=== Automatic ocm-role resource creation

Expand Down Expand Up @@ -204,7 +202,6 @@ include::https://raw.githubusercontent.com/openshift/managed-cluster-config/refs
----
====

[discrete]
[id="rosa-sts-account-wide-roles-and-policies-example-cli-output-for-policies-attached-to-a-role_{context}"]
==== Example CLI output for policies attached to a role

Expand Down
3 changes: 0 additions & 3 deletions modules/rosa-sts-byo-oidc-options.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ The following options may be added to the `rosa create oidc-config` command. All
You are required to register the unmanaged OIDC configuration by posting a request to `/oidc_configs` through OpenShift Cluster Manager. You receive an ID in the response. Use this ID to create a cluster.
====

[discrete]
[id="rosa-sts-byo-oidc-raw-files_{context}"]
== raw-files

Expand All @@ -28,7 +27,6 @@ You use these files to set up the endpoint. This endpoint responds to `/.well-kn
$ rosa create oidc-config --raw-files
----

[discrete]
[id="rosa-sts-byo-oidc-mode_{context}"]
== mode

Expand All @@ -42,7 +40,6 @@ You receive the same OIDC configuration and AWS resources as the `manual` mode w
$ rosa create oidc-config --mode=<auto|manual>
----

[discrete]
[id="rosa-sts-byo-oidc-managed_{context}"]
== managed

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
:_mod-docs-content-type: ASSEMBLY
include::_attributes/attributes-openshift-dedicated.adoc[]
[id="osd-nodes-about-autoscaling-nodes"]
= About autoscaling nodes on a cluster
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: osd-nodes-about-autoscaling-nodes

toc::[]

[IMPORTANT]
Expand All @@ -28,7 +29,6 @@ Only cluster owners and organization admins can scale or delete a cluster.

You can enable autoscaling on worker nodes to increase or decrease the number of nodes available by editing the machine pool definition for an existing cluster.

[discrete]
include::modules/ocm-enabling-autoscaling-nodes.adoc[leveloffset=+2]

[id="osd-nodes-disabling-autoscaling-nodes"]
Expand All @@ -38,7 +38,6 @@ You can disable autoscaling on worker nodes to increase or decrease the number o

You can disable autoscaling on a cluster using {cluster-manager} console.

[discrete]
include::modules/ocm-disabling-autoscaling-nodes.adoc[leveloffset=+2]

Applying autoscaling to an {product-title} cluster involves deploying a cluster autoscaler and then deploying machine autoscalers for each machine type in your cluster.
Expand Down
8 changes: 4 additions & 4 deletions rosa_architecture/rosa-oidc-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ The OIDC protocol uses a configuration URL that contains the necessary informati
include::modules/rosa-oidc-understanding.adoc[leveloffset=+1]

include::modules/rosa-oidc-config-overview.adoc[leveloffset=+1]
[discrete]
include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+3]
[discrete]
include::modules/rosa-sts-byo-oidc-options.adoc[leveloffset=+3]

include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+2]

include::modules/rosa-sts-byo-oidc-options.adoc[leveloffset=+2]

include::modules/rosa-sts-oidc-provider-command.adoc[leveloffset=+1]

Expand Down
5 changes: 2 additions & 3 deletions rosa_architecture/rosa-sts-about-iam-resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ include::modules/rosa-sts-understanding-ocm-role.adoc[leveloffset=+2]
.Additional resources
* xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-account-wide-roles-and-policies-creation-methods_rosa-sts-about-iam-resources[Methods of account-wide role creation]

[discrete]
include::modules/rosa-sts-ocm-role-creation.adoc[leveloffset=+2]

AWS IAM roles link to your AWS account to create and manage the clusters.
Expand Down Expand Up @@ -149,9 +148,9 @@ For ROSA installations that use STS, you must create a cluster-specific OIDC pro
include::modules/rosa-sts-oidc-provider-command.adoc[leveloffset=+2]

include::modules/rosa-oidc-config-overview.adoc[leveloffset=+2]
[discrete]

include::modules/rosa-sts-byo-oidc.adoc[leveloffset=+3]
[discrete]

include::modules/rosa-sts-byo-oidc-options.adoc[leveloffset=+3]

include::modules/rosa-aws-scp.adoc[leveloffset=+1]
Expand Down
5 changes: 3 additions & 2 deletions rosa_architecture/rosa-understanding.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
= Understanding ROSA
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: rosa-understanding

toc::[]

Learn about {product-title} (ROSA), interacting with ROSA by using {cluster-manager-first} and command-line interface (CLI) tools, consumption experience, and integration with Amazon Web Services (AWS) services.
Expand Down Expand Up @@ -48,15 +49,15 @@ For additional information about ROSA installation, see link:https://www.redhat.

//This mode makes use of a pre-created IAM user with `AdministratorAccess` within the account that has proper permissions to create other roles and resources as needed. Using this account the service creates all the necessary resources that are needed for the cluster.

include::modules/rosa-sdpolicy-am-billing.adoc[leveloffset=+1]
include::modules/rosa-sdpolicy-am-billing.adoc[leveloffset=+1]

[id="rosa-understanding-getting-started_{context}"]
== Getting started

To get started with deploying your cluster, ensure your AWS account has met the prerequisites, you have a Red{nbsp}Hat account ready, and follow the procedures outlined in xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Getting started with {product-title}].

[discrete]
[role="_additional-resources"]
[id="additional-resources_{context}"]
== Additional resources

* xref:../ocm/ocm-overview.adoc#ocm-overview[OpenShift Cluster Manager]
Expand Down
3 changes: 0 additions & 3 deletions rosa_cluster_admin/rosa-cluster-autoscaling-hcp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ The cluster autoscaler increases the size of the cluster when there are pods tha

The cluster autoscaler computes the total memory, CPU, and GPU only on the nodes that belong to autoscaling machine pools. All of the machine pool nodes that are not autoscaling are excluded from this aggregation. For example, if you set the `maxNodesTotal` to `50` on a {product-title} cluster with three machine pools in which a single machine pool is not autoscaling, the cluster autoscaler restricts the total nodes to `50` in only those two machine pools that are autoscaling. The single manually scaling machine pool can have additional nodes, making the overall cluster nodes total more than `50`.

[discrete]
[id="cluster-autoscaler-scale-down_{context}"]
=== Automatic node removal

Expand All @@ -44,7 +43,6 @@ If the following types of pods are present on a node, the cluster autoscaler wil

For example, you set the maximum CPU limit to 64 cores and configure the cluster autoscaler to only create machines that have 8 cores each. If your cluster starts with 30 cores, the cluster autoscaler can add up to 4 more nodes with 32 cores, for a total of 62.

[discrete]
[id="cluster-autoscaler-limitations_{context}"]
=== Limitations

Expand All @@ -62,7 +60,6 @@ The cluster autoscaler only adds nodes in autoscaled node groups if doing so wou
If the available node types cannot meet the requirements for a pod request, or if the node groups that could meet these requirements are at their maximum size, the cluster autoscaler cannot scale up.
====

[discrete]
[id="cluster-autoscaler-interaction_{context}"]
=== Interaction with other scheduling features

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
:_mod-docs-content-type: ASSEMBLY
include::_attributes/attributes-openshift-dedicated.adoc[]
[id="rosa-nodes-about-autoscaling-nodes"]
= About autoscaling nodes on a cluster
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: rosa-nodes-about-autoscaling-nodes

toc::[]

ifdef::openshift-dedicated[]
Expand Down Expand Up @@ -30,7 +31,6 @@ Only cluster owners and organization admins can scale or delete a cluster.

You can enable autoscaling on worker nodes to increase or decrease the number of nodes available by editing the machine pool definition for an existing cluster.

[discrete]
include::modules/ocm-enabling-autoscaling-nodes.adoc[leveloffset=+2]

ifdef::openshift-rosa[]
Expand All @@ -48,7 +48,6 @@ endif::[]
// endif::[]

ifdef::openshift-rosa,openshift-rosa-hcp[]
[discrete]
include::modules/rosa-enabling-autoscaling-nodes.adoc[leveloffset=+2]
endif::[]

Expand Down Expand Up @@ -79,14 +78,13 @@ endif::[]
// ====
// endif::[]

[discrete]
include::modules/ocm-disabling-autoscaling-nodes.adoc[leveloffset=+2]

ifdef::openshift-rosa,openshift-rosa-hcp[]
[discrete]
include::modules/rosa-disabling-autoscaling-nodes.adoc[leveloffset=+2]
endif::[]

[role="_additional-resources"]
[id="nodes-about-autoscaling-nodes-additional-resources"]
== Additional resources
* link:https://access.redhat.com/solutions/6821651[Troubleshooting: Autoscaling is not scaling down nodes]
Expand Down
Loading