mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
03ca7d7f80
Squashed: 1 - Intial commit for the ROSA with HCP branch 2 - Adding the Upgrading HCP cherrypick 3 - Adding the Security HCP cherrypick 4 - Upgrading ROSA with HCP updates 5 - Updated the HCP migration to include the ROSA Tutorals and Learning sections 6 - Updated the HCP migration to add the rest of the books from the password protected preview 7 - Repaired the links in Introduction to ROSA book 8 - classic to hcp migration topic maps update commented in the end of section in topic map applied QE suggestions from gdoc applied more QE suggestions from gdoc applied conditions for new hcp distro to assemblies and modules fixed typo on line 13 of configuring registry operator replaced namespace as suggested by QE removed operator pod list removed space in rosa topic maps removed spacing in line 39 of checking status of pods
352 lines
6.5 KiB
Plaintext
352 lines
6.5 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-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
|
|
----
|