Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixes note formatting and more (#14264) 

Fixes formatting for a note and makes headings for arguments and parameters stand out
This commit is contained in:
Laverne Henderson 2022-08-18 04:55:49 -07:00 committed by GitHub
parent caa0d594b1
commit 8ab65ffade
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source-app/workflows/byoc/index.rst
View File

@ -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 |
@ -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.