From d7a3e6d03252f85292f913f6e5eef29850b04e6d Mon Sep 17 00:00:00 2001 From: Yuvraj Date: Thu, 28 Oct 2021 14:30:32 +0530 Subject: [PATCH 1/3] Refactor plugin docs Signed-off-by: Yuvraj --- rsts/deployment/plugin_setup/index.rst | 21 +++-------- rsts/deployment/plugin_setup/k8s/index.rst | 36 +++++++++++++++++++ .../plugin_setup/{ => k8s}/mpi_operator.rst | 6 ++-- .../{ => k8s}/pytorch_operator.rst | 8 +++-- 4 files changed, 50 insertions(+), 21 deletions(-) create mode 100644 rsts/deployment/plugin_setup/k8s/index.rst rename rsts/deployment/plugin_setup/{ => k8s}/mpi_operator.rst (94%) rename rsts/deployment/plugin_setup/{ => k8s}/pytorch_operator.rst (90%) diff --git a/rsts/deployment/plugin_setup/index.rst b/rsts/deployment/plugin_setup/index.rst index b5532b62d3..399067f847 100644 --- a/rsts/deployment/plugin_setup/index.rst +++ b/rsts/deployment/plugin_setup/index.rst @@ -9,28 +9,17 @@ Plugin Setup :header: text-center - .. link-button:: deployment-plugin-setup-mpi-operator + .. link-button:: deployment-plugin-setup-k8s :type: ref - :text: MPI Plugin + :text: K8s Plugin :classes: btn-block stretched-link ^^^^^^^^^^^^ - Guide to setting up the Kubeflow MPI Operator Plugin. - - --- - - .. link-button:: deployment-plugin-setup-pytorch-operator - :type: ref - :text: PyTorch Operator - :classes: btn-block stretched-link - ^^^^^^^^^^^^ - Guide to setting up the Kubeflow PyTorch Operator Plugin. - + Guide to setting up the K8s Operator Plugin. .. toctree:: :maxdepth: 1 - :name: Plugin Setup + :name: K8s Plugin :hidden: - mpi_operator - pytorch_operator + k8s/index diff --git a/rsts/deployment/plugin_setup/k8s/index.rst b/rsts/deployment/plugin_setup/k8s/index.rst new file mode 100644 index 0000000000..f629a2c1b7 --- /dev/null +++ b/rsts/deployment/plugin_setup/k8s/index.rst @@ -0,0 +1,36 @@ +.. _deployment-plugin-setup-k8s: + +################ +K8s Plugin Setup +################ + + +.. panels:: + :header: text-center + + + .. link-button:: deployment-plugin-setup-k8s-mpi-operator + :type: ref + :text: MPI Operator + :classes: btn-block stretched-link + ^^^^^^^^^^^^ + Guide to setting up the Kubeflow MPI Operator Plugin. + + --- + + .. link-button:: deployment-plugin-setup-k8s-pytorch-operator + :type: ref + :text: PyTorch Operator + :classes: btn-block stretched-link + ^^^^^^^^^^^^ + Guide to setting up the Kubeflow PyTorch Operator Plugin. + + + +.. toctree:: + :maxdepth: 1 + :name: K8S Plugin Setup + :hidden: + + mpi_operator + pytorch_operator diff --git a/rsts/deployment/plugin_setup/mpi_operator.rst b/rsts/deployment/plugin_setup/k8s/mpi_operator.rst similarity index 94% rename from rsts/deployment/plugin_setup/mpi_operator.rst rename to rsts/deployment/plugin_setup/k8s/mpi_operator.rst index 41993e40cf..d3a7820c62 100644 --- a/rsts/deployment/plugin_setup/mpi_operator.rst +++ b/rsts/deployment/plugin_setup/k8s/mpi_operator.rst @@ -1,4 +1,4 @@ -.. _deployment-plugin-setup-mpi-operator: +.. _deployment-plugin-setup-k8s-mpi-operator: Kubeflow MPI Operator Plugin Setup ---------------------------------- @@ -17,13 +17,15 @@ This guide gives an overview of how to set up the Kubeflow MPI operator in your // NOTE: MPI plugin is only available in v0.18.0+ flyte release. flytectl sandbox start --source=./flytesnacks + flytectl config init 3. Install the MPI Operator. .. code-block:: bash + export KUBECONFIG=$KUBECONFIG:~/.kube/config:~/.flyte/k3s/k3s.yaml git clone https://github.com/kubeflow/mpi-operator.git - kustomize build mpi-operator/manifests/overlays/kubeflow | kubectl apply --kubeconfig=~/.flyte/k3s/k3s.yaml -f - + kustomize build mpi-operator/manifests/overlays/kubeflow | kubectl apply -f - 4. Create a file named ``values-mpi.yaml`` and add the following config to it: diff --git a/rsts/deployment/plugin_setup/pytorch_operator.rst b/rsts/deployment/plugin_setup/k8s/pytorch_operator.rst similarity index 90% rename from rsts/deployment/plugin_setup/pytorch_operator.rst rename to rsts/deployment/plugin_setup/k8s/pytorch_operator.rst index 81f5c924c4..f38691378e 100644 --- a/rsts/deployment/plugin_setup/pytorch_operator.rst +++ b/rsts/deployment/plugin_setup/k8s/pytorch_operator.rst @@ -1,4 +1,4 @@ -.. _deployment-plugin-setup-pytorch-operator: +.. _deployment-plugin-setup-k8s-pytorch-operator: Kubeflow PyTorch Operator Plugin Setup -------------------------------------- @@ -16,13 +16,15 @@ This guide gives an overview of how to set up the PyTorch operator in your Flyte .. code-block:: bash flytectl sandbox start --source=./flytesnacks + flytectl config init 3. Install the PyTorch Operator. .. code-block:: bash - helm repo add bitnami https://charts.bitnami.com/bitnami --kubeconfig=~/.flyte/k3s/k3s.yaml - helm install my-release bitnami/pytorch + export KUBECONFIG=~/.flyte/k3s/k3s.yaml + git clone https://github.com/kubeflow/pytorch-operator.git + kustomize build pytorch-operator/manifests/overlays/kubeflow | kubectl apply -f - 4. Create a file named ``values-pytorch.yaml`` and add the following config to it: From 0d911b65029a836fe59c85979f28814d311e4c61 Mon Sep 17 00:00:00 2001 From: Yuvraj Date: Fri, 29 Oct 2021 22:10:13 +0530 Subject: [PATCH 2/3] More changes Signed-off-by: Yuvraj --- rsts/deployment/plugin_setup/k8s/pytorch_operator.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rsts/deployment/plugin_setup/k8s/pytorch_operator.rst b/rsts/deployment/plugin_setup/k8s/pytorch_operator.rst index f38691378e..19de3d64ed 100644 --- a/rsts/deployment/plugin_setup/k8s/pytorch_operator.rst +++ b/rsts/deployment/plugin_setup/k8s/pytorch_operator.rst @@ -22,7 +22,7 @@ This guide gives an overview of how to set up the PyTorch operator in your Flyte .. code-block:: bash - export KUBECONFIG=~/.flyte/k3s/k3s.yaml + export KUBECONFIG=$KUBECONFIG:~/.kube/config:~/.flyte/k3s/k3s.yaml git clone https://github.com/kubeflow/pytorch-operator.git kustomize build pytorch-operator/manifests/overlays/kubeflow | kubectl apply -f - From 73e75bc03e61f10bbaf1447abe0c53d2a26a5cad Mon Sep 17 00:00:00 2001 From: Yuvraj Date: Sun, 31 Oct 2021 16:42:57 +0530 Subject: [PATCH 3/3] Update rsts/deployment/plugin_setup/index.rst Co-authored-by: Samhita Alla Signed-off-by: Yuvraj --- rsts/deployment/plugin_setup/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rsts/deployment/plugin_setup/index.rst b/rsts/deployment/plugin_setup/index.rst index 399067f847..48fb7c3f52 100644 --- a/rsts/deployment/plugin_setup/index.rst +++ b/rsts/deployment/plugin_setup/index.rst @@ -14,7 +14,7 @@ Plugin Setup :text: K8s Plugin :classes: btn-block stretched-link ^^^^^^^^^^^^ - Guide to setting up the K8s Operator Plugin. + Guide to setting up the K8s Operator Plugins. .. toctree::