1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/modules/rosa-delete-objects.adoc

262 lines
4.6 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.
|===
.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-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-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
----