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.

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

Refactor plugin docs #1756

Merged
merged 4 commits into from
Nov 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 5 additions & 27 deletions rsts/deployment/plugin_setup/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,38 +8,16 @@ Plugin Setup
.. panels::
:header: text-center


.. link-button:: deployment-plugin-setup-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-pytorch-operator
.. link-button:: deployment-plugin-setup-k8s
:type: ref
:text: PyTorch Operator
:text: K8s Plugin
:classes: btn-block stretched-link
^^^^^^^^^^^^
Guide to setting up the Kubeflow PyTorch Operator Plugin.

---

.. link-button:: deployment-plugin-setup-spark-operator
:type: ref
:text: Spark Operator
:classes: btn-block stretched-link
^^^^^^^^^^^^
Guide to setting up the Spark Operator Plugin.

Guide to setting up the K8s Operator Plugins.

.. toctree::
:maxdepth: 1
:name: Plugin Setup
:name: K8s Plugin
:hidden:

mpi_operator
pytorch_operator
spark_operator
k8s/index
47 changes: 47 additions & 0 deletions rsts/deployment/plugin_setup/k8s/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.. _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.

---

.. link-button:: deployment-plugin-setup-k8s-spark-operator
:type: ref
:text: Spark Operator
:classes: btn-block stretched-link
^^^^^^^^^^^^
Guide to setting up the Spark Operator Plugin.


.. toctree::
:maxdepth: 1
:name: K8S Plugin Setup
:hidden:

mpi_operator
pytorch_operator
spark_operator


Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _deployment-plugin-setup-mpi-operator:
.. _deployment-plugin-setup-k8s-mpi-operator:

Kubeflow MPI Operator Plugin Setup
----------------------------------
Expand All @@ -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:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _deployment-plugin-setup-pytorch-operator:
.. _deployment-plugin-setup-k8s-pytorch-operator:

Kubeflow PyTorch Operator Plugin Setup
--------------------------------------
Expand All @@ -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=$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 -

4. Create a file named ``values-pytorch.yaml`` and add the following config to it:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _deployment-plugin-setup-spark-operator:
.. _deployment-plugin-setup-k8s-spark-operator:

Kubeflow Spark Operator Plugin Setup
------------------------------------
Expand Down