Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lightning delete cluster CLI command help text update #15760

Merged
merged 4 commits into from
Nov 22, 2022
Merged

lightning delete cluster CLI command help text update #15760

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f80b1e3
updated the lighting delete cluster CLI command help text output
rlizzo Nov 21, 2022
285a1c7
updated changelog
rlizzo Nov 21, 2022
ce19eec
typo fix
rlizzo Nov 21, 2022
97df64b
Apply suggestions from code review
Borda Nov 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/lightning_app/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
### Fixed

- Fixed debugging with VSCode IDE ([#15747](https://github.com/Lightning-AI/lightning/pull/15747))
- Updated inaccurate help text in the `lightning delete cluster` CLI command ([#15760](https://github.com/Lightning-AI/lightning/pull/15760))
Borda marked this conversation as resolved.
Show resolved Hide resolved


## [1.8.2] - 2022-11-17
Expand Down
18 changes: 10 additions & 8 deletions src/lightning_app/cli/lightning_cli_delete.py
View file
Open in desktop
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)