From d35c29a4d7b215c716d99b280f6ff9f80e91a92e Mon Sep 17 00:00:00 2001 From: Helen Zhang <45017130+helenzhangyc@users.noreply.github.com> Date: Thu, 28 Sep 2023 12:24:50 -0700 Subject: [PATCH] move memverge doc (#4085) Signed-off-by: helenzhangyc Signed-off-by: Helen Zhang <45017130+helenzhangyc@users.noreply.github.com> --- rsts/conf.py | 8 +- rsts/deployment/agents/bigquery.rst | 1 + rsts/deployment/agents/index.rst | 12 +++ rsts/deployment/agents/mmcloud.rst | 119 ++++++++++++++++++++++++++++ 4 files changed, 137 insertions(+), 3 deletions(-) create mode 100644 rsts/deployment/agents/mmcloud.rst diff --git a/rsts/conf.py b/rsts/conf.py index b060eaf6e5..83034d4dce 100644 --- a/rsts/conf.py +++ b/rsts/conf.py @@ -94,7 +94,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -130,8 +130,10 @@ "github_username": "flyteorg", "github_commit": "master", "docs_path": "rsts", # path to documentation source - "sphinx_gallery_src_dir": "cookbook", # path to directory of sphinx gallery source files relative to repo root - "sphinx_gallery_dest_dir": "auto", # path to root directory containing auto-generated sphinx gallery examples + # path to directory of sphinx gallery source files relative to repo root + "sphinx_gallery_src_dir": "cookbook", + # path to root directory containing auto-generated sphinx gallery examples + "sphinx_gallery_dest_dir": "auto", } # Theme options are theme-specific and customize the look and feel of a theme diff --git a/rsts/deployment/agents/bigquery.rst b/rsts/deployment/agents/bigquery.rst index ca2b704986..cf01e0b7bd 100644 --- a/rsts/deployment/agents/bigquery.rst +++ b/rsts/deployment/agents/bigquery.rst @@ -87,4 +87,5 @@ Upgrade the Flyte Helm release helm upgrade flyte/flyte-core -n --values values-override.yaml Replace ```` with the name of your release (e.g., ``flyte``) + and ```` with the name of your namespace (e.g., ``flyte``). diff --git a/rsts/deployment/agents/index.rst b/rsts/deployment/agents/index.rst index 57232864a7..2ca04c8852 100644 --- a/rsts/deployment/agents/index.rst +++ b/rsts/deployment/agents/index.rst @@ -18,9 +18,21 @@ Discover the process of setting up Agents for Flyte. ^^^^^^^^^^^^ Guide to setting up the Bigquery agent. + --- + + .. link-button:: deployment-agent-setup-mmcloud + :type: ref + :text: MMCloud Agent + :classes: btn-block stretched-link + ^^^^^^^^^^^^ + Guide to setting up the MMCloud agent. + + .. toctree:: :maxdepth: 1 :name: Agent setup :hidden: bigquery + mmcloud + diff --git a/rsts/deployment/agents/mmcloud.rst b/rsts/deployment/agents/mmcloud.rst new file mode 100644 index 0000000000..1e36ff7cfc --- /dev/null +++ b/rsts/deployment/agents/mmcloud.rst @@ -0,0 +1,119 @@ +.. _deployment-agent-setup-mmcloud: + +MMCloud Agent +================= + +MemVerge Memory Machine Cloud (MMCloud) empowers users to continuously optimize cloud resources during runtime, +safely execute stateful tasks on spot instances, +and monitor resource usage in real time. +These capabilities make it an excellent fit for long-running batch workloads. + +This guide provides an overview of how to set up MMCloud in your Flyte deployment. + +Set up MMCloud +-------------- + +To run a Flyte workflow with Memory Machine Cloud, you will need to deploy Memory Machine Cloud. +Check out the `MMCloud User Guide `_ to get started! + +By the end of this step, you should have deployed an MMCloud OpCenter. + +Spin up a cluster +----------------- + +.. tabs:: + + .. group-tab:: Flyte binary + + You can spin up a demo cluster using the following command: + + .. code-block:: bash + + flytectl demo start + + Or install Flyte using the :ref:`flyte-binary helm chart `. + + .. group-tab:: Flyte core + + If you've installed Flyte using the + `flyte-core helm chart `__, please ensure: + + * You have the correct kubeconfig and have selected the correct Kubernetes context. + * You have configured the correct flytectl settings in ``~/.flyte/config.yaml``. + +.. note:: + + Add the Flyte chart repo to Helm if you're installing via the Helm charts. + + .. code-block:: bash + + helm repo add flyteorg https://flyteorg.github.io/flyte + +Specify agent configuration +---------------------------- + +Enable the MMCloud agent by adding the following config to the relevant YAML file(s): + +.. code-block:: yaml + + tasks: + task-agents: + enabled-agents: + - agent-service + default-for-task-types: + - mmcloud_task: agent-service + +.. code-block:: yaml + + agents: + agent-service: + agents: + mmcloud-agent: + endpoint: + insecure: true + supportedTaskTypes: + - mmcloud_task + agentForTaskTypes: + - mmcloud_task: mmcloud-agent + +Substitute ```` with the endpoint of your MMCloud agent. + +Upgrade the deployment +---------------------- + +.. tabs:: + + .. group-tab:: Flyte binary + + .. tabs:: + + .. group-tab:: Demo cluster + + .. code-block:: bash + + kubectl rollout restart deployment flyte-sandbox -n flyte + + .. group-tab:: Helm chart + + .. code-block:: bash + + helm upgrade flyteorg/flyte-binary -n --values + + Replace ```` with the name of your release (e.g., ``flyte-backend``), + ```` with the name of your namespace (e.g., ``flyte``), + and ```` with the name of your YAML file. + + .. group-tab:: Flyte core + + .. code-block:: + + helm upgrade flyte/flyte-core -n --values values-override.yaml + + Replace ```` with the name of your release (e.g., ``flyte``) + and ```` with the name of your namespace (e.g., ``flyte``). + +Wait for the upgrade to complete. You can check the status of the deployment pods by running the following command: + +.. code-block:: + + kubectl get pods -n flyte