mirror of
https://github.com/clearml/clearml-helm-charts
synced 2025-04-17 01:31:13 +00:00
Compare commits
6 Commits
clearml-ag
...
main
Author | SHA1 | Date | |
---|---|---|---|
|
747c018adb | ||
|
299cc2adb4 | ||
|
1479cf9ed2 | ||
|
2a4d9569f3 | ||
|
6c212f5b82 | ||
|
4885e01750 |
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -2,8 +2,8 @@
|
||||
|
||||
|
||||
**Checklist**
|
||||
- [ ] Reviewed the [`CONTRIBUTING.md`](https://github.com/allegroai/clearml-helm-charts/blob/main/CONTRIBUTING.md#pull-requests) guide (**required**)
|
||||
- [ ] Verify the work you plan to merge addresses an existing [issue](https://github.com/allegroai/clearml-helm-charts/issues) (If not, open a new one) (**required**)
|
||||
- [ ] Reviewed the [`CONTRIBUTING.md`](https://github.com/clearml/clearml-helm-charts/blob/main/CONTRIBUTING.md#pull-requests) guide (**required**)
|
||||
- [ ] Verify the work you plan to merge addresses an existing [issue](https://github.com/clearml/clearml-helm-charts/issues) (If not, open a new one) (**required**)
|
||||
- [ ] Check your branch with `helm lint` (**required**)
|
||||
- [ ] Update `version` in `Chart.yaml` according [semver](https://semver.org/) rules (**required**)
|
||||
- [ ] Substitute `annotations` section in `Chart.yaml` annotating implementations (useful for Artifecthub changelog) (**required**)
|
||||
|
@ -3,8 +3,8 @@
|
||||
:+1::tada: Firstly, we thank you for taking the time to contribute! :tada::+1:
|
||||
|
||||
Contribution comes in many forms:
|
||||
* Reporting [issues](https://github.com/allegroai/clearml-helm-charts/issues) you've come upon
|
||||
* Participating in issue discussions in the [issue tracker](https://github.com/allegroai/clearml-helm-charts/issues) and the [ClearML community slack space](https://joinslack.clear.ml)
|
||||
* Reporting [issues](https://github.com/clearml/clearml-helm-charts/issues) you've come upon
|
||||
* Participating in issue discussions in the [issue tracker](https://github.com/clearml/clearml-helm-charts/issues) and the [ClearML community slack space](https://joinslack.clear.ml)
|
||||
* Suggesting new features or enhancements
|
||||
* Implementing new features or fixing outstanding issues
|
||||
|
||||
@ -16,7 +16,7 @@ Use your best judgment and feel free to propose changes to this document in a pu
|
||||
|
||||
By following these guidelines, you help maintainers and the community understand your report, reproduce the behavior, and find related reports.
|
||||
|
||||
Before reporting an issue, please check whether it already appears [here](https://github.com/allegroai/clearml-helm-charts/issues).
|
||||
Before reporting an issue, please check whether it already appears [here](https://github.com/clearml/clearml-helm-charts/issues).
|
||||
If it does, join the on-going discussion instead.
|
||||
|
||||
**Note**: If you find a **Closed** issue that may be the same issue which you are currently experiencing,
|
||||
@ -50,7 +50,7 @@ Enhancement suggestions are tracked as GitHub issues. After you determine which
|
||||
|
||||
Before you submit a new PR:
|
||||
|
||||
* Verify the work you plan to merge addresses an existing [issue](https://github.com/allegroai/clearml-helm-charts/issues) (If not, open a new one)
|
||||
* Verify the work you plan to merge addresses an existing [issue](https://github.com/clearml/clearml-helm-charts/issues) (If not, open a new one)
|
||||
* Check related discussions in the [ClearML slack community](https://joinslack.clear.ml) (or start your own discussion on the `#clearml-dev` channel)
|
||||
* Check your branch with `helm lint`
|
||||
* Update `version` in `Chart.yaml` according [semver](https://semver.org/) rules
|
||||
|
10
INSTALL.md
10
INSTALL.md
@ -4,9 +4,9 @@
|
||||
|
||||
* Set up a Kubernetes Cluster - for setting up Kubernetes on various platforms refer to the Kubernetes [getting started guide](http://kubernetes.io/docs/getting-started-guides/).
|
||||
* Set up a single-node LOCAL Kubernetes on laptop/desktop - for setting up Kubernetes on your laptop/desktop, we suggest [kind](https://kind.sigs.k8s.io).
|
||||
* For **Kubernetes Tanzu users** - see [prerequisites](https://github.com/allegroai/clearml-helm-charts/tree/main/platform-specific-configs/tanzu)
|
||||
* For **Kubernetes Tanzu users** - see [prerequisites](https://github.com/clearml/clearml-helm-charts/tree/main/platform-specific-configs/tanzu)
|
||||
for setting up ClearML on a Tanzu cluster
|
||||
* For **Kubernetes Openshift users** - see [prerequisites](https://github.com/allegroai/clearml-helm-charts/tree/main/platform-specific-configs/openshift)
|
||||
* For **Kubernetes Openshift users** - see [prerequisites](https://github.com/clearml/clearml-helm-charts/tree/main/platform-specific-configs/openshift)
|
||||
for setting up ClearML on an Openshift cluster,
|
||||
|
||||
* Install Helm - Helm is a tool for managing Kubernetes charts. Charts are packages of pre-configured Kubernetes
|
||||
@ -17,13 +17,13 @@ resources. To install Helm, refer to the [Helm install guide](https://github.com
|
||||
### Helm Repo
|
||||
|
||||
```bash
|
||||
$ helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
|
||||
$ helm repo add clearml https://clearml.github.io/clearml-helm-charts
|
||||
$ helm repo update
|
||||
```
|
||||
### ClearML Server Ecosystem
|
||||
|
||||
```bash
|
||||
$ helm install clearml allegroai/clearml
|
||||
$ helm install clearml clearml/clearml
|
||||
```
|
||||
|
||||
### ClearML Agent
|
||||
@ -43,5 +43,5 @@ In the Helm chart `install` command below:
|
||||
* Set `WEBSERVERURL` to the new credentials' `web_server` value
|
||||
|
||||
```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
|
||||
$ helm install clearml-agent clearml/clearml-agent --set clearml.agentk8sglueKey=ACCESSKEY --set clearml.agentk8sglueSecret=SECRETKEY --set agentk8sglue.apiServerUrlReference=APISERVERURL --set agentk8sglue.fileServerUrlReference=FILESERVERURL --set agentk8sglue.webServerUrlReference=WEBSERVERURL
|
||||
```
|
||||
|
14
README.md
14
README.md
@ -2,11 +2,11 @@
|
||||
|
||||
## Auto-Magical Experiment Manager & Version Control for AI
|
||||
|
||||
Helm charts provided by [Allegro AI](https://clear.ml), ready to launch on Kubernetes using [Kubernetes Helm](https://github.com/helm/helm).
|
||||
Helm charts provided by [ClearML](https://clear.ml), ready to launch on Kubernetes using [Kubernetes Helm](https://github.com/helm/helm).
|
||||
|
||||
## Introduction
|
||||
|
||||
The **clearml-server** is the backend service infrastructure for [ClearML](https://github.com/allegroai/clearml).
|
||||
The **clearml-server** is the backend service infrastructure for [ClearML](https://github.com/clearml/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.
|
||||
@ -23,11 +23,11 @@ Use this repository to deploy **clearml-server** on Kubernetes clusters.
|
||||
|
||||
## Provided in this repository
|
||||
|
||||
### [ClearML server chart](https://github.com/allegroai/clearml-helm-charts/tree/main/charts/clearml)
|
||||
### [ClearML server chart](https://github.com/clearml/clearml-helm-charts/tree/main/charts/clearml)
|
||||
|
||||
### [ClearML agent chart](https://github.com/allegroai/clearml-helm-charts/tree/main/charts/clearml-agent)
|
||||
### [ClearML agent chart](https://github.com/clearml/clearml-helm-charts/tree/main/charts/clearml-agent)
|
||||
|
||||
### [ClearML serving chart](https://github.com/allegroai/clearml-helm-charts/tree/main/charts/clearml-serving)
|
||||
### [ClearML serving chart](https://github.com/clearml/clearml-helm-charts/tree/main/charts/clearml-serving)
|
||||
|
||||
## Who We Are
|
||||
|
||||
@ -54,13 +54,13 @@ See more information in the [official documentation](https://clear.ml/docs/lates
|
||||
|
||||
If you have any questions, post on our [Slack Channel](https://joinslack.clear.ml), or tag your questions on [stackoverflow](https://stackoverflow.com/questions/tagged/clearml) with '**[clearml](https://stackoverflow.com/questions/tagged/clearml)**' tag (*previously [trains](https://stackoverflow.com/questions/tagged/trains) tag*).
|
||||
|
||||
For feature requests or bug reports, please use [GitHub issues](https://github.com/allegroai/clearml-helm-charts/issues).
|
||||
For feature requests or bug reports, please use [GitHub Issues](https://github.com/clearml/clearml-helm-charts/issues).
|
||||
|
||||
Additionally, you can always find us at *support@clear.ml*
|
||||
|
||||
## Contributing
|
||||
|
||||
**PRs are always welcomed** :heart: See more details in the ClearML [Guidelines for Contributing](https://github.com/allegroai/clearml-helm-charts/blob/main/CONTRIBUTING.md).
|
||||
**PRs are always welcomed** :heart: See more details in the ClearML [Guidelines for Contributing](https://github.com/clearml/clearml-helm-charts/blob/main/CONTRIBUTING.md).
|
||||
|
||||
|
||||
_May the force (and the goddess of learning rates) be with you!_
|
||||
|
@ -2,9 +2,9 @@ apiVersion: v2
|
||||
name: clearml-agent
|
||||
description: MLOps platform Task running agent
|
||||
type: application
|
||||
version: "5.3.1"
|
||||
version: "5.3.2"
|
||||
appVersion: "1.24"
|
||||
kubeVersion: ">= 1.21.0-0 < 1.32.0-0"
|
||||
kubeVersion: ">= 1.21.0-0 < 1.33.0-0"
|
||||
home: https://clear.ml
|
||||
icon: https://raw.githubusercontent.com/clearml/clearml/master/docs/clearml-logo.svg
|
||||
sources:
|
||||
@ -20,5 +20,5 @@ keywords:
|
||||
- "task agent"
|
||||
annotations:
|
||||
artifacthub.io/changes: |
|
||||
- kind: fixed
|
||||
description: "ClearML org rename"
|
||||
- kind: changed
|
||||
description: "Support kubernetes 1.32"
|
||||
|
@ -1,6 +1,6 @@
|
||||
# ClearML Kubernetes Agent
|
||||
|
||||
  
|
||||
  
|
||||
|
||||
MLOps platform Task running agent
|
||||
|
||||
@ -55,7 +55,7 @@ Before issuing helm upgrade:
|
||||
|
||||
## Requirements
|
||||
|
||||
Kubernetes: `>= 1.21.0-0 < 1.32.0-0`
|
||||
Kubernetes: `>= 1.21.0-0 < 1.33.0-0`
|
||||
|
||||
## Values
|
||||
|
||||
|
@ -2,14 +2,14 @@ apiVersion: v2
|
||||
name: clearml-serving
|
||||
description: ClearML Serving Helm Chart
|
||||
type: application
|
||||
version: "1.5.8"
|
||||
version: "1.5.10"
|
||||
appVersion: "1.3.0"
|
||||
kubeVersion: ">= 1.21.0-0 < 1.32.0-0"
|
||||
kubeVersion: ">= 1.21.0-0 < 1.33.0-0"
|
||||
home: https://clear.ml
|
||||
icon: https://raw.githubusercontent.com/allegroai/clearml/master/docs/clearml-logo.svg
|
||||
icon: https://raw.githubusercontent.com/clearml/clearml/master/docs/clearml-logo.svg
|
||||
sources:
|
||||
- https://github.com/allegroai/clearml-helm-charts
|
||||
- https://github.com/allegroai/clearml
|
||||
- https://github.com/clearml/clearml-helm-charts
|
||||
- https://github.com/clearml/clearml
|
||||
maintainers:
|
||||
- name: filippo-clearml
|
||||
url: https://github.com/filippo-clearml
|
||||
@ -33,5 +33,5 @@ dependencies:
|
||||
condition: grafana.enabled
|
||||
annotations:
|
||||
artifacthub.io/changes: |
|
||||
- kind: fixed
|
||||
description: Triton deployment tolerations placement fix
|
||||
- kind: changed
|
||||
description: Support kubernetes 1.32
|
||||
|
@ -1,6 +1,6 @@
|
||||
# ClearML Kubernetes Serving
|
||||
|
||||
  
|
||||
  
|
||||
|
||||
ClearML Serving Helm Chart
|
||||
|
||||
@ -14,7 +14,7 @@ ClearML Serving Helm Chart
|
||||
|
||||
## Introduction
|
||||
|
||||
The **clearml-serving** is the Kubernetes serving for for [ClearML](https://github.com/allegroai/clearml-serving).
|
||||
The **clearml-serving** is the Kubernetes serving for for [ClearML](https://github.com/clearml/clearml-serving).
|
||||
It allows you to serve models on a Kubernetes cluster.
|
||||
|
||||
## Add to local Helm repository
|
||||
@ -22,7 +22,7 @@ It allows you to serve models on a Kubernetes cluster.
|
||||
To add this chart to your local Helm repository:
|
||||
|
||||
```
|
||||
helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
|
||||
helm repo add clearml https://clearml.github.io/clearml-helm-charts
|
||||
```
|
||||
|
||||
# Upgrading Chart
|
||||
@ -33,23 +33,23 @@ Updating to latest version of this chart can be done in two steps:
|
||||
|
||||
```
|
||||
helm repo update
|
||||
helm upgrade clearml-serving allegroai/clearml-serving
|
||||
helm upgrade clearml-serving clearml/clearml-serving
|
||||
```
|
||||
|
||||
Changing values on existing installation can be done with:
|
||||
|
||||
```
|
||||
helm upgrade clearml-serving allegroai/clearml-serving --version <CURRENT CHART VERSION> -f custom_values.yaml
|
||||
helm upgrade clearml-serving clearml/clearml-serving --version <CURRENT CHART VERSION> -f custom_values.yaml
|
||||
```
|
||||
|
||||
## Source Code
|
||||
|
||||
* <https://github.com/allegroai/clearml-helm-charts>
|
||||
* <https://github.com/allegroai/clearml>
|
||||
* <https://github.com/clearml/clearml-helm-charts>
|
||||
* <https://github.com/clearml/clearml>
|
||||
|
||||
## Requirements
|
||||
|
||||
Kubernetes: `>= 1.21.0-0 < 1.32.0-0`
|
||||
Kubernetes: `>= 1.21.0-0 < 1.33.0-0`
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
|
@ -11,7 +11,7 @@
|
||||
|
||||
## Introduction
|
||||
|
||||
The **clearml-serving** is the Kubernetes serving for for [ClearML](https://github.com/allegroai/clearml-serving).
|
||||
The **clearml-serving** is the Kubernetes serving for for [ClearML](https://github.com/clearml/clearml-serving).
|
||||
It allows you to serve models on a Kubernetes cluster.
|
||||
|
||||
## Add to local Helm repository
|
||||
@ -19,7 +19,7 @@ It allows you to serve models on a Kubernetes cluster.
|
||||
To add this chart to your local Helm repository:
|
||||
|
||||
```
|
||||
helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
|
||||
helm repo add clearml https://clearml.github.io/clearml-helm-charts
|
||||
```
|
||||
|
||||
# Upgrading Chart
|
||||
@ -30,13 +30,13 @@ Updating to latest version of this chart can be done in two steps:
|
||||
|
||||
```
|
||||
helm repo update
|
||||
helm upgrade clearml-serving allegroai/clearml-serving
|
||||
helm upgrade clearml-serving clearml/clearml-serving
|
||||
```
|
||||
|
||||
Changing values on existing installation can be done with:
|
||||
|
||||
```
|
||||
helm upgrade clearml-serving allegroai/clearml-serving --version <CURRENT CHART VERSION> -f custom_values.yaml
|
||||
helm upgrade clearml-serving clearml/clearml-serving --version <CURRENT CHART VERSION> -f custom_values.yaml
|
||||
```
|
||||
|
||||
{{ template "chart.sourcesSection" . }}
|
||||
|
@ -2,9 +2,9 @@ apiVersion: v2
|
||||
name: clearml
|
||||
description: MLOps platform
|
||||
type: application
|
||||
version: "7.14.2"
|
||||
version: "7.14.4"
|
||||
appVersion: "2.0"
|
||||
kubeVersion: ">= 1.21.0-0 < 1.32.0-0"
|
||||
kubeVersion: ">= 1.21.0-0 < 1.33.0-0"
|
||||
home: https://clear.ml
|
||||
icon: https://raw.githubusercontent.com/clearml/clearml/master/docs/clearml-logo.svg
|
||||
sources:
|
||||
@ -33,4 +33,4 @@ dependencies:
|
||||
annotations:
|
||||
artifacthub.io/changes: |
|
||||
- kind: fixed
|
||||
description: "ClearML org rename"
|
||||
description: "casted port to string before concatenation"
|
||||
|
@ -1,6 +1,6 @@
|
||||
# ClearML Ecosystem for Kubernetes
|
||||
|
||||
  
|
||||
  
|
||||
|
||||
MLOps platform
|
||||
|
||||
@ -141,7 +141,7 @@ For detailed instructions, see the [Optional Configuration](https://github.com/c
|
||||
|
||||
## Requirements
|
||||
|
||||
Kubernetes: `>= 1.21.0-0 < 1.32.0-0`
|
||||
Kubernetes: `>= 1.21.0-0 < 1.33.0-0`
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
|
@ -173,7 +173,7 @@ compose file url
|
||||
{{- end }}
|
||||
{{- printf "%s%s%s" $protocol "://" .Values.fileserver.ingress.hostName }}
|
||||
{{- else }}
|
||||
{{- printf "%s%s%s%s" "http://" (include "fileserver.referenceName" .) ":" .Values.fileserver.service.port }}
|
||||
{{- printf "%s%s%s%s" "http://" (include "fileserver.referenceName" .) ":" ( .Values.fileserver.service.port | toString ) }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user