From 317daba74c37f879298fd44b7a5733444afc29be Mon Sep 17 00:00:00 2001 From: misohu Date: Thu, 15 Aug 2024 09:18:40 +0200 Subject: [PATCH 1/9] Upgrade guide for 2.15 --- docs/how-to/index.rst | 1 + docs/how-to/migrate-v21-v215.rst | 30 ++++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 docs/how-to/migrate-v21-v215.rst 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..ace13c1b --- /dev/null +++ b/docs/how-to/migrate-v21-v215.rst @@ -0,0 +1,30 @@ +Migrate Charmed MLflow Version 2.1 to Version 2.15 +================================================== + +This guide shows how to migrate Charmed MLflow version 2.1 to version 2.15. This guide assumes you are running the old Charmed MLflow stack version 2.11. + +Prerequisites +------------- + +This guide assumes the following: + +#. You have deployed MLflow version 2.11. +#. You have a CLI access to the machine where the Juju controller is deployed (all commands will be executed from there). + +Backup data (Optional) +---------------------- + +Although the process of upgrading MLflow 2.11 to 2.15 should be seamless you might still want to backup your MinIO data with your experiments and models. You can find all the details in the :ref:`backup` how to guide. + +.. note:: We don't have to backup the MySQL data as we are stil using the same version `8.0/stable` in both versions of MLflow. + +Update MLflow bundle +-------------------- + +To update MLflow bundle components from 2.11 to 2.15 please run these commands. + +.. code-block:: bash + + juju refresh mlflow-minio --channel=ckf-1.9/stable --trust + juju refresh mlflow-mysql --channel=8.0/stable --trust + juju refresh mlflow-server --channel=2.15/stable --trust \ No newline at end of file From 18cd6712ba6cdbd671d94c5a2ef9e13ffb20a53f Mon Sep 17 00:00:00 2001 From: misohu Date: Thu, 15 Aug 2024 09:20:25 +0200 Subject: [PATCH 2/9] Upgrade guide for 2.15 --- docs/how-to/migrate-v21-v215.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to/migrate-v21-v215.rst b/docs/how-to/migrate-v21-v215.rst index ace13c1b..f7651234 100644 --- a/docs/how-to/migrate-v21-v215.rst +++ b/docs/how-to/migrate-v21-v215.rst @@ -16,7 +16,7 @@ Backup data (Optional) Although the process of upgrading MLflow 2.11 to 2.15 should be seamless you might still want to backup your MinIO data with your experiments and models. You can find all the details in the :ref:`backup` how to guide. -.. note:: We don't have to backup the MySQL data as we are stil using the same version `8.0/stable` in both versions of MLflow. +.. note:: We don't have to backup the MySQL data as we are still using the same version `8.0/stable` in both versions of MLflow. Update MLflow bundle -------------------- From e2b06c7d5a35085df92edb94d1061a920f844fb4 Mon Sep 17 00:00:00 2001 From: misohu Date: Thu, 15 Aug 2024 15:19:00 +0200 Subject: [PATCH 3/9] Resolve commensts --- docs/how-to/migrate-v21-v215.rst | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/docs/how-to/migrate-v21-v215.rst b/docs/how-to/migrate-v21-v215.rst index f7651234..54968669 100644 --- a/docs/how-to/migrate-v21-v215.rst +++ b/docs/how-to/migrate-v21-v215.rst @@ -18,13 +18,37 @@ Although the process of upgrading MLflow 2.11 to 2.15 should be seamless you mig .. note:: We don't have to backup the MySQL data as we are still using the same version `8.0/stable` in both versions of MLflow. -Update MLflow bundle +Update MicroK8s +--------------- + +Make sure that your system is running MicroK8s version 1.29 or higher. + +If the version is lower please refer to this `MicroK8s Upgrade Documentation `_. + +Update Juju +----------- + +Make sure that your system is running Juju version 3.4. + +If the version is lower please refer to this `Juju Upgrade Documentation `_. + +Upgrade MLflow bundle -------------------- -To update MLflow bundle components from 2.11 to 2.15 please run these commands. +To update MLflow bundle components from 2.11 to 2.15 please run these commands: .. code-block:: bash juju refresh mlflow-minio --channel=ckf-1.9/stable --trust - juju refresh mlflow-mysql --channel=8.0/stable --trust - juju refresh mlflow-server --channel=2.15/stable --trust \ No newline at end of file + juju refresh mlflow-server --channel=2.15/stable --trust + +Upgrade Resource dispatcher (Optional) +-------------------------------------- + +If you are running MLflow with Kubeflow you must upgrade your Resource dispatcher deployment. MLflow 2.15 works only with Resource dispatcher version 2.0/stable. + +To upgrade your Resource dispatcher charm run these commands: + +.. code-block:: bash + + juju refresh resource-dispatcher --channel=2.0/stable --trust \ No newline at end of file From 7ad284a32e18d1e2b5db3b159795b1de640f314b Mon Sep 17 00:00:00 2001 From: Michal Hucko Date: Fri, 16 Aug 2024 07:58:39 +0200 Subject: [PATCH 4/9] Update migrate-v21-v215.rst --- docs/how-to/migrate-v21-v215.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/how-to/migrate-v21-v215.rst b/docs/how-to/migrate-v21-v215.rst index 54968669..891f8d28 100644 --- a/docs/how-to/migrate-v21-v215.rst +++ b/docs/how-to/migrate-v21-v215.rst @@ -1,7 +1,7 @@ -Migrate Charmed MLflow Version 2.1 to Version 2.15 +Upgrade Charmed MLflow Version 2.1 to Version 2.15 ================================================== -This guide shows how to migrate Charmed MLflow version 2.1 to version 2.15. This guide assumes you are running the old Charmed MLflow stack version 2.11. +This guide shows how to upgrade Charmed MLflow version 2.1 to version 2.15. This guide assumes you are running the old Charmed MLflow stack version 2.11. Prerequisites ------------- @@ -18,14 +18,14 @@ Although the process of upgrading MLflow 2.11 to 2.15 should be seamless you mig .. note:: We don't have to backup the MySQL data as we are still using the same version `8.0/stable` in both versions of MLflow. -Update MicroK8s +Upgrade MicroK8s --------------- Make sure that your system is running MicroK8s version 1.29 or higher. If the version is lower please refer to this `MicroK8s Upgrade Documentation `_. -Update Juju +Upgrade Juju ----------- Make sure that your system is running Juju version 3.4. @@ -35,7 +35,7 @@ If the version is lower please refer to this `Juju Upgrade Documentation Date: Fri, 16 Aug 2024 10:16:59 +0200 Subject: [PATCH 5/9] Update migrate-v21-v215.rst --- docs/how-to/migrate-v21-v215.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/how-to/migrate-v21-v215.rst b/docs/how-to/migrate-v21-v215.rst index 891f8d28..14b29e98 100644 --- a/docs/how-to/migrate-v21-v215.rst +++ b/docs/how-to/migrate-v21-v215.rst @@ -39,8 +39,8 @@ To Upgrade MLflow bundle components from 2.11 to 2.15 please run these commands: .. code-block:: bash - juju refresh mlflow-minio --channel=ckf-1.9/stable --trust - juju refresh mlflow-server --channel=2.15/stable --trust + juju refresh mlflow-minio --channel=ckf-1.9/stable + juju refresh mlflow-server --channel=2.15/stable Upgrade Resource dispatcher (Optional) -------------------------------------- @@ -51,4 +51,4 @@ To upgrade your Resource dispatcher charm run these commands: .. code-block:: bash - juju refresh resource-dispatcher --channel=2.0/stable --trust + juju refresh resource-dispatcher --channel=2.0/stable From 5953b880623a996cea3464abe5025b89c3233124 Mon Sep 17 00:00:00 2001 From: afgambin Date: Fri, 16 Aug 2024 12:14:03 +0100 Subject: [PATCH 6/9] docs revision --- docs/how-to/migrate-v21-v215.rst | 47 ++++++++++++++------------------ docs/reuse/links.txt | 6 ++++ 2 files changed, 27 insertions(+), 26 deletions(-) diff --git a/docs/how-to/migrate-v21-v215.rst b/docs/how-to/migrate-v21-v215.rst index 14b29e98..c889922f 100644 --- a/docs/how-to/migrate-v21-v215.rst +++ b/docs/how-to/migrate-v21-v215.rst @@ -1,53 +1,48 @@ -Upgrade Charmed MLflow Version 2.1 to Version 2.15 +Upgrade Charmed MLflow 2.1 to 2.15 ================================================== -This guide shows how to upgrade Charmed MLflow version 2.1 to version 2.15. This guide assumes you are running the old Charmed MLflow stack version 2.11. +This guide describes how to upgrade Charmed MLflow version 2.1 to 2.15. Prerequisites ------------- -This guide assumes the following: +This guide assumes: -#. You have deployed MLflow version 2.11. -#. You have a CLI access to the machine where the Juju controller is deployed (all commands will be executed from there). +* 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. -Backup data (Optional) ----------------------- - -Although the process of upgrading MLflow 2.11 to 2.15 should be seamless you might still want to backup your MinIO data with your experiments and models. You can find all the details in the :ref:`backup` how to guide. - -.. note:: We don't have to backup the MySQL data as we are still using the same version `8.0/stable` in both versions of MLflow. +.. tip:: + Before proceeding, you might want to backup MinIO data including your experiments and models. See :ref:`backup` for more details. -Upgrade MicroK8s ---------------- +Upgrade dependencies +--------------------- -Make sure that your system is running MicroK8s version 1.29 or higher. +Charmed MLflow 2.15 requires: -If the version is lower please refer to this `MicroK8s Upgrade Documentation `_. +1. `MicroK8s`_ version 1.29 or higher. +2. Juju version 3.4. -Upgrade Juju ------------ - -Make sure that your system is running Juju version 3.4. - -If the version is lower please refer to this `Juju Upgrade Documentation `_. +If you do not meet these requirements, please upgrade these components. +See `MicroK8s Upgrade Documentation `_ +and `Juju Upgrade Documentation `_ respectively for more details. Upgrade MLflow bundle --------------------- +---------------------- -To Upgrade MLflow bundle components from 2.11 to 2.15 please run these commands: +To upgrade the MLflow bundle components 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 (Optional) +Upgrade resource dispatcher -------------------------------------- -If you are running MLflow with Kubeflow you must upgrade your Resource dispatcher deployment. MLflow 2.15 works only with Resource dispatcher version 2.0/stable. +Only if you are running MLflow within Kubeflow, you must upgrade your resource dispatcher deployment. +MLflow 2.15 works only with resource dispatcher version 2.0/stable. -To upgrade your Resource dispatcher charm run these commands: +To upgrade your resource dispatcher, do the following: .. code-block:: bash 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/ + + + + From b7630f127ac5c96e916f6071397802f80cea180b Mon Sep 17 00:00:00 2001 From: misohu Date: Fri, 16 Aug 2024 14:50:33 +0200 Subject: [PATCH 7/9] Resolve commensts --- docs/how-to/migrate-v21-v215.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/how-to/migrate-v21-v215.rst b/docs/how-to/migrate-v21-v215.rst index c889922f..797ef0a8 100644 --- a/docs/how-to/migrate-v21-v215.rst +++ b/docs/how-to/migrate-v21-v215.rst @@ -19,8 +19,8 @@ Upgrade dependencies Charmed MLflow 2.15 requires: -1. `MicroK8s`_ version 1.29 or higher. -2. Juju version 3.4. +1. `MicroK8s `_ version 1.29 or higher. +2. `Juju `_ version 3.4. If you do not meet these requirements, please upgrade these components. See `MicroK8s Upgrade Documentation `_ @@ -29,7 +29,7 @@ and `Juju Upgrade Documentation `_ deployment. MLflow 2.15 works only with resource dispatcher version 2.0/stable. To upgrade your resource dispatcher, do the following: From be355e0209595f508afeef639b9e97dc352895a0 Mon Sep 17 00:00:00 2001 From: afgambin Date: Fri, 16 Aug 2024 14:07:22 +0100 Subject: [PATCH 8/9] final docs tweaks --- docs/how-to/migrate-v21-v215.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/how-to/migrate-v21-v215.rst b/docs/how-to/migrate-v21-v215.rst index 797ef0a8..4675d7e0 100644 --- a/docs/how-to/migrate-v21-v215.rst +++ b/docs/how-to/migrate-v21-v215.rst @@ -22,9 +22,9 @@ 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 components. -See `MicroK8s Upgrade Documentation `_ -and `Juju Upgrade Documentation `_ respectively for more details. +If you do not meet these requirements, please upgrade these dependencies. +See `MicroK8s upgrade `_ +and `Juju upgrade `_ respectively for more details. Upgrade MLflow bundle ---------------------- From 3d0a3292549952442aa243a17e1feb2576e47623 Mon Sep 17 00:00:00 2001 From: afgambin Date: Fri, 16 Aug 2024 14:08:55 +0100 Subject: [PATCH 9/9] added a note box --- docs/how-to/migrate-v21-v215.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/how-to/migrate-v21-v215.rst b/docs/how-to/migrate-v21-v215.rst index 4675d7e0..4f34b29d 100644 --- a/docs/how-to/migrate-v21-v215.rst +++ b/docs/how-to/migrate-v21-v215.rst @@ -40,7 +40,9 @@ Upgrade resource dispatcher -------------------------------------- Only if you are running MLflow within Kubeflow, you must upgrade your `resource dispatcher `_ deployment. -MLflow 2.15 works only with resource dispatcher version 2.0/stable. + +.. note:: + MLflow 2.15 works only with resource dispatcher version 2.0/stable. To upgrade your resource dispatcher, do the following: