ClearML/clearml-helm-charts
1
0
Fork 0
mirror of https://github.com/clearml/clearml-helm-charts synced 2025-02-12 07:26:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

edits (#168)

Browse Source
This commit is contained in:
pollfly 2023-02-16 14:25:00 +02:00 committed by GitHub
parent fded7aa5b4
commit 013734c184
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
INSTALL.md
View File

@ -2,29 +2,17 @@
## Requirements ## Requirements
### Setup a Kubernetes Cluster * 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 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 setting up ClearML on an Openshift cluster,
For setting up Kubernetes on various platforms refer to the Kubernetes [getting started guide](http://kubernetes.io/docs/getting-started-guides/). * 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.
#### Setup a single node LOCAL Kubernetes on laptop/desktop (development) ## Helm Charts Installation
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 ### Helm Repo
@ -32,25 +20,27 @@ To install Helm, refer to the [Helm install guide](https://github.com/helm/helm#
$ helm repo add allegroai https://allegroai.github.io/clearml-helm-charts $ helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
$ helm repo update $ helm repo update
``` ```
### ClearML server ecosystem ### ClearML Server Ecosystem
```bash ```bash
$ helm install clearml allegroai/clearml $ helm install clearml allegroai/clearml
``` ```
### ClearML agent ### 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). A ClearML Agent is always related to a ClearML server ecosystem (by default using the `app.clear.ml` hosted server, but
can be on the same or different Kubernetes cluster or a single server installation).
On ClearML UI, Settings -> Workspace and Create new Credentials. In the ClearML UI, go to **Settings > Workspace** and click **Create New Credentials**. The dialog that pops up displays
the new credentials.
In following Helm chart install command: In the Helm chart `install` command below:
* set ACCESSKEY to resuted credentials access_key * Set `ACCESSKEY` to the new credentials' `access_key` value
* set SECRETKEY to resuted credentials secret_key * Set `SECRETKEY` to the new credentials' `secret_key` value
* set APIERVERURL to resuted credentials api_server * Set `APISERVERURL` to the new credentials' `api_server` value
* set FILESSERVERURL to resuted credentials files_server * Set `FILESSERVERURL` to the new credentials' `files_server` value
* set WEBSERVERURL to resuted credentials web_server * Set `WEBSERVERURL` to the new credentials' `web_server` value
```bash ```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 allegroai/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
View File

@ -31,32 +31,32 @@ Use this repository to deploy **clearml-server** on Kubernetes clusters.
## Who We Are ## Who We Are
ClearML is supported by the team behind *allegro.ai*, ClearML is supported by you :heart: and the [clear.ml](https://clear.ml) team, which helps enterprise companies build
where we build deep learning pipelines and infrastructure for enterprise companies. scalable MLOps.
We built ClearML to track and control the glorious but messy process of training production-grade deep learning models. We built ClearML to track and control the glorious but messy process of training production-grade deep learning models.
We are committed to vigorously supporting and expanding the capabilities of ClearML. We are committed to vigorously supporting and expanding the capabilities of ClearML.
We promise to always be backwardly compatible, making sure all your logs, data and pipelines We promise to always be backwards compatible, making sure all your logs, data, and pipelines
will always upgrade with you. will always upgrade with you.
## License ## License
Apache License, Version 2.0, (see the [LICENSE](https://www.apache.org/licenses/LICENSE-2.0) for more information) Apache License, Version 2.0, (see the [LICENSE](https://www.apache.org/licenses/LICENSE-2.0) for more information)
## Installation guide ## Installation Guide
For installation instruction, follow related [Installation Guide](INSTALL.md). For installation instruction, follow related [Installation Guide](INSTALL.md).
## Documentation, Community & Support ## Documentation, Community & Support
More information in the [official documentation](https://allegro.ai/clearml/docs) and [on YouTube](https://www.youtube.com/c/ClearML). See more information in the [official documentation](https://clear.ml/docs/latest/docs) and [on YouTube](https://www.youtube.com/c/ClearML).
If you have any questions: post on our [Slack Channel](https://join.slack.com/t/clearml/shared_invite/zt-c0t13pty-aVUZZW1TSSSg2vyIGVPBhg), 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*). If you have any questions, post on our [Slack Channel](https://join.slack.com/t/clearml/shared_invite/zt-c0t13pty-aVUZZW1TSSSg2vyIGVPBhg), 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/allegroai/clearml-helm-charts/issues).
Additionally, you can always find us at *clearml@allegro.ai* Additionally, you can always find us at *support@clear.ml*
## Contributing ## Contributing