ClearML/clearml-helm-charts
1
0
Fork 0
mirror of https://github.com/clearml/clearml-helm-charts synced 2025-04-17 01:31:13 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

bump up version

Browse Source
This commit is contained in:
Valeriano Manassero 2021-07-15 17:21:02 +02:00
parent 94fbb30d71
commit e18466624c
3 changed files with 88 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
charts/clearml/Chart.yaml
View File

@ -2,7 +2,7 @@ apiVersion: v2
name: clearml
description: MLOps platform
type: application
version: "2.0.0-alpha2"
version: "2.0.0-beta1"
appVersion: "1.0.2"
home: https://clear.ml
icon: https://raw.githubusercontent.com/allegroai/clearml/master/docs/clearml-logo.svg

64
charts/clearml/README.md
View File

@ -1,6 +1,6 @@
# ClearML Ecosystem for Kubernetes
![Version: 2.0.0-alpha2](https://img.shields.io/badge/Version-2.0.0--alpha2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.2](https://img.shields.io/badge/AppVersion-1.0.2-informational?style=flat-square)
![Version: 2.0.0-beta1](https://img.shields.io/badge/Version-2.0.0--beta1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.2](https://img.shields.io/badge/AppVersion-1.0.2-informational?style=flat-square)
MLOps platform
@ -16,8 +16,6 @@ MLOps platform
The **clearml-server** is the backend service infrastructure for [ClearML](https://github.com/allegroai/clearml).
It allows multiple users to collaborate and manage their experiments.
By default, *ClearML is set up to work with the ClearML Demo Server, which is open to anyone and resets periodically.
In order to host your own server, you will need to install **clearml-server** and point ClearML to it.
**clearml-server** contains the following components:
@ -27,33 +25,59 @@ In order to host your own server, you will need to install **clearml-server** an
* Querying experiments history, logs and results
* Locally-hosted file server for storing images and models making them easily accessible using the Web-App
## Port Mapping
## Local environment
After **clearml-server** is deployed, the services expose the following node ports:
For development/evaluation it's possible to use [kind](https://kind.sigs.k8s.io).
After installation, following commands will create a complete ClearML insatllation:
```
cat <<EOF > /tmp/clearml-kind.yaml
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
nodes:
- role: control-plane
extraPortMappings:
- containerPort: 30008
hostPort: 30008
listenAddress: "127.0.0.1"
protocol: TCP
- containerPort: 30080
hostPort: 30080
listenAddress: "127.0.0.1"
protocol: TCP
- containerPort: 30081
hostPort: 30081
listenAddress: "127.0.0.1"
protocol: TCP
extraMounts:
- hostPath: /var/folders/kind/
containerPath: /var/local-path-provisioner
EOF
kind create cluster --config /tmp/clearml-kind.yaml
helm install clearml allegroai/clearml
```
After deployment, the services will be exposed on localhost on the following ports:
* API server on `30008`
* Web server on `30080`
* File server on `30081`
## Accessing ClearML Server
## Production cluster environment
Access **clearml-server** by creating a load balancer and domain name with records pointing to the load balancer.
In a production environment it's suggested to install an ingress controller and verify that is working correctly.
During ClearML deployment enable `ingress` section of chart values.
This will create 3 ingress rules:
Once you have a load balancer and domain name set up, follow these steps to configure access to clearml-server on your k8s cluster:
* `app.<your domain name>`
* `files.<your domain name>`
* `api.<your domain name>`
1. Create domain records
(*for example, `app.clearml.mydomainname.com`, `files.clearml.mydomainname.com` and `api.clearml.mydomainname.com`*)
* Create 3 records to be used for Web-App, File server and API access using the following rules:
* `app.<your domain name>`
* `files.<your domain name>`
* `api.<your domain name>`
(*for example, `app.clearml.mydomainname.com`, `files.clearml.mydomainname.com` and `api.clearml.mydomainname.com`*)
2. Point the records you created to the load balancer
3. Configure the load balancer to redirect traffic coming from the records you created:
* `app.<your domain name>` should be redirected to k8s cluster nodes on port `30080`
* `files.<your domain name>` should be redirected to k8s cluster nodes on port `30081`
* `api.<your domain name>` should be redirected to k8s cluster nodes on port `30008`
Just pointing the domain records to the IP where ingress controller is responding will complete the deployment process.
## Additional Configuration for ClearML Server

62
charts/clearml/README.md.gotmpl
View File

@ -13,8 +13,6 @@
The **clearml-server** is the backend service infrastructure for [ClearML](https://github.com/allegroai/clearml).
It allows multiple users to collaborate and manage their experiments.
By default, *ClearML is set up to work with the ClearML Demo Server, which is open to anyone and resets periodically.
In order to host your own server, you will need to install **clearml-server** and point ClearML to it.
**clearml-server** contains the following components:
@ -24,33 +22,59 @@ In order to host your own server, you will need to install **clearml-server** an
* Querying experiments history, logs and results
* Locally-hosted file server for storing images and models making them easily accessible using the Web-App
## Port Mapping
## Local environment
After **clearml-server** is deployed, the services expose the following node ports:
For development/evaluation it's possible to use [kind](https://kind.sigs.k8s.io).
After installation, following commands will create a complete ClearML insatllation:
```
cat <<EOF > /tmp/clearml-kind.yaml
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
nodes:
- role: control-plane
extraPortMappings:
- containerPort: 30008
hostPort: 30008
listenAddress: "127.0.0.1"
protocol: TCP
- containerPort: 30080
hostPort: 30080
listenAddress: "127.0.0.1"
protocol: TCP
- containerPort: 30081
hostPort: 30081
listenAddress: "127.0.0.1"
protocol: TCP
extraMounts:
- hostPath: /var/folders/kind/
containerPath: /var/local-path-provisioner
EOF
kind create cluster --config /tmp/clearml-kind.yaml
helm install clearml allegroai/clearml
```
After deployment, the services will be exposed on localhost on the following ports:
* API server on `30008`
* Web server on `30080`
* File server on `30081`
## Accessing ClearML Server
## Production cluster environment
Access **clearml-server** by creating a load balancer and domain name with records pointing to the load balancer.
In a production environment it's suggested to install an ingress controller and verify that is working correctly.
During ClearML deployment enable `ingress` section of chart values.
This will create 3 ingress rules:
Once you have a load balancer and domain name set up, follow these steps to configure access to clearml-server on your k8s cluster:
* `app.<your domain name>`
* `files.<your domain name>`
* `api.<your domain name>`
1. Create domain records
(*for example, `app.clearml.mydomainname.com`, `files.clearml.mydomainname.com` and `api.clearml.mydomainname.com`*)
* Create 3 records to be used for Web-App, File server and API access using the following rules:
* `app.<your domain name>`
* `files.<your domain name>`
* `api.<your domain name>`
(*for example, `app.clearml.mydomainname.com`, `files.clearml.mydomainname.com` and `api.clearml.mydomainname.com`*)
2. Point the records you created to the load balancer
3. Configure the load balancer to redirect traffic coming from the records you created:
* `app.<your domain name>` should be redirected to k8s cluster nodes on port `30080`
* `files.<your domain name>` should be redirected to k8s cluster nodes on port `30081`
* `api.<your domain name>` should be redirected to k8s cluster nodes on port `30008`
Just pointing the domain records to the IP where ingress controller is responding will complete the deployment process.
## Additional Configuration for ClearML Server