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

Added docs for helm and plugin #1397

Merged
merged 14 commits into from
Oct 27, 2021
10 changes: 10 additions & 0 deletions rsts/deployment/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,15 @@ solution). The following pages will help you effectively deploy and manage an en

---

.. link-button:: deployment-plugin-setup
:type: ref
:text: Plugin Setup
:classes: btn-block stretched-link
^^^^^^^^^^^^
Plugin Setup guides with detailed instructions.
yindia marked this conversation as resolved.
Show resolved Hide resolved

---

.. link-button:: deployment-cluster-config
:type: ref
:text: Cluster Configuration
Expand All @@ -66,3 +75,4 @@ solution). The following pages will help you effectively deploy and manage an en
gcp/index
cluster_config/index
sandbox
plugin_setup/index
24 changes: 24 additions & 0 deletions rsts/deployment/plugin_setup/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _deployment-plugin-setup:

##############
Plugin Setup
##############


.. panels::
:header: text-center

.. link-button:: deployment-plugin-setup-mpi-operator
:type: ref
:text: MPI Plugin
:classes: btn-block stretched-link
^^^^^^^^^^^^
Guide to setting up MPI Plugin
yindia marked this conversation as resolved.
Show resolved Hide resolved


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

mpi_operator
76 changes: 76 additions & 0 deletions rsts/deployment/plugin_setup/mpi_operator.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
.. _deployment-plugin-setup-mpi-operator:
yindia marked this conversation as resolved.
Show resolved Hide resolved

MPI Operator Setup
------------------------

.. _mpi-operator:

####################################
Install MPI Operator
####################################

Clone Flytesnacks

.. code-block:: bash

git clone https://github.com/flyteorg/flytesnacks.git

Start the sandbox for testing

.. code-block:: bash

flytectl sandbox start --source=./flytesnacks

Clone MPI Operator

.. code-block:: bash

git clone https://github.com/kubeflow/mpi-operator.git

Install MPI Operator

.. code-block:: bash

kustomize build mpi-operator/manifests/overlays/kubeflow | kubectl apply --kubeconfig=~/.flyte/k3s/k3s.yaml -f -

Create a file values-mpi.yaml and add the below values

.. code-block::

configmap:
enabled_plugins:
# -- Tasks specific configuration [structure](https://pkg.go.dev/github.com/flyteorg/flytepropeller/pkg/controller/nodes/task/config#GetConfig)
tasks:
# -- Plugins configuration, [structure](https://pkg.go.dev/github.com/flyteorg/flytepropeller/pkg/controller/nodes/task/config#TaskPluginConfig)
task-plugins:
# -- [Enabled Plugins](https://pkg.go.dev/github.com/flyteorg/flyteplugins/go/tasks/config#Config). Enable sagemaker*, athena if you install the backend
# plugins
enabled-plugins:
- container
- sidecar
- k8s-array
- mpi
default-for-task-types:
container: container
sidecar: sidecar
container_array: k8s-array
mpi: mpi

Upgrade flyte helm release

.. code-block:: bash

helm upgrade -n flyte -f values-mpi.yaml flyteorg/flyte --kubeconfig=~/.flyte/k3s/k3s.yaml

Build & Serialize MPI plugin example

.. code-block:: bash

cd flytesnacks
flytectl sandbox exec -- make -C cookbook/integrations/kubernetes/kfmpi serialize

Register MPI plugin example

.. code-block:: bash

make -C cookbook/integrations/kubernetes/kfmpi register