Skip to content

Fixes note formatting and more #14264

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

Merged
merged 1 commit into from
Aug 18, 2022
Merged

Fixes note formatting and more #14264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 10 additions & 4 deletions docs/source-app/workflows/byoc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,21 @@ Here's an example:

lightning create cluster my-byoc-cluster --provider aws --role-arn arn:aws:iam::1234567890:role/lai-byoc --external-id dummy --region us-west-2 --instance-types t3.xlarge --enable-performance

..note:: Cluster creation is going to take an hour or more after you run this command.
.. note:: Cluster creation is going to take an hour or more after you run this command.

**Arguments**
----

Arguments
^^^^^^^^^

* cluster_name: The name of the cluster to be created

.. note:: Cluster names can only contain lowercase letters, numbers, and periodic hyphens ( - ).

**Parameters:**
----

Parameters
^^^^^^^^^^

+------------------------+----------------------------------------------------------------------------------------------------+
|Parameter | Descritption |
Expand Down Expand Up @@ -104,7 +110,7 @@ Delete a Lightning BYOC cluster

Deletes a Lightning BYOC cluster. Lightning AI removes cluster artifacts and any resources running on the cluster.

.. warning:: Using the --force parameter when deleting a cluster does not clean up any resources managed by Lightning AI. Check your cloud provider to verify that existing cloud resources are deleted.
.. warning:: Using the ``--force`` parameter when deleting a cluster does not clean up any resources managed by Lightning AI. Check your cloud provider to verify that existing cloud resources are deleted.

Deletion permanently removes not only the record of all runs on a cluster, but all associated artifacts, metrics, logs, etc.

Expand Down