diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..d152daf --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,57 @@ +# ClearML Helm Charts Installation guide + +## Requirements + +### Setup a Kubernetes Cluster + +For setting up Kubernetes on various platforms refer to the Kubernetes [getting started guide](http://kubernetes.io/docs/getting-started-guides/). + +#### Setup a single node LOCAL Kubernetes on laptop/desktop (development) + +For setting up Kubernetes on your laptop/desktop we suggest [kind](https://kind.sigs.k8s.io). + +#### [Kubernetes Tanzu users only] Additional setup requirements + +For setting up Clear.ML on a Tanzu cluster, check [prerequisites](https://github.com/allegroai/clearml-helm-charts/tree/main/platform-specific-configs/tanzu). + +#### [Kubernetes Openshift users only] Additional setup requirements + +For setting up Clear.ML on a Openshift cluster, check [prerequisites](https://github.com/allegroai/clearml-helm-charts/tree/main/platform-specific-configs/openshift). + +### Install Helm + +Helm is a tool for managing Kubernetes charts. Charts are packages of pre-configured Kubernetes resources. + +To install Helm, refer to the [Helm install guide](https://github.com/helm/helm#install) and ensure that the `helm` binary is in the `PATH` of your shell. + +## Helm charts installation + +### Helm Repo + +```bash +$ helm repo add allegroai https://allegroai.github.io/clearml-helm-charts +$ helm repo update +``` +### ClearML server ecosystem + +```bash +$ helm install clearml allegroai/clearml +``` + +### ClearML agent + +Agent is always related a ClearML server ecosystem (by default using `app.clear.ml` public service but can be on same or another Kubernetes cluster or a single server installation). + +On ClearML UI, Settings -> Workspace and Create new Credentials. + +In following Helm chart install command: + +* set ACCESSKEY to resuted credentials access_key +* set SECRETKEY to resuted credentials secret_key +* set APIERVERURL to resuted credentials api_server +* set FILESSERVERURL to resuted credentials files_server +* set WEBSERVERURL to resuted credentials web_server + +```bash +$ helm install clearml-agent allegroai/clearml-agent --set clearml.agentk8sglueKey=ACCESSKEY --set clearml.agentk8sglueSecret=SECRETKEY --set agentk8sglue.apiServerUrlReference=APISERVERURL --set agentk8sglue.fileServerUrlReference=FILESERVERURL --set agentk8sglue.webServerUrlReference=WEBSERVERURL +``` diff --git a/README.md b/README.md index 0105be6..2f2915a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ClearML Helm Charts Library for Kubernetes +# ClearML Helm Charts for Kubernetes ## Auto-Magical Experiment Manager & Version Control for AI @@ -23,7 +23,11 @@ Use this repository to deploy **clearml-server** on Kubernetes clusters. ## Provided in this repository -### [All around Helm Chart](https://github.com/allegroai/clearml-helm-charts/tree/main/charts/clearml) +### [ClearML server chart](https://github.com/allegroai/clearml-helm-charts/tree/main/charts/clearml) + +### [ClearML agent chart](https://github.com/allegroai/clearml-helm-charts/tree/main/charts/clearml-agent) + +### [ClearML serving chart](https://github.com/allegroai/clearml-helm-charts/tree/main/charts/clearml-serving) ## Who We Are @@ -40,30 +44,9 @@ will always upgrade with you. Apache License, Version 2.0, (see the [LICENSE](https://www.apache.org/licenses/LICENSE-2.0) for more information) -## Requirements +## Installation guide -### Setup a Kubernetes Cluster - -For setting up Kubernetes on various platforms refer to the Kubernetes [getting started guide](http://kubernetes.io/docs/getting-started-guides/). - -### Setup a single node LOCAL Kubernetes on laptop/desktop - -For setting up Kubernetes on your laptop/desktop we suggest [kind](https://kind.sigs.k8s.io). - -### Install Helm - -Helm is a tool for managing Kubernetes charts. Charts are packages of pre-configured Kubernetes resources. - -To install Helm, refer to the [Helm install guide](https://github.com/helm/helm#install) and ensure that the `helm` binary is in the `PATH` of your shell. - -## Usage - -```bash -$ helm repo add allegroai https://allegroai.github.io/clearml-helm-charts -$ helm repo update -$ helm search repo allegroai -$ helm install allegroai/ -``` +For installation instruction, follow related [Installation Guide](INSTALL.md). ## Documentation, Community & Support