mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
Replace manual ROSA CLI command ref with autogenerated version
This commit is contained in:
Ben Hardesty
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
c956b2d0a6
commit
651ed815c1
@@ -512,12 +512,8 @@ Topics:
|
||||
# File: rosa-cli-openshift-console
|
||||
- Name: Getting started with the ROSA CLI
|
||||
File: rosa-get-started-cli
|
||||
- Name: Managing objects with the ROSA CLI
|
||||
File: rosa-manage-objects-cli
|
||||
- Name: Checking account and version information with the ROSA CLI
|
||||
File: rosa-checking-acct-version-cli
|
||||
- Name: Checking logs with the ROSA CLI
|
||||
File: rosa-checking-logs-cli
|
||||
- Name: ROSA CLI command reference
|
||||
File: rosa-cli-commands
|
||||
- Name: Least privilege permissions for ROSA CLI commands
|
||||
File: rosa-cli-permission-examples
|
||||
|
||||
|
||||
@@ -314,12 +314,8 @@ Topics:
|
||||
# File: rosa-cli-openshift-console
|
||||
- Name: Getting started with the ROSA CLI
|
||||
File: rosa-get-started-cli
|
||||
- Name: Managing objects with the ROSA CLI
|
||||
File: rosa-manage-objects-cli
|
||||
- Name: Checking account and version information with the ROSA CLI
|
||||
File: rosa-checking-acct-version-cli
|
||||
- Name: Checking logs with the ROSA CLI
|
||||
File: rosa-checking-logs-cli
|
||||
- Name: ROSA CLI command reference
|
||||
File: rosa-cli-commands
|
||||
- Name: Least privilege permissions for ROSA CLI commands
|
||||
File: rosa-cli-permission-examples
|
||||
- Name: Managing AWS billing accounts with the ROSA CLI
|
||||
|
||||
@@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
|
||||
You can add services to your existing {product-title} (ROSA) cluster using the xref:../adding_service_cluster/adding-service.adoc#adding-service[{cluster-manager-first} console].
|
||||
|
||||
These services can also be installed xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[using the `rosa` CLI].
|
||||
These services can also be installed xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-install-addon[using the `rosa install addon` command].
|
||||
|
||||
|
||||
include::modules/aws-cloudwatch.adoc[leveloffset=+1]
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
[id="rosa-acct-version-cli"]
|
||||
= Checking account and version information with the ROSA CLI
|
||||
:context: rosa-checking-acct-version-cli
|
||||
|
||||
toc::[]
|
||||
|
||||
Use the following commands to check your account and version information.
|
||||
|
||||
include::modules/rosa-checking-account-version-cli-whoami.adoc[leveloffset=+1]
|
||||
include::modules/rosa-checking-account-version-cli-version.adoc[leveloffset=+1]
|
||||
@@ -1,12 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
[id="rosa-checking-logs-cli"]
|
||||
= Checking logs with the ROSA CLI
|
||||
:context: rosa-checking-logs-cli
|
||||
|
||||
toc::[]
|
||||
|
||||
Use the following commands to check your install and uninstall logs.
|
||||
|
||||
include::modules/rosa-logs-install.adoc[leveloffset=+1]
|
||||
include::modules/rosa-logs-uninstall.adoc[leveloffset=+1]
|
||||
16
cli_reference/rosa_cli/rosa-cli-commands.adoc
Normal file
16
cli_reference/rosa_cli/rosa-cli-commands.adoc
Normal file
@@ -0,0 +1,16 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="rosa-cli-commands"]
|
||||
= ROSA CLI command reference
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: rosa-cli-commands
|
||||
|
||||
toc::[]
|
||||
|
||||
[role="_abstract"]
|
||||
This reference provides descriptions and example commands for ROSA CLI (`rosa`) commands.
|
||||
|
||||
Run `rosa -h` to list all commands or run `rosa <command> --help` to get additional details for a specific command.
|
||||
|
||||
// The following file is auto-generated from the openshift/rosa repository
|
||||
// ROSA CLI commands
|
||||
include::modules/rosa-by-example-content.adoc[leveloffset=+1]
|
||||
@@ -1,47 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
[id="rosa-managing-objects-cli"]
|
||||
= Managing objects with the ROSA CLI
|
||||
|
||||
:context: rosa-managing-objects-cli
|
||||
|
||||
toc::[]
|
||||
|
||||
Managing objects with the {rosa-cli-first}, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
To access a cluster that is accessible only over an HTTP proxy server, you can set the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` variables. These environment variables are respected by the `rosa` CLI so that all communication with the cluster goes through the HTTP proxy.
|
||||
====
|
||||
|
||||
include::modules/rosa-common-commands.adoc[leveloffset=+1]
|
||||
include::modules/rosa-parent-commands.adoc[leveloffset=+1]
|
||||
include::modules/rosa-create-objects.adoc[leveloffset=+1]
|
||||
|
||||
ifdef::openshift-rosa[]
|
||||
[role="_additional-resources"]
|
||||
== Additional resources
|
||||
|
||||
* See xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-aws-instance-types_rosa-service-definition[AWS Instance types] for a list of supported instance types.
|
||||
* See xref:../../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-account-wide-roles-and-policies_rosa-sts-about-iam-resources[Account-wide IAM role and policy reference] for a list of IAM roles needed for cluster creation.
|
||||
* See xref:../../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-sts-understanding-aws-account-association_rosa-sts-creating-a-cluster-with-customizations[Understanding AWS account association] for more information about the OCM role and user role.
|
||||
* See xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-aws-prereqs.adoc#rosa-security-groups_prerequisites[Additional custom security groups] for information about security group requirements.
|
||||
endif::openshift-rosa[]
|
||||
|
||||
include::modules/rosa-edit-objects.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources_1"]
|
||||
== Additional resources
|
||||
ifdef::openshift-rosa[]
|
||||
* See xref:../../networking/networking_operators/ingress-operator.adoc#configuring-ingress-controller[Configuring the Ingress Controller] for information regarding editing non-default application routers.
|
||||
endif::openshift-rosa[]
|
||||
//Classic to HCP breakout. Remove ROSA-specific conditionals when networking is added to HCP.
|
||||
|
||||
include::modules/rosa-delete-objects.adoc[leveloffset=+1]
|
||||
include::modules/rosa-install-uninstall-addon.adoc[leveloffset=+1]
|
||||
include::modules/rosa-list-objects.adoc[leveloffset=+1]
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
include::modules/rosa-revoke-objects.adoc[leveloffset=+1]
|
||||
endif::openshift-rosa-hcp[]
|
||||
include::modules/rosa-upgrade-cluster-cli.adoc[leveloffset=+1]
|
||||
|
||||
1509
modules/rosa-by-example-content.adoc
Normal file
1509
modules/rosa-by-example-content.adoc
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,36 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * rosa_cli/rosa-checking-acct-version-cli.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="rosa-version_{context}"]
|
||||
= version
|
||||
|
||||
Display the version of your `rosa` CLI by using the following command syntax:
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa version [arguments]
|
||||
----
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--profile
|
||||
|Specifies an AWS profile (string) from your credentials file.
|
||||
|===
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa version
|
||||
----
|
||||
@@ -1,36 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * rosa_cli/rosa-checking-acct-version-cli.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="rosa-whoami_{context}"]
|
||||
= whoami
|
||||
|
||||
Display information about your AWS and Red{nbsp}Hat accounts by using the following command syntax:
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa whoami [arguments]
|
||||
----
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--profile
|
||||
|Specifies an AWS profile (string) from your credentials file.
|
||||
|===
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa whoami
|
||||
----
|
||||
@@ -1,90 +0,0 @@
|
||||
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * rosa_cli/rosa-manage-objects-cli.adoc
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="rosa-common-commands_{context}"]
|
||||
= Common commands and arguments
|
||||
|
||||
These common commands and arguments are available for the {rosa-cli-first}.
|
||||
|
||||
[id="rosa-debug_{context}"]
|
||||
== debug
|
||||
|
||||
Enables debug mode for the parent command to help with troubleshooting.
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa create cluster --cluster-name=<cluster_name> --debug
|
||||
----
|
||||
|
||||
[id="rosa-download_{context}"]
|
||||
== download
|
||||
|
||||
Downloads the latest compatible version of the specified software to the current directory in an archive file. Extract the contents of the archive and add the contents to your path to use the software. To download the latest ROSA CLI, specify `rosa`. To download the latest OpenShift CLI, specify `oc`.
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa download <software>
|
||||
----
|
||||
|
||||
[id="rosa-help_{context}"]
|
||||
== help
|
||||
|
||||
Displays general help information for the ROSA CLI (`rosa`) and a list of available commands. This option can also be used as an argument to display help information for a parent command, such as `version` or `create`.
|
||||
|
||||
.Examples
|
||||
Displays general help for the ROSA CLI.
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa --help
|
||||
----
|
||||
|
||||
Displays general help for `version`.
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa version --help
|
||||
----
|
||||
|
||||
[id="rosa-interactive_{context}"]
|
||||
== interactive
|
||||
|
||||
Enables interactive mode.
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa create cluster --cluster-name=<cluster_name> --interactive
|
||||
----
|
||||
|
||||
[id="rosa-profile-string_{context}"]
|
||||
== profile
|
||||
|
||||
Specifies an AWS profile from your credential file.
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa create cluster --cluster-name=<cluster_name> --profile=myAWSprofile
|
||||
----
|
||||
|
||||
[id="rosa-version_{context}"]
|
||||
== version
|
||||
|
||||
Displays the `rosa` version and checks whether a newer version is available.
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa version [arguments]
|
||||
----
|
||||
|
||||
.Example output
|
||||
Displayed when a newer version of the ROSA CLI is available.
|
||||
[source,terminal]
|
||||
----
|
||||
1.2.12
|
||||
There is a newer release version '1.2.15', please consider updating: https://mirror.openshift.com/pub/openshift-v4/clients/rosa/latest/
|
||||
----
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,593 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * rosa_cli/rosa-manage-objects-cli.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="rosa-delete-objects_{context}"]
|
||||
= Delete objects
|
||||
|
||||
This section describes the `delete` commands for clusters and resources.
|
||||
|
||||
[id="rosa-delete-account-roles_{context}"]
|
||||
== delete account-roles
|
||||
|
||||
Cleans up account roles from the current AWS account.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete account-roles
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--classic
|
||||
|Deletes classic account roles
|
||||
|
||||
|--delete-hcp-shared-vpc-policies
|
||||
|Deletes the Hosted Control Plane shared vpc policies
|
||||
|
||||
|--hosted-cp
|
||||
|Deletes Hosted Control Plane roles
|
||||
|
||||
a|-m, --mode string
|
||||
a|How to perform the operation. Valid options are:
|
||||
|
||||
`auto`:: Resource changes will be applied automatically using the current AWS account.
|
||||
`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually.
|
||||
|
||||
|--prefix
|
||||
|Prefix of the account roles to be deleted.
|
||||
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Example
|
||||
Deletes all AWS account roles with the prefix of `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete account-roles -p mycluster
|
||||
----
|
||||
|
||||
[id="rosa-delete-admin_{context}"]
|
||||
== delete admin
|
||||
|
||||
Deletes a cluster administrator from a specified cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete admin --cluster=<cluster_name> | <cluster_id>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster that contains the identity provider (IDP) you want to delete.
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Example
|
||||
Deletes a cluster administrator from a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete admin --cluster=mycluster
|
||||
----
|
||||
|
||||
ifdef::openshift-rosa[]
|
||||
[id="rosa-delete-autoscaler_{context}"]
|
||||
== delete autoscaler
|
||||
|
||||
Deletes autoscaler configuration for a given cluster.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
This action is only supported on {product-title} clusters with a self-hosted control plane. Clusters with hosted control planes do not support autoscaler.
|
||||
====
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete autoscaler --cluster=<cluster_name>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster that has an autoscaler you want to delete.
|
||||
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Example
|
||||
Deletes the autoscaler on a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete autoscaler --cluster=mycluster
|
||||
----
|
||||
endif::openshift-rosa[]
|
||||
|
||||
[id="rosa-delete-cluster_{context}"]
|
||||
== delete cluster
|
||||
|
||||
Deletes a cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete cluster --cluster=<cluster_name> | <cluster_id> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster to delete.
|
||||
|
||||
|--watch
|
||||
|Watches the cluster uninstallation logs.
|
||||
|
||||
|--best-effort
|
||||
|Skips steps in the cluster destruction chain that are known to cause the cluster deletion process to fail. You should use this option with care and it is recommended that you manually check your AWS account for any resources that might be left over after using `--best-effort`.
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Examples
|
||||
Deletes a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete cluster --cluster=mycluster
|
||||
----
|
||||
|
||||
[id="rosa-delete-external-auth-provider_{context}"]
|
||||
== delete external-auth-provider
|
||||
|
||||
Deletes an external authentication provider from a cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete external-auth-provider <name_of_external_auth_provider> --cluster=<cluster_name> | <cluster_id> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required. The name or ID string of the cluster the external auth provider will be deleted from.
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Example
|
||||
Deletes an identity provider named `exauth-1` from a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete external-auth-provider exauth-1 --cluster=mycluster
|
||||
----
|
||||
|
||||
[id="rosa-delete-idp_{context}"]
|
||||
== delete idp
|
||||
|
||||
Deletes a specific identity provider (IDP) from a cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete idp --cluster=<cluster_name> | <cluster_id> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster from which the IDP will be deleted.
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Example
|
||||
Deletes an identity provider named `github` from a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete idp github --cluster=mycluster
|
||||
----
|
||||
|
||||
[id="rosa-delete-ingress_{context}"]
|
||||
== delete ingress
|
||||
|
||||
Deletes a non-default application router (ingress) from a cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete ingress --cluster=<cluster_name> | <cluster_id> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster from which the ingress will be deleted.
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Examples
|
||||
Deletes an ingress with the ID `a1b2` from a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete ingress --cluster=mycluster a1b2
|
||||
----
|
||||
|
||||
Deletes a secondary ingress with the subdomain name `apps2` from a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete ingress --cluster=mycluster apps2
|
||||
----
|
||||
|
||||
[id="rosa-delete-kubeletconfig_{context}"]
|
||||
== delete kubeletconfig
|
||||
|
||||
Deletes a custom `KubeletConfig` object from a cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete kubeletconfig --cluster=<cluster_name|cluster_id> [flags]
|
||||
----
|
||||
|
||||
.Flags
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
a|-c, --cluster <cluster_name>\|<cluster_id>
|
||||
|Required. The name or ID of the cluster for which you want to delete the `KubeletConfig` object.
|
||||
|
||||
|--name
|
||||
a|
|
||||
ifdef::temp-ifdef[]
|
||||
Optional.
|
||||
endif::[]
|
||||
ifdef::temp-ifdef[]
|
||||
Required.
|
||||
endif::[]
|
||||
Specifies a name for the `KubeletConfig` object.
|
||||
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
[id="rosa-delete-machinepool_{context}"]
|
||||
== delete machinepool
|
||||
|
||||
Deletes a machine pool from a cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete machinepool --cluster=<cluster_name> | <cluster_id> <machine_pool_id>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster that the machine pool will be deleted from.
|
||||
|
||||
|--machinepool string
|
||||
|Machine pool of the cluster to target.
|
||||
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Example
|
||||
Deletes the machine pool with the ID `mp-1` from a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete machinepool --cluster=mycluster mp-1
|
||||
----
|
||||
|
||||
[id="rosa-delete-ocm-role_{context}"]
|
||||
== delete ocm-role
|
||||
|
||||
Deletes OCM role from the current AWS organization.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete ocm-role --role-arn <role_arn>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
a|-m, --mode string
|
||||
a|How to perform the operation. Valid options are:
|
||||
|
||||
`auto`:: Resource changes will be applied automatically using the current AWS account.
|
||||
`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually.
|
||||
|
||||
|--role-arn string
|
||||
|Required: The role ARN to delete from the user role from the AWS account
|
||||
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Examples
|
||||
Deletes an ocm-role with `arn:aws:iam::123456789012:role/xxx-OCM-Role-1223456778` arn.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete ocm-role --role-arn arn:aws:iam::123456789012:role/xxx-OCM-Role-1223456778
|
||||
----
|
||||
|
||||
[id="rosa-delete-oidc-config_{context}"]
|
||||
== delete oidc-config
|
||||
|
||||
Deletes the OIDC config based on the registered OIDC Config ID.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete oidc-config --oidc-config-id <oidc_config_id>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
a|-m, --mode string
|
||||
a|How to perform the operation. Valid options are:
|
||||
|
||||
`auto`:: Resource changes will be applied automatically using the current AWS account.
|
||||
`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually.
|
||||
|
||||
|--oidc-config-id string
|
||||
|Required: Registered ID for identification of OIDC config.
|
||||
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Example
|
||||
Deletes an OIDC config with an ID of `A1B2C3D4`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete oidc-config --oidc-config-id A1B2C3D4
|
||||
----
|
||||
|
||||
[id="rosa-delete-oidc-provider_{context}"]
|
||||
== delete oidc-provider
|
||||
|
||||
Deletes the OIDC provider of a deleted STS cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete oidc-provider --cluster=<cluster_name> | --oidc-config-id <oidc_config_id>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|-c, --cluster string
|
||||
|Name or ID of the cluster.
|
||||
|
||||
a|-m, --mode string
|
||||
a|How to perform the operation. Valid options are:
|
||||
|
||||
`auto`:: Resource changes will be applied automatically using the current AWS account.
|
||||
`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually.
|
||||
|
||||
|--oidc-config-id string
|
||||
|Required: Registered OIDC configuration ID to retrieve its issuer URL. Not to be used alongside `--cluster` flag.
|
||||
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Examples
|
||||
* Deletes the OIDC provider using the OIDC config ID of `A1B2C3D4`.
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete oidc-provider --oidc-config-id A1B2C3D4
|
||||
----
|
||||
|
||||
* Deletes the OIDC provider using the cluster name of `mycluster`.
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete oidc-provider --cluster=mycluster
|
||||
----
|
||||
|
||||
[id="rosa-delete-operator-roles_{context}"]
|
||||
== delete operator-roles
|
||||
|
||||
Deletes the Operator roles of a deleted STS cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete oidc-provider --cluster=<cluster_name> | --oidc-config-id <oidc_config_id>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|-c, --cluster string
|
||||
|Name or ID of the cluster.
|
||||
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
|--delete-hcp-shared-vpc-policies
|
||||
|Deletes the hosted control plane shared VPC policies.
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
a|-m, --mode string
|
||||
a|How to perform the operation. Valid options are:
|
||||
|
||||
`auto`:: Resource changes will be applied automatically using the current AWS account.
|
||||
`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually.
|
||||
|
||||
|--prefix string
|
||||
|Operator role prefix. You must use this flag in case of reusable OIDC Config.
|
||||
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Example
|
||||
|
||||
Deletes the operator-roles on the cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete operator-roles --cluster=mycluster
|
||||
----
|
||||
|
||||
[id="rosa-delete-tuning-configs_{context}"]
|
||||
== delete tuning-configs
|
||||
|
||||
Deletes a specified tuning configuration that is on a specified cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete tuning-config --cluster=<cluster_name> <tuning_config_name>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|-c, --cluster string
|
||||
|Name or ID of the cluster.
|
||||
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Example
|
||||
|
||||
Deletes the tuning config named `tuned1` from a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete tuning-config --cluster=mycluster tuned1
|
||||
----
|
||||
|
||||
[id="rosa-delete-upgrade_{context}"]
|
||||
== delete upgrade
|
||||
|
||||
Cancels a scheduled cluster upgrade.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete upgrade
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option
|
||||
|Definition
|
||||
|
||||
|-c, --cluster string
|
||||
|Name or ID of the cluster.
|
||||
|
||||
|--machinepool string
|
||||
|Machine pool of the cluster to target.
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Example
|
||||
Deletes the user role that has a prefix of `rh-user` and a user-role name of `Auditor`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete user-role --role-arn rh-user-User-Auditor-Role
|
||||
----
|
||||
|
||||
[id="rosa-delete-user-role_{context}"]
|
||||
== delete user-role
|
||||
|
||||
Deletes user role from the current AWS account.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete user-role
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
a|-m, --mode string
|
||||
a|How to perform the operation. Valid options are:
|
||||
|
||||
`auto`:: Resource changes will be applied automatically using the current AWS account.
|
||||
`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually.
|
||||
|
||||
|--role-arn string
|
||||
|Required: The ARN of the user-role that you want to delete from the AWS account.
|
||||
|
||||
|===
|
||||
|
||||
include::snippets/rosa-cli-default-flags.adoc[]
|
||||
|
||||
.Example
|
||||
Deletes the user role that has a prefix of `rh-user` and a user-role name of `Auditor`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete user-role --role-arn rh-user-User-Auditor-Role
|
||||
----
|
||||
@@ -1,410 +0,0 @@
|
||||
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * rosa_cli/rosa-manage-objects-cli.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="rosa-edit-objects_{context}"]
|
||||
= Edit objects
|
||||
|
||||
|
||||
This section describes the `edit` commands for clusters and resources.
|
||||
|
||||
[id="rosa-edit-cluster_{context}"]
|
||||
== edit cluster
|
||||
|
||||
Allows edits to an existing cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit cluster --cluster=<cluster_name> | <cluster_id> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
|--additional-allowed-principals <arn>
|
||||
|A comma-separated list of additional allowed principal ARNs to be added to the Hosted Control Plane's VPC endpoint service to enable additional VPC endpoint connection requests to be automatically accepted.
|
||||
endif::openshift-rosa-hcp[]
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster to edit.
|
||||
|
||||
|--private
|
||||
|Restricts a primary API endpoint to direct, private connectivity.
|
||||
|
||||
|--enable-delete-protection=true
|
||||
|Enables the delete protection feature.
|
||||
|
||||
|--enable-delete-protection=false
|
||||
|Disables the delete protection feature.
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
|--billing-account-string
|
||||
|Specifies the account used for billing subscriptions purchased from the AWS marketplace.
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
|--channel-group <channel_group_name>
|
||||
|Allows users to assign their cluster to a specific channel group. Options include `stable` and `eus`. For more information about channel groups, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/updating_clusters/understanding-openshift-updates-1#understanding-update-channels-releases[Understanding update channels and releases].
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--interactive
|
||||
|Enables interactive mode.
|
||||
|
||||
|--profile
|
||||
|Specifies an AWS profile (string) from your credentials file.
|
||||
|===
|
||||
|
||||
.Examples
|
||||
Edit a cluster named `mycluster` to make it private.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit cluster --cluster=mycluster --private
|
||||
----
|
||||
|
||||
Edit all cluster options interactively on a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit cluster --cluster=mycluster --interactive
|
||||
----
|
||||
|
||||
[id="rosa-edit-ingress_{context}"]
|
||||
== edit ingress
|
||||
|
||||
Edits the default application router for a cluster.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For information about editing non-default application routers, see _Additional resources_.
|
||||
====
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit ingress --cluster=<cluster_name> | <cluster_id> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster to which the ingress will be added.
|
||||
|
||||
|--cluster-routes-hostname
|
||||
|Components route hostname for OAuth, console, and download.
|
||||
|
||||
|--cluster-routes-tls-secret-ref
|
||||
|Components route TLS secret reference for OAuth, console, and download.
|
||||
|
||||
|--excluded-namespaces
|
||||
|Excluded namespaces for ingress. Format is a comma-separated list `value1, value2...`. If no values are specified, all namespaces will be exposed.
|
||||
|
||||
|--label-match
|
||||
|The label match (string) for ingress. The format must be a comma-delimited list of key=value pairs. If no label is specified, all routes are exposed on both routers.
|
||||
|
||||
|--lb-type
|
||||
|Type of Load Balancer. Options are `classic`, `nlb`.
|
||||
|
||||
|--namespace-ownership-policy
|
||||
|Namespace Ownership Policy for ingress. Options are `Strict` and `InterNamespaceAllowed`. Default is `Strict`.
|
||||
|
||||
|--private
|
||||
|Restricts the application route to direct, private connectivity.
|
||||
|
||||
|--route-selector
|
||||
|Route Selector for ingress. Format is a comma-separated list of key=value. If no label is specified, all routes will be exposed on both routers. For legacy ingress support these are inclusion labels, otherwise they are treated as exclusion label.
|
||||
|
||||
|--wildcard-policy
|
||||
|Wildcard Policy for ingress. Options are `WildcardsDisallowed` and `WildcardsAllowed`. Default is `WildcardsDisallowed`.
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--interactive
|
||||
|Enables interactive mode.
|
||||
|
||||
|--profile
|
||||
|Specifies an AWS profile (string) from your credentials file.
|
||||
|===
|
||||
|
||||
.Examples
|
||||
|
||||
Make an additional ingress with the ID `a1b2` as a private connection on a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit ingress --private --cluster=mycluster a1b2
|
||||
----
|
||||
|
||||
Update the router selectors for the additional ingress with the ID `a1b2` on a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit ingress --label-match=foo=bar --cluster=mycluster a1b2
|
||||
----
|
||||
|
||||
Update the default ingress using the sub-domain identifier `apps` on a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit ingress --private=false --cluster=mycluster apps
|
||||
----
|
||||
|
||||
Update the load balancer type of the `apps2` ingress.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit ingress --lb-type=nlb --cluster=mycluster apps2
|
||||
----
|
||||
|
||||
[id="rosa-edit-kubeletconfig_{context}"]
|
||||
== edit kubeletconfig
|
||||
|
||||
Edit a custom `KubeletConfig` object in a
|
||||
ifdef::temp-ifdef[]
|
||||
cluster.
|
||||
endif::[]
|
||||
ifdef::temp-ifdef[]
|
||||
machine pool.
|
||||
endif::[]
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit kubeletconfig --cluster=<cluster_name|cluster_id> --name=<kubeletconfig_name> --pod-pids-limit=<number> [flags]
|
||||
----
|
||||
|
||||
.Flags
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
a|-c, --cluster <cluster_name>\|<cluster_id>
|
||||
|Required. The name or ID of the cluster for which the `KubeletConfig` object will be edited.
|
||||
|
||||
|-i, --interactive
|
||||
|Enable interactive mode.
|
||||
|
||||
|--pod-pids-limit <number>
|
||||
a|Required. The maximum number of PIDs for each node in the
|
||||
ifdef::temp-ifdef[]
|
||||
cluster.
|
||||
endif::[]
|
||||
ifdef::temp-ifdef[]
|
||||
machine pool associated with the `KubeletConfig` object.
|
||||
endif::[]
|
||||
|
||||
|--name
|
||||
a|
|
||||
ifdef::temp-ifdef[]
|
||||
Optional.
|
||||
endif::[]
|
||||
ifdef::temp-ifdef[]
|
||||
Required.
|
||||
endif::[]
|
||||
Specifies a name for the `KubeletConfig` object.
|
||||
|
||||
|-h, --help
|
||||
|Shows help for this command.
|
||||
|===
|
||||
|
||||
For more information about setting the PID limit for the cluster, see _Configuring PID limits_.
|
||||
|
||||
[id="rosa-edit-machinepool_{context}"]
|
||||
== edit machinepool
|
||||
|
||||
Allows edits to the machine pool in a cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit machinepool --cluster=<cluster_name_or_id> <machinepool_name> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster to edit on which the additional machine pool will be edited.
|
||||
|
||||
|--enable-autoscaling
|
||||
|Enable or disable autoscaling of compute nodes. To enable autoscaling, use this argument with the `--min-replicas` and `--max-replicas` arguments. To disable autoscaling, use `--enable-autoscaling=false` with the `--replicas` argument.
|
||||
|
||||
|--labels
|
||||
|The labels (string) for the machine pool. The format must be a comma-delimited list of key=value pairs. Editing this value only affects newly created nodes of the machine pool, which are created by increasing the node number, and does not affect the existing nodes. This list overwrites any modifications made to node labels on an ongoing basis.
|
||||
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
a|--kubelet-configs <kubeletconfig_name>
|
||||
| The names of any `KubeletConfig` objects to apply to nodes in a machine pool.
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
|--max-replicas
|
||||
|Specifies the maximum number of compute nodes when enabling autoscaling.
|
||||
|
||||
|--min-replicas
|
||||
|Specifies the minimum number of compute nodes when enabling autoscaling.
|
||||
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
|--max-surge
|
||||
a| The `max-surge` parameter defines the number of new nodes that can be provisioned in excess of the desired number of replicas for the machine pool, as configured using the `--replicas` parameter, or as determined by the autoscaler when autoscaling is enabled. This can be an absolute number (for example, `2`) or a percentage of the machine pool size (for example, `20%`), but must use the same unit as the `max-unavailable` parameter.
|
||||
|
||||
The default value is `1`, meaning that the maximum number of nodes in the machine pool during an upgrade is 1 plus the desired number of replicas for the machine pool. In this situation, one excess node can be provisioned before existing nodes need to be made unavailable. The number of nodes that can be provisioned simultaneously during an upgrade is `max-surge` plus `max-unavailable`.
|
||||
|
||||
|--max-unavailable
|
||||
a|The `max-unavailable` parameter defines the number of nodes that can be made unavailable in a machine pool during an upgrade, before new nodes are provisioned. This can be an absolute number (for example, `2`) or a percentage of the current replica count in the machine pool (for example, `20%`), but must use the same unit as the `max-surge` parameter.
|
||||
|
||||
The default value is `0`, meaning that no outdated nodes are removed before new nodes are provisioned. The valid range for this value is from `0` to the current machine pool size, or from `0%` to `100%`. The total number of nodes that can be upgraded simultaneously during an upgrade is `max-surge` plus `max-unavailable`.
|
||||
|
||||
|
||||
|--node-drain-grace-period
|
||||
|Specifies the node drain grace period when upgrading or replacing the machine pool.
|
||||
endif::openshift-rosa-hcp[]
|
||||
|--replicas
|
||||
|Required when autoscaling is not configured. The number (integer) of machines for this machine pool.
|
||||
|
||||
|--taints
|
||||
|Taints for the machine pool. This string value should be formatted as a comma-separated list of `key=value:ScheduleType`. Editing this value only affect newly created nodes of the machine pool, which are created by increasing the node number, and does not affect the existing nodes. This list overwrites any modifications made to Node taints on an ongoing basis.
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--interactive
|
||||
|Enables interactive mode.
|
||||
|
||||
|--profile
|
||||
|Specifies an AWS profile (string) from your credentials file.
|
||||
|===
|
||||
|
||||
.Examples
|
||||
|
||||
Set 4 replicas on a machine pool named `mp1` on a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit machinepool --cluster=mycluster --replicas=4 mp1
|
||||
----
|
||||
|
||||
Enable autoscaling on a machine pool named `mp1` on a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit machinepool --cluster=mycluster --enable-autoscaling --min-replicas=3 --max-replicas=5 mp1
|
||||
----
|
||||
|
||||
Disable autoscaling on a machine pool named `mp1` on a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit machinepool --cluster=mycluster --enable-autoscaling=false --replicas=3 mp1
|
||||
----
|
||||
|
||||
Modify the autoscaling range on a machine pool named `mp1` on a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit machinepool --max-replicas=9 --cluster=mycluster mp1
|
||||
----
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
On {product-title} clusters, edit the `mp1` machine pool to add the following behavior during upgrades:
|
||||
* Allow up to 2 excess nodes to be provisioned during an upgrade.
|
||||
* Ensure that no more than 3 nodes are unavailable during an upgrade.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit machinepool --cluster=mycluster mp1 --max-surge=2 --max-unavailable=3
|
||||
----
|
||||
|
||||
Associate a `KubeletConfig` object with an existing `high-pid-pool` machine pool on a {product-title} cluster.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit machinepool -c mycluster --kubelet-configs=set-high-pids high-pid-pool
|
||||
----
|
||||
|
||||
[id="rosa-edit-mirror-set_{context}"]
|
||||
== edit mirror image configurations
|
||||
Edits the mirror lists in an existing mirror image configuration.
|
||||
[NOTE]
|
||||
====
|
||||
When editing image mirrors, the new mirrors list completely replaces the existing mirrors list.
|
||||
====
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit image-mirror [arguments]
|
||||
----
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster to which the ingress will be added.
|
||||
|
||||
|--mirrors
|
||||
|Required: New list of mirror registries that replaces current mirror registries. Mirror registries must be comma-separated.
|
||||
|
||||
|--id
|
||||
|Required: ID of the image mirror configuration to edit.
|
||||
|
||||
|--profile
|
||||
|Optional: Use a specific AWS profile from your credential file.
|
||||
|
||||
|--region
|
||||
|Optional: Use a specific AWS region, overriding the AWS_REGION environment variable.
|
||||
|===
|
||||
|
||||
.Examples
|
||||
|
||||
Replaces all mirrors.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit image-mirror --cluster=mycluster --id=abc123def456 \
|
||||
--mirrors=new-primary.company.com/team,new-secondary.company.com/team
|
||||
----
|
||||
|
||||
Replaces a single mirror.
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit image-mirror --cluster=mycluster --id=abc123def456 \
|
||||
--mirrors=single-mirror.company.com/team
|
||||
----
|
||||
|
||||
endif::openshift-rosa-hcp[]
|
||||
@@ -1,102 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * rosa_cli/rosa-manage-objects-cli.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="rosa-install-uninstall-addon_{context}"]
|
||||
= Install and uninstall add-ons
|
||||
|
||||
|
||||
This section describes how to install and uninstall Red{nbsp}Hat managed service add-ons to a cluster.
|
||||
|
||||
[id="rosa-install-addon_{context}"]
|
||||
== install addon
|
||||
|
||||
Installs a managed service add-on on a cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa install addon --cluster=<cluster_name> | <cluster_id> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster where the add-on will be installed.
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--profile
|
||||
|Uses a specific AWS profile (string) from your credentials file.
|
||||
|
||||
|--yes
|
||||
|Automatically answers `yes` to confirm the operation.
|
||||
|===
|
||||
|
||||
.Example
|
||||
Add the `dbaas-operator` add-on installation to a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa install addon --cluster=mycluster dbaas-operator
|
||||
----
|
||||
|
||||
[id="rosa-uninstall-addon_{context}"]
|
||||
== uninstall addon
|
||||
|
||||
Uninstalls a managed service add-on from a cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa uninstall addon --cluster=<cluster_name> | <cluster_id> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster that the add-on will be uninstalled from.
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--profile
|
||||
|Uses a specific AWS profile (string) from your credentials file.
|
||||
|
||||
|--yes
|
||||
|Automatically answers `yes` to confirm the operation.
|
||||
|===
|
||||
|
||||
.Example
|
||||
Remove the `dbaas-operator` add-on installation from a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa uninstall addon --cluster=mycluster dbaas-operator
|
||||
----
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,60 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * * rosa_cli/rosa-checking-logs-cli.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="rosa-logs-install_{context}"]
|
||||
= logs install
|
||||
|
||||
Show the cluster install logs by using the following command syntax:
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa logs install --cluster=<cluster_name> | <cluster_id> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster to get logs for.
|
||||
|
||||
|--tail
|
||||
|The number (integer) of lines to get from the end of the log. Default: `2000`
|
||||
|
||||
|--watch
|
||||
|Watches for changes after getting the logs.
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--profile
|
||||
|Specifies an AWS profile (string) from your credentials file.
|
||||
|===
|
||||
|
||||
.Examples
|
||||
Show the last 100 install log lines for a cluster named `mycluster`:
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa logs install mycluster --tail=100
|
||||
----
|
||||
|
||||
Show the install logs for a cluster named `mycluster`:
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa logs install --cluster=mycluster
|
||||
----
|
||||
@@ -1,52 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * * rosa_cli/rosa-checking-logs-cli.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="rosa-logs-uninstall_{context}"]
|
||||
= logs uninstall
|
||||
|
||||
Show the cluster uninstall logs by using the following command syntax:
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa logs uninstall --cluster=<cluster_name> | <cluster_id> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|The name or ID (string) of the cluster to get logs for.
|
||||
|
||||
|--tail
|
||||
|The number (integer) of lines to get from the end of the log. Default: `2000`
|
||||
|
||||
|--watch
|
||||
|Watches for changes after getting the logs.
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--profile
|
||||
|Specifies an AWS profile (string) from your credentials file.
|
||||
|===
|
||||
|
||||
.Example
|
||||
Show the last 100 uninstall logs for a cluster named `mycluster`:
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa logs uninstall --cluster=mycluster --tail=100
|
||||
----
|
||||
@@ -1,66 +0,0 @@
|
||||
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * rosa_cli/rosa-manage-objects-cli.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="rosa-parent-commands_{context}"]
|
||||
= Parent commands
|
||||
|
||||
|
||||
The {rosa-cli-first} uses parent commands with child commands to manage objects. The parent commands are `create`, `edit`, `delete`, `list`, and `describe`. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands.
|
||||
|
||||
[id="rosa-create_{context}"]
|
||||
== create
|
||||
|
||||
Creates an object or resource when paired with a child command.
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa create cluster --cluster-name=mycluster
|
||||
----
|
||||
|
||||
[id="rosa-edit_{context}"]
|
||||
== edit
|
||||
|
||||
Edits options for an object, such as making a cluster private.
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa edit cluster --cluster=mycluster --private
|
||||
----
|
||||
|
||||
[id="rosa-delete_{context}"]
|
||||
== delete
|
||||
|
||||
Deletes an object or resource when paired with a child command.
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete ingress --cluster=mycluster
|
||||
----
|
||||
|
||||
[id="rosa-list_{context}"]
|
||||
== list
|
||||
|
||||
Lists clusters or resources for a specific cluster.
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa list users --cluster=mycluster
|
||||
----
|
||||
|
||||
[id="rosa-describe_{context}"]
|
||||
== describe
|
||||
|
||||
Shows the details for a cluster.
|
||||
|
||||
.Example
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa describe cluster --cluster=mycluster
|
||||
----
|
||||
@@ -1,55 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * rosa_cli/rosa-manage-objects-cli.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="rosa-revoke-objects_{context}"]
|
||||
= Revoke objects
|
||||
|
||||
This section describes the `revoke` commands for clusters and resources.
|
||||
|
||||
[id="rosa-revoke-break-glass-credential_{context}"]
|
||||
== revoke-break-glass-credential
|
||||
|
||||
Revokes all break glass credentials from a specified {product-title} cluster with external authentication enabled.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa revoke break-glass-credential --cluster=<cluster_name> | <cluster_id>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster from which the break glass credentials will be deleted.
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--profile
|
||||
|Specifies an AWS profile (string) from your credentials file.
|
||||
|
||||
|--yes
|
||||
|Automatically answers `yes` to confirm the operation.
|
||||
|===
|
||||
|
||||
.Example
|
||||
Revoke the break glass credentials from a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa revoke break-glass-credential --cluster=mycluster
|
||||
----
|
||||
@@ -1,238 +0,0 @@
|
||||
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * rosa_cli/rosa-manage-objects-cli.adoc
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="rosa-upgrading-cluster_{context}"]
|
||||
= Upgrade and delete upgrade for objects
|
||||
|
||||
This section describes the `upgrade` command usage for objects.
|
||||
|
||||
[id="rosa-upgrade-cluster_{context}"]
|
||||
== upgrade cluster
|
||||
|
||||
Schedule a cluster upgrade.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster that the upgrade will be scheduled for.
|
||||
|
||||
|--interactive
|
||||
|Enables interactive mode.
|
||||
|
||||
|--version
|
||||
|The version (string) of OpenShift Container Platform that the cluster will be upgraded to.
|
||||
|
||||
|--schedule-date
|
||||
|The next date (string) when the upgrade will run at the specified time in Coordinated Universal Time (UTC). Format: `yyyy-mm-dd`
|
||||
|
||||
|--schedule-time
|
||||
|The next time the upgrade will run on the specified date in Coordinated Universal Time (UTC). Format: `HH:mm`
|
||||
ifdef::openshift-rosa[]
|
||||
|--node-drain-grace-period
|
||||
|Sets a grace period (string) for how long the pod disruption budget-protected workloads are respected during upgrades. After this grace period, any workloads protected by pod disruption budgets that have not been successfully drained from a node will be forcibly evicted. Default: `1 hour`
|
||||
endif::openshift-rosa[]
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
|--control-plane
|
||||
|Upgrades the cluster's hosted control plane.
|
||||
endif::openshift-rosa-hcp[]
|
||||
|===
|
||||
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|===
|
||||
|
||||
.Examples
|
||||
Interactively schedule an upgrade on a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa upgrade cluster --cluster=mycluster --interactive
|
||||
----
|
||||
|
||||
Schedule a cluster upgrade within the hour on a cluster named `mycluster`.
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa upgrade cluster --cluster=mycluster --version 4.5.20
|
||||
----
|
||||
|
||||
[id="rosa-delete-upgrade-cluster_{context}"]
|
||||
== delete cluster upgrade
|
||||
|
||||
Cancel a scheduled cluster upgrade.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete upgrade --cluster=<cluster_name> | <cluster_id>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster that the upgrade will be cancelled for.
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--yes
|
||||
|Automatically answers `yes` to confirm the operation.
|
||||
|===
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
[id="rosa-upgrade-machinepool_{context}"]
|
||||
== upgrade machinepool
|
||||
|
||||
Upgrades a specific machine pool configured on a {product-title} cluster.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa upgrade machinepool --cluster=<cluster_name> <machinepool_name>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster.
|
||||
|
||||
|--schedule-date
|
||||
|The next date (string) when the upgrade will run at the specified time in Coordinated Universal Time (UTC). Format: `yyyy-mm-dd`
|
||||
|
||||
|--schedule-time
|
||||
|The next time the upgrade will run on the specified date in Coordinated Universal Time (UTC). Format: `HH:mm`
|
||||
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--profile
|
||||
|Specifies an AWS profile (string) from your credentials file.
|
||||
|===
|
||||
|
||||
.Example
|
||||
Upgrade a machine pool on a cluster named `mycluster`.
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa upgrade machinepool --cluster=mycluster
|
||||
----
|
||||
|
||||
[id="rosa-delete-upgrade-machinepool_{context}"]
|
||||
== delete machinepool upgrade
|
||||
|
||||
Cancel a scheduled machinepool upgrade.
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa delete upgrade --cluster=<cluster_name> <machinepool_name>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster.
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--profile
|
||||
|Specifies an AWS profile (string) from your credentials file.
|
||||
|===
|
||||
endif::openshift-rosa-hcp[]
|
||||
//Per wgordon, rosa upgrade roles is not needed for HCP clusters
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
[id="rosa-upgrade-roles_{context}"]
|
||||
== upgrade roles
|
||||
Upgrades roles configured on a cluster.
|
||||
|
||||
|
||||
.Syntax
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa upgrade roles --cluster=<cluster_id>
|
||||
----
|
||||
|
||||
.Arguments
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--cluster
|
||||
|Required: The name or ID (string) of the cluster.
|
||||
|===
|
||||
|
||||
.Optional arguments inherited from parent commands
|
||||
[cols="30,70"]
|
||||
|===
|
||||
|Option |Definition
|
||||
|
||||
|--help
|
||||
|Shows help for this command.
|
||||
|
||||
|--debug
|
||||
|Enables debug mode.
|
||||
|
||||
|--profile
|
||||
|Specifies an AWS profile (string) from your credentials file.
|
||||
|===
|
||||
|
||||
.Example
|
||||
Upgrade roles on a cluster named `mycluster`.
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa upgrade roles --cluster=mycluster
|
||||
----
|
||||
endif::openshift-rosa-hcp[]
|
||||
@@ -33,5 +33,5 @@ include::modules/life-cycle-mandatory-upgrades.adoc[leveloffset=+1]
|
||||
include::modules/life-cycle-dates.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
* xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-edit-cluster_rosa-managing-objects-cli[edit cluster]
|
||||
* xref:../../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-cli-commands[ROSA CLI command reference]
|
||||
* xref:../../upgrading/rosa-hcp-upgrading.adoc#rosa-upgrade-options_rosa-hcp-upgrading[Upgrade options for {product-title} clusters]
|
||||
@@ -31,4 +31,4 @@ include::modules/life-cycle-mandatory-upgrades.adoc[leveloffset=+1]
|
||||
include::modules/life-cycle-dates.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
* xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-edit-cluster_rosa-managing-objects-cli[edit cluster]
|
||||
* xref:../../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-cli-commands[ROSA CLI command reference]
|
||||
@@ -58,7 +58,7 @@ include::modules/configuring-machine-pool-disk-volume-cli.adoc[leveloffset=+2]
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* For a detailed list of the arguments that are available for the `rosa create machinepool` subcommand, see xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[Managing objects with the {rosa-cli}].
|
||||
* The xref:../../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-create-machinepool[`rosa create machinepool` command] in the _ROSA CLI command reference_.
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
include::modules/deleting-machine-pools.adoc[leveloffset=+1]
|
||||
|
||||
@@ -91,8 +91,5 @@ endif::[]
|
||||
* xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.adoc#rosa-nodes-machinepools-about[About machinepools]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp[]
|
||||
* xref:../../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc#rosa-managing-worker-nodes[Managing compute nodes]
|
||||
// This xref can be included in ROSA HCP when all of the files are added.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
* xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[Managing objects with the ROSA CLI]
|
||||
endif::openshift-rosa-hcp[]
|
||||
* xref:../../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-cli-commands[ROSA CLI command reference]
|
||||
endif::[]
|
||||
|
||||
@@ -47,8 +47,8 @@ include::modules/rosa-hcp-sts-example-external-auth-provider.adoc[leveloffset=+2
|
||||
* link:https://learn.microsoft.com/en-us/entra/fundamentals/whatis[What is Microsoft Entra ID?] (Microsoft documentation)
|
||||
* xref:../cloud_experts_tutorials/cloud-experts-entra-id-idp.adoc#cloud-experts-entra-id-idp[Configuring Microsoft Entra ID (formerly Azure Active Directory) as an identity provider]
|
||||
* link:https://www.keycloak.org/guides[Keycloak documentaton]
|
||||
* For information about the similar `idps` tool in the ROSA CLI, see xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-idp_rosa-managing-objects-cli[`create idp`].
|
||||
* For more information about options in the ROSA CLI, see xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-external-auth-provider_rosa-managing-objects-cli[`create external-auth-provider`], xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-list-external-auth-provider_rosa-managing-objects-cli[`list external-auth-provider`], and xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-delete-external-auth-provider_rosa-managing-objects-cli[`delete external-auth-provider`].
|
||||
* For information about the similar `idps` tool in the ROSA CLI, see xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-create-idp[`rosa create idp`].
|
||||
* For more information about managing external authentication providers using the {rosa-cli}, see xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-create-external-auth-provider[`rosa create external-auth-provider`], xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-list-external-auth-providers[`rosa list external-auth-providers`], and xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-delete-external-auth-provider[`rosa delete external-auth-provider`] in the _ROSA CLI command reference_.
|
||||
|
||||
// Step 3: Create, list, and revoke a break glass credential
|
||||
include::modules/rosa-hcp-sts-creating-a-break-glass-cred-cli.adoc[leveloffset=+1]
|
||||
|
||||
@@ -54,7 +54,7 @@ include::modules/rosa-sts-creating-a-cluster-using-customizations.adoc[leveloffs
|
||||
include::modules/rosa-sts-creating-a-cluster-with-customizations-ocm.adoc[leveloffset=+2]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-cluster-command_rosa-managing-objects-cli[create cluster] in _Managing objects with the ROSA CLI_
|
||||
* xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-create-cluster[`rosa create cluster`] in the _ROSA CLI command reference_
|
||||
* 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]
|
||||
|
||||
include::modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc[leveloffset=+2]
|
||||
|
||||
@@ -40,6 +40,6 @@ include::modules/rosa-unlinking-and-deleting-ocm-and-user-iam-roles.adoc[levelof
|
||||
[id="additional-resources_rosa-sts-deleting-cluster"]
|
||||
== Additional resources
|
||||
|
||||
* For information about the cluster delete protection feature, see xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-edit-objects_rosa-managing-objects-cli[Edit objects].
|
||||
* For information about the cluster delete protection feature, see the xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-cli-commands[ROSA CLI command reference].
|
||||
* For information about the AWS IAM resources for ROSA clusters that use STS, see xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources].
|
||||
* For information on cluster errors that are due to missing IAM roles, see xref:../support/troubleshooting/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-cluster-deletion_rosa-troubleshooting-cluster-deployments[Repairing a cluster that cannot be deleted].
|
||||
|
||||
@@ -36,7 +36,7 @@ include::modules/rosa-hcp-ready-no-console-access.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* For more information about the `rosa describe machinepool` command, see xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-list-objects[List and describe objects].
|
||||
* For more information about the `rosa describe machinepool` command, see xref:../../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-describe-machinepool[`rosa describe machinepool`] in the _ROSA CLI command reference_.
|
||||
|
||||
include::modules/rosa-hcp-private-ready-no-console-access.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ toc::[]
|
||||
include::modules/rosa-hcp-upgrade-options.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
* xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-edit-machinepool_rosa-managing-objects-cli[ROSA CLI reference: `rosa edit machinepool`]
|
||||
* xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-edit-machinepool[ROSA CLI reference: `rosa edit machinepool`]
|
||||
* xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc#rosa-sdpolicy-node-lifecycle_rosa-service-definition[Node lifecycle]
|
||||
|
||||
//This cannot be a module if we want to use the xrefs
|
||||
|
||||
Reference in New Issue
Block a user