Skip to content

Commit 6113283

Browse files
Felonious-Spellfirepre-commit-ci[bot]tchatonnicolai86awaelchli
authored
Docs BYOC content (#13976)
* BYOC content Content for the upcoming BYOC feature * First DRAFT of BYOC content * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update docs/source-app/index.rst Co-authored-by: thomas chaton <[email protected]> * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: thomas chaton <[email protected]> * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: thomas chaton <[email protected]> * Updates based on feedback * Updates based on feedback * Update external ID with note * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: Raphael Randschau <[email protected]> * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: Raphael Randschau <[email protected]> * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: Raphael Randschau <[email protected]> * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: Raphael Randschau <[email protected]> * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: Raphael Randschau <[email protected]> * Updates for terraform mod Updates for terraform mod and arg pram split * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: Adrian Wälchli <[email protected]> * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: Adrian Wälchli <[email protected]> * Update index.rst * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: Adrian Wälchli <[email protected]> * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: Adrian Wälchli <[email protected]> * Update docs/source-app/workflows/byoc/index.rst Co-authored-by: Adrian Wälchli <[email protected]> * Update content with table Changed bullets into table based on feedback * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: thomas chaton <[email protected]> Co-authored-by: Raphael Randschau <[email protected]> Co-authored-by: Adrian Wälchli <[email protected]>
1 parent fcf9b42 commit 6113283

File tree

2 files changed

+116
-0
lines changed

2 files changed

+116
-0
lines changed

‎docs/source-app/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@ Keep Learning
227227
Publish a Lightning component <workflows/build_lightning_component/publish_a_component>
228228
Run a server within a Lightning App <workflows/add_server/index>
229229
Run an App on the cloud <workflows/run_app_on_cloud/index>
230+
Run Apps on your cloud account (BYOC) <workflows/byoc/index>
230231
Run work in parallel <workflows/run_work_in_parallel>
231232
Share an app <workflows/share_app>
232233
Share files between components <workflows/share_files_between_components>

‎docs/source-app/workflows/byoc/index.rst‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
2+
#################################
3+
Run Apps on your own cloud (BYOC)
4+
#################################
5+
6+
**Audience:** Users looking to run Lightning Apps on their own private cloud.
7+
8+
----
9+
10+
*******************
11+
A bit of background
12+
*******************
13+
14+
BYOC - Bring Your Own Cloud, is an alternate deployment model to Lightning Cloud (fully managed SaaS).
15+
BYOC separates the control and data plane. The data plane, that includes
16+
Lightning clusters, services and Lightning Apps, reside inside the user’s VPC.
17+
The control plane resides on Lightning Cloud.
18+
19+
Setup begins with configuring a cloud provider (today AWS, but more are coming soon) with your personal credentials for
20+
delegated access and an identity provider for secure access to the data plane.
21+
22+
Next, as part of the environment creation process, you can configure networking,
23+
security, and select among cluster configuration options based on their own use cases.
24+
25+
After submitting a cluster creation request, the Lightning Control Plane creates the required cloud infrastructure on the user account. This
26+
sets up a new Lightning Cluster along with a Lightning Kubernetes Operator.
27+
28+
29+
*******************************
30+
Create a Lightning BYOC cluster
31+
*******************************
32+
33+
You must have your cloud configured before you try and create a BYOC cluster.
34+
35+
And to make your life a little easier, we've made a `Terraform module to help with that <https://github.com/Lightning-AI/terraform-aws-lightning-byoc>`_.
36+
37+
Create a Lightning BYOC cluster using the following command:
38+
39+
.. code:: bash
40+
41+
lightning create cluster <cluster-name> <cloud-provider-parameters>
42+
43+
Here's an example:
44+
45+
.. code:: bash
46+
47+
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
48+
49+
..note:: Cluster creation is going to take an hour or more after you run this command.
50+
51+
**Arguments**
52+
53+
* cluster_name: The name of the cluster to be created
54+
55+
.. note:: Cluster names can only contain lowercase letters, numbers, and periodic hyphens ( - ).
56+
57+
**Parameters:**
58+
59+
+------------------------+----------------------------------------------------------------------------------------------------+
60+
|Parameter | Descritption |
61+
+========================+====================================================================================================+
62+
| provider | The cloud provider where your cluster is located. |
63+
| | |
64+
| | AWS is supported today, but support for other cloud providers is coming soon. |
65+
+------------------------+----------------------------------------------------------------------------------------------------+
66+
| role-arn | AWS IAM Role ARN used to provision resources |
67+
+------------------------+----------------------------------------------------------------------------------------------------+
68+
| external-id | AWS IAM Role external ID |
69+
| | |
70+
| | To read more on what the AWS external ID is and why it's useful go |
71+
| | `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html>`_|
72+
+------------------------+----------------------------------------------------------------------------------------------------+
73+
| region | AWS region containing compute resources |
74+
+------------------------+----------------------------------------------------------------------------------------------------+
75+
| instance-types | Instance types that you want to support, for computer jobs within the cluster. |
76+
| | |
77+
| | For now, this is the AWS instance types supported by the cluster. |
78+
+------------------------+----------------------------------------------------------------------------------------------------+
79+
| enable-performance | Specifies if the cluster uses cost savings mode. |
80+
| | |
81+
| | In cost saving mode the number of compute nodes is reduced to one, reducing the cost for clusters |
82+
| | with low utilization. |
83+
+------------------------+----------------------------------------------------------------------------------------------------+
84+
| edit-before-creation | Enables interactive editing of requests before submitting it to Lightning AI. |
85+
+------------------------+----------------------------------------------------------------------------------------------------+
86+
| wait | Waits for the cluster to be in a RUNNING state. Only use this for debugging. |
87+
+------------------------+----------------------------------------------------------------------------------------------------+
88+
89+
----
90+
91+
*******************************************
92+
View a list of your Lightning BYOC clusters
93+
*******************************************
94+
95+
.. code:: bash
96+
97+
lightning list clusters
98+
99+
----
100+
101+
*******************************
102+
Delete a Lightning BYOC cluster
103+
*******************************
104+
105+
Deletes a Lightning BYOC cluster. Lightning AI removes cluster artifacts and any resources running on the cluster.
106+
107+
.. 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.
108+
109+
Deletion permanently removes not only the record of all runs on a cluster, but all associated artifacts, metrics, logs, etc.
110+
111+
.. 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. All object stores, container registries, logs, compute nodes, volumes, etc. are deleted and cannot be recovered.
112+
113+
.. code:: bash
114+
115+
lightning delete cluster <cluster-name>

0 commit comments

Comments
 (0)