From 128b02904825debc34288bce303a774fc1798cc6 Mon Sep 17 00:00:00 2001 From: ColmBhandal Date: Mon, 11 Sep 2023 10:11:24 +0100 Subject: [PATCH] Final spell check --- docs/.wordlist.txt | 3 ++- docs/how-to/deploy-eks.rst | 2 +- docs/how-to/deploy-mlflow-kubeflow-eks.rst | 4 ++-- docs/tutorial/mlflow.rst | 16 ++++++++-------- 4 files changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/.wordlist.txt b/docs/.wordlist.txt index 97285453..fcc706ba 100644 --- a/docs/.wordlist.txt +++ b/docs/.wordlist.txt @@ -1,6 +1,7 @@ addons API APIs +balancer CharmHub CLI DEX @@ -11,12 +12,12 @@ EKS favicon filesystem Grafana +hostname https IAM installable JSON Juju -Juju’s Kubernetes Kubeflow lifecycle diff --git a/docs/how-to/deploy-eks.rst b/docs/how-to/deploy-eks.rst index eec686da..93ad4a11 100644 --- a/docs/how-to/deploy-eks.rst +++ b/docs/how-to/deploy-eks.rst @@ -45,7 +45,7 @@ Create a controller: .. note:: You can use whatever controller name you like here, we chose ``kubeflow-controller``. -Add a juju model: +Add a Juju model: .. code-block:: bash diff --git a/docs/how-to/deploy-mlflow-kubeflow-eks.rst b/docs/how-to/deploy-mlflow-kubeflow-eks.rst index fa6ea9bf..3dc55c5f 100644 --- a/docs/how-to/deploy-mlflow-kubeflow-eks.rst +++ b/docs/how-to/deploy-mlflow-kubeflow-eks.rst @@ -25,7 +25,7 @@ See our `EKS creation guide `_ is an So wait, what does "Charmed MLflow" mean? Is it the same thing as MLflow? Yes and no. MLflow is a complex application, consisting of many components running together and communicating with each other. Charmed MLflow is a `charm bundle `_ that allows us to deploy MLflow quickly and easily. Don't worry too much about what a "charm bundle" is right now. The key thing is that it's going to make deploying MLflow very convenient for us: we'll get MLflow up and running with just a few command line commands! -In this tutorial, we're going to explore Charmed MLflow in a practical way. Using the CLI tool `juju `_, we'll deploy MLflow to a local `MicroK8s `_ cloud. +In this tutorial, we're going to explore Charmed MLflow in a practical way. Using the `Juju `_ CLI tool, we'll deploy MLflow to a local `MicroK8s `_ cloud. Prerequisites ------------- @@ -42,16 +42,16 @@ It is also useful to make sure the user has the proper access and ownership of a sudo chown -f -R $USER ~/.kube -Enable the following Microk8s addons to configure your Kubernetes cluster with extra services needed to run Charmed Kubeflow. +Enable the following MicroK8s addons to configure your Kubernetes cluster with extra services needed to run Charmed Kubeflow. .. code-block:: bash microk8s enable dns hostpath-storage ingress metallb:10.64.140.43-10.64.140.49 Here, we added a ``dns`` service, so the applications can find each other, storage, an ingress controller so we can access Kubeflow components and the ``MetalLB`` load-balancer application. -You can see that we added some detail when enabling MetalLB, in this case the address pool to use. +You can see that we added some detail when enabling ``MetalLB``, in this case the address pool to use. -> See More : `Microk8s | How to use addons `_ +> See More : `MicroK8s | How to use addons `_ We've now installed and configured MicroK8s. It will start running automatically, but can take 5 minutes or so before it's ready for action. Run the following command to tell MicroK8s to report its status to us when it's ready: @@ -87,7 +87,7 @@ Now, run the following command to deploy a Juju controller to the Kubernetes we Sit tight while the command completes! The controller may take a minute or two to deploy. -The controller is Juju’s agent, running on Kubernetes, which can be used to deploy and control the components of Kubeflow. +The controller is the agent of Juju, running on Kubernetes, which can be used to deploy and control the components of Kubeflow. Next, we'll need to add a model for Kubeflow to the controller. Run the following command to add a model called ``kubeflow``: @@ -110,7 +110,7 @@ Before deploying, run these commands: sudo sysctl fs.inotify.max_user_instances=1280 sudo sysctl fs.inotify.max_user_watches=655360 -We need to run the above because under the hood, MicroK8s uses inotify to interact with the filesystem, and in large MicroK8s deployments sometimes the default ``inotify`` limits are exceeded. +We need to run the above because under the hood, MicroK8s uses ``inotify`` to interact with the filesystem, and in large MicroK8s deployments sometimes the default ``inotify`` limits are exceeded. Let's now use Juju to deploy Charmed MLflow. Run the following command: @@ -130,13 +130,13 @@ To access MLflow, visit the following URL in your web browser: This will take you to the MLflow UI. -.. note:: by default Charmed MLflow creates a `nodeport `_ on port 31380 where you can access the MLflow UI. +.. note:: by default Charmed MLflow creates a `NodePort `_ on port 31380 where you can access the MLflow UI. That's it! Charmed MLflow has been deployed locally with MicroK8s and Juju. You can now start using MLflow. Reference: Object storage credentials ------------------------------------- -To use mlflow you need to have credentials to the object storage. The aforementioned bundle comes with MinIO. To get the minio credentials run the following command: +To use mlflow you need to have credentials to the object storage. The aforementioned bundle comes with MinIO. To get the ``MinIO`` credentials run the following command: .. code-block:: bash