mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 21:46:22 +01:00
4050028f1a
Add comprehensive documentation for ROSA IAM service account commands in the correct ROSA-specific modules under cli_reference/rosa_cli/modules/: - rosa create iamserviceaccount - rosa delete iamserviceaccount - rosa list iamserviceaccounts - rosa describe iamserviceaccount Features documented include OIDC identity federation, role creation and management, policy attachment, and service account integration with OpenShift clusters. Uses consistent OpenShift terminology throughout. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
425 lines
8.3 KiB
Plaintext
425 lines
8.3 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * rosa_cli/rosa-manage-objects-cli.adoc
|
|
|
|
[id="rosa-delete-objects_{context}"]
|
|
= Delete objects
|
|
|
|
|
|
This section describes the `delete` commands for clusters and resources.
|
|
|
|
[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 to add to the identity provider (IDP).
|
|
|===
|
|
|
|
.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.
|
|
|===
|
|
|
|
.Example
|
|
Delete a cluster administrator from a cluster named `mycluster`.
|
|
|
|
[source,terminal]
|
|
----
|
|
$ rosa delete admin --cluster=mycluster
|
|
----
|
|
|
|
[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`.
|
|
|===
|
|
|
|
.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.
|
|
|
|
|--yes
|
|
|Automatically answers `yes` to confirm the operation.
|
|
|===
|
|
|
|
.Examples
|
|
Delete 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.
|
|
|===
|
|
|
|
.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.
|
|
|
|
|--yes
|
|
|Automatically answers `yes` to confirm the operation.
|
|
|===
|
|
|
|
.Example
|
|
Delete 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.
|
|
|===
|
|
|
|
.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.
|
|
|
|
|--yes
|
|
|Automatically answers `yes` to confirm the operation.
|
|
|===
|
|
|
|
.Example
|
|
Delete an identity provider named `github` from a cluster named `mycluster`.
|
|
|
|
[source,terminal]
|
|
----
|
|
$ rosa delete idp github --cluster=mycluster
|
|
----
|
|
|
|
[id="rosa-delete-iamserviceaccount_{context}"]
|
|
== delete iamserviceaccount
|
|
|
|
Deletes an AWS Identity and Access Management (IAM) role that was created for a {product-title} service account.
|
|
|
|
.Syntax
|
|
[source,terminal]
|
|
----
|
|
$ rosa delete iamserviceaccount --cluster=<cluster_name> | <cluster_id> [arguments]
|
|
----
|
|
|
|
.Arguments
|
|
[cols="30,70"]
|
|
|===
|
|
|Option |Definition
|
|
|
|
a|--cluster <cluster_name>\|<cluster_id>
|
|
|Required. The name or ID of the cluster from which to delete the IAM service account role.
|
|
|
|
|--name <service_account_name>
|
|
|The name of the {product-title} service account. Required when `--role-name` is not specified.
|
|
|
|
|--namespace <namespace_name>
|
|
|The {product-title} namespace for the service account. Default: `default`
|
|
|
|
|--role-name <role_name>
|
|
|The name of the IAM role to delete. If not specified, the role name will be auto-detected using the service account details.
|
|
|
|
a|-m, --mode string
|
|
a|How to perform the operation. Valid options are:
|
|
|
|
`auto`:: Resource changes will be automatically applied using the current AWS account.
|
|
`manual`:: Commands necessary to modify AWS resources will be output to be run manually.
|
|
|
|
|===
|
|
|
|
.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 from your credentials file.
|
|
|
|
|--yes
|
|
|Automatically answers `yes` to confirm the operation.
|
|
|
|
|===
|
|
|
|
.Examples
|
|
Delete an IAM role for a service account named `my-app` in the `default` namespace.
|
|
|
|
[source,terminal]
|
|
----
|
|
$ rosa delete iamserviceaccount --cluster=mycluster --name=my-app
|
|
----
|
|
|
|
Delete an IAM role by specifying the role name directly.
|
|
|
|
[source,terminal]
|
|
----
|
|
$ rosa delete iamserviceaccount --cluster=mycluster --role-name=my-custom-role --yes
|
|
----
|
|
|
|
[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.
|
|
|===
|
|
|
|
.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.
|
|
|
|
|--yes
|
|
|Automatically answers `yes` to confirm the operation.
|
|
|===
|
|
|
|
.Examples
|
|
Delete an ingress with the ID `a1b2` from a cluster named `mycluster`.
|
|
|
|
[source,terminal]
|
|
----
|
|
$ rosa delete ingress --cluster=mycluster a1b2
|
|
----
|
|
|
|
Delete 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
|
|
|
|
Delete 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.
|
|
|
|
|-h, --help
|
|
|Shows help for this command.
|
|
|
|
|--name
|
|
a|
|
|
ifdef::temp-ifdef[]
|
|
Optional.
|
|
endif::[]
|
|
ifdef::temp-ifdef[]
|
|
Required.
|
|
endif::[]
|
|
Specifies a name for the `KubeletConfig` object.
|
|
|
|
|-y, --yes
|
|
|Automatically answers `yes` to confirm the operation.
|
|
|
|
|===
|
|
|
|
|
|
[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.
|
|
|===
|
|
|
|
.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.
|
|
|
|
|--yes
|
|
|Automatically answers `yes` to confirm the operation.
|
|
|===
|
|
|
|
.Example
|
|
Delete the machine pool with the ID `mp-1` from a cluster named `mycluster`.
|
|
|
|
[source,terminal]
|
|
----
|
|
$ rosa delete machinepool --cluster=mycluster mp-1
|
|
----
|