ClearML/clearml-helm-charts
1
0
Fork 0
mirror of https://github.com/clearml/clearml-helm-charts synced 2025-01-31 00:56:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
3075f5e280
clearml-helm-charts/INSTALL.md
Valeriano Manassero 3075f5e280
157 improve documentation (#159) 
* Changed: updated installation guide

* Fixed: typo in copy and paste

* Changed: updated install guide

* Fixed: use relative path
2023-02-14 08:44:04 +01:00

2.2 KiB
Raw Blame History

ClearML Helm Charts Installation guide

Requirements

Setup a Kubernetes Cluster

For setting up Kubernetes on various platforms refer to the Kubernetes getting started guide.

Setup a single node LOCAL Kubernetes on laptop/desktop (development)

For setting up Kubernetes on your laptop/desktop we suggest kind.

[Kubernetes Tanzu users only] Additional setup requirements

For setting up Clear.ML on a Tanzu cluster, check prerequisites.

[Kubernetes Openshift users only] Additional setup requirements

For setting up Clear.ML on a Openshift cluster, check prerequisites.

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 and ensure that the helm binary is in the PATH of your shell.

Helm charts installation

Helm Repo

$ helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
$ helm repo update

ClearML server ecosystem

$ 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
$ 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