Skip to content

Commit

Permalink
lightning delete cluster CLI command help text update (#15760)
Browse files Browse the repository at this point in the history
* updated the lighting delete cluster CLI command help text output
* updated changelog
* typo fix
* Apply suggestions from code review

Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
  • Loading branch information
rlizzo and Borda committed Nov 22, 2022
1 parent 1a07a9c commit 75b0573
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions src/lightning_app/cli/lightning_cli_delete.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,19 @@ def delete() -> None:
help="Enabling this flag makes the CLI wait until the cluster is deleted.",
)
def delete_cluster(cluster: str, force: bool = False, wait: bool = False) -> None:
"""Delete a Lightning AI BYOC compute cluster and all associated cloud provider resources.
"""Delete a Lightning AI BYOC cluster and all associated cloud provider resources.
Deleting a run also deletes all Runs and Experiments that were started on the cluster.
Deletion permanently removes not only the record of all runs on a cluster, but all associated experiments,
artifacts, metrics, logs, etc.
Deleting a cluster also deletes all apps that were started on the cluster.
Deletion permanently removes not only the record of all apps run on a cluster,
but all associated data, artifacts, metrics, logs, web-UIs, etc.
WARNING: This process may take a few minutes to complete, but once started it CANNOT be rolled back.
Deletion permanently removes not only the BYOC cluster from being managed by Lightning AI, but tears down
every BYOC resource Lightning AI managed (for that cluster id) in the host cloud.
WARNING: This process may take a few minutes to complete, but once started it
CANNOT be rolled back. Deletion tears down every cloud provider resource
managed by Lightning AI and permanently revokes the ability for Lightning AI
to create, manage, or access any resources within the host cloud account.
All object stores, container registries, logs, compute nodes, volumes, etc. are deleted and cannot be recovered.
All object stores, container registries, logs, compute nodes, volumes,
VPC components, etc. are irreversibly deleted and cannot be recovered!
"""
cluster_manager = AWSClusterManager()
cluster_manager.delete(cluster_id=cluster, force=force, wait=wait)

0 comments on commit 75b0573

Please sign in to comment.