diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index 98a9eda0..d5c68ff1 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -38,6 +38,7 @@ Upgrading :maxdepth: 1 migrate-v1-v2 + migrate-v21-v215 Managing -------- diff --git a/docs/how-to/migrate-v21-v215.rst b/docs/how-to/migrate-v21-v215.rst new file mode 100644 index 00000000..4f34b29d --- /dev/null +++ b/docs/how-to/migrate-v21-v215.rst @@ -0,0 +1,51 @@ +Upgrade Charmed MLflow 2.1 to 2.15 +================================================== + +This guide describes how to upgrade Charmed MLflow version 2.1 to 2.15. + +Prerequisites +------------- + +This guide assumes: + +* You have deployed MLflow version 2.11. +* You have Command Line Interface (CLI) access to the machine where the Juju controller is deployed. All commands in this guide are executed from it. + +.. tip:: + Before proceeding, you might want to backup MinIO data including your experiments and models. See :ref:`backup` for more details. + +Upgrade dependencies +--------------------- + +Charmed MLflow 2.15 requires: + +1. `MicroK8s `_ version 1.29 or higher. +2. `Juju `_ version 3.4. + +If you do not meet these requirements, please upgrade these dependencies. +See `MicroK8s upgrade `_ +and `Juju upgrade `_ respectively for more details. + +Upgrade MLflow bundle +---------------------- + +To upgrade the MLflow bundle charms from 2.11 to 2.15, run the following commands: + +.. code-block:: bash + + juju refresh mlflow-minio --channel=ckf-1.9/stable + juju refresh mlflow-server --channel=2.15/stable + +Upgrade resource dispatcher +-------------------------------------- + +Only if you are running MLflow within Kubeflow, you must upgrade your `resource dispatcher `_ deployment. + +.. note:: + MLflow 2.15 works only with resource dispatcher version 2.0/stable. + +To upgrade your resource dispatcher, do the following: + +.. code-block:: bash + + juju refresh resource-dispatcher --channel=2.0/stable diff --git a/docs/reuse/links.txt b/docs/reuse/links.txt index a26a00f8..fa7aee65 100644 --- a/docs/reuse/links.txt +++ b/docs/reuse/links.txt @@ -12,3 +12,9 @@ .. _configured: https://rclone.org/s3/#configuration .. _yq binary: https://snapcraft.io/yq .. _Create a backup: https://charmhub.io/mysql-k8s/docs/h-create-and-list-backups + +.. _MicroK8s: https://microk8s.io/ + + + +