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

Improve informations on README (#186)

Browse Source 
* Changed: docs sections

* Added: comment on top

* Changed: version bump
This commit is contained in:
Valeriano Manassero 2023-03-16 13:40:02 +01:00 committed by GitHub
parent a69530d07a
commit 6d9771be41
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 44 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
charts/clearml-agent/Chart.yaml
View File

@ -2,7 +2,7 @@ apiVersion: v2
name: clearml-agent
description: MLOps platform Task running agent
type: application
version: "4.0.0"
version: "4.0.1"
appVersion: "1.24"
kubeVersion: ">= 1.21.0-0 < 1.27.0-0"
home: https://clear.ml
@ -20,11 +20,6 @@ keywords:
- "task agent"
annotations:
artifacthub.io/changes: |
- kind: added
description: podSecurityContext/containerSecurityContext split
- kind: added
description: images version update
- kind: added
description: non-root non-privileged mode
- kind: added
description: global registry parameter
- kind: changed
description: informational stuff refactoring

11
charts/clearml-agent/README.md
View File

@ -1,6 +1,6 @@
# ClearML Kubernetes Agent
![Version: 4.0.0](https://img.shields.io/badge/Version-4.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.24](https://img.shields.io/badge/AppVersion-1.24-informational?style=flat-square)
![Version: 4.0.1](https://img.shields.io/badge/Version-4.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.24](https://img.shields.io/badge/AppVersion-1.24-informational?style=flat-square)
MLOps platform Task running agent
@ -40,12 +40,17 @@ Before issuing helm upgrade:
* if using securityContexts check for new value form in values.yaml (podSecurityContext and containerSecurityContext)
## Non root/privileged environments
## ENTERPRISE Version
There are some specific Enterprise version features that can be enabled only with specific Enterprise licensed images.
Enabling this features on OSS version can cause the entire installation to break.
### Non root/privileged environments
*This feature is available for Enterprise version only*
In environments like Openshift or Tanzu it can be required to run non-root/non-privileged pods/containers.
In this case it's recommended to use values-non-root-privileged.yaml as base for override file.
In this case it's recommended to use `values-enterprise-non-root-privileged.yaml` as base for override file.
Keep in mind it's not possible to install packages on non-root containers so images used for Tasks must already have python and pip installed.

9
charts/clearml-agent/README.md.gotmpl
View File

@ -37,12 +37,17 @@ Before issuing helm upgrade:
* if using securityContexts check for new value form in values.yaml (podSecurityContext and containerSecurityContext)
## Non root/privileged environments
## ENTERPRISE Version
There are some specific Enterprise version features that can be enabled only with specific Enterprise licensed images.
Enabling this features on OSS version can cause the entire installation to break.
### Non root/privileged environments
*This feature is available for Enterprise version only*
In environments like Openshift or Tanzu it can be required to run non-root/non-privileged pods/containers.
In this case it's recommended to use values-non-root-privileged.yaml as base for override file.
In this case it's recommended to use `values-enterprise-non-root-privileged.yaml` as base for override file.
Keep in mind it's not possible to install packages on non-root containers so images used for Tasks must already have python and pip installed.

4
charts/clearml-agent/values-non-root-privileged.yaml → charts/clearml-agent/values-enterprise-non-root-privileged.yaml
View File

@ -1,3 +1,7 @@
# These values are for ENTERPRISE version only and they need to be adapted to specific infrastructure needs
# containerSecurityContext is highly related to Kubernetes distribution used/configuration and will probably
# need to be customized accordingly
agentk8sglue:
defaultContainerImage: "python:3.9"
containerSecurityContext:

14
charts/clearml/Chart.yaml
View File

@ -2,7 +2,7 @@ apiVersion: v2
name: clearml
description: MLOps platform
type: application
version: "6.0.0"
version: "6.0.1"
appVersion: "1.9.2"
kubeVersion: ">= 1.21.0-0 < 1.27.0-0"
home: https://clear.ml
@ -33,14 +33,4 @@ dependencies:
annotations:
artifacthub.io/changes: |
- kind: changed
description: dependency chart updates
- kind: changed
description: improved securityContexts
- kind: added
description: images version update
- kind: added
description: non-root non-privileged mode
- kind: added
description: global registry parameter
- kind: added
description: services annotations
description: informational stuff refactoring

16
charts/clearml/README.md
View File

@ -1,6 +1,6 @@
# ClearML Ecosystem for Kubernetes
![Version: 6.0.0](https://img.shields.io/badge/Version-6.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.9.2](https://img.shields.io/badge/AppVersion-1.9.2-informational?style=flat-square)
![Version: 6.0.1](https://img.shields.io/badge/Version-6.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.9.2](https://img.shields.io/badge/AppVersion-1.9.2-informational?style=flat-square)
MLOps platform
@ -117,18 +117,18 @@ Before issuing helm upgrade:
* scale MongoDB deployment(s) replicas to 0
* if using securityContexts check for new value form in values.yaml (podSecurityContext and containerSecurityContext)
## Non root/privileged environments
*This feature is available for Enterprise version only*
In environments like Openshift or Tanzu it can be required to run non-root/non-privileged pods/containers.
In this case it's recommended to use values-non-root-privileged.yaml as base for override file.
## ENTERPRISE Version
There are some specific Enterprise version features that can be enabled only with specific Enterprise licensed images.
Enabling this features on OSS version can cause the entire installation to break.
### Non root/privileged environments
*This feature is available for Enterprise version only*
In environments like Openshift or Tanzu it can be required to run non-root/non-privileged pods/containers.
In this case it's recommended to use `values-enterprise-non-root-privileged.yaml` as base for override file.
## Additional Configuration for ClearML Server
You can also configure the **clearml-server** for:

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

@ -114,18 +114,18 @@ Before issuing helm upgrade:
* scale MongoDB deployment(s) replicas to 0
* if using securityContexts check for new value form in values.yaml (podSecurityContext and containerSecurityContext)
## Non root/privileged environments
*This feature is available for Enterprise version only*
In environments like Openshift or Tanzu it can be required to run non-root/non-privileged pods/containers.
In this case it's recommended to use values-non-root-privileged.yaml as base for override file.
## ENTERPRISE Version
There are some specific Enterprise version features that can be enabled only with specific Enterprise licensed images.
Enabling this features on OSS version can cause the entire installation to break.
### Non root/privileged environments
*This feature is available for Enterprise version only*
In environments like Openshift or Tanzu it can be required to run non-root/non-privileged pods/containers.
In this case it's recommended to use `values-enterprise-non-root-privileged.yaml` as base for override file.
## Additional Configuration for ClearML Server
You can also configure the **clearml-server** for:

4
charts/clearml/values-non-root-privileged.yaml → charts/clearml/values-enterprise-non-root-privileged.yaml
View File

@ -1,3 +1,7 @@
# These values are for ENTERPRISE version only and they need to be adapted to specific infrastructure needs
# containerSecurityContext is highly related to Kubernetes distribution used/configuration and will probably
# need to be customized accordingly
apiserver:
containerSecurityContext:
runAsUser: 1000