Skip to content

Commit 48e7a93

Browse files
andreyvelichandreyvelich
authored
fix(manifests): Remove the default tag from the controller image (#2916)
* fix(manifests): Remove the default tag from the controller image Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com> * Fix README template Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com> --------- Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
1 parent bfccb7b commit 48e7a93

File tree

3 files changed

+18
-64
lines changed

3 files changed

+18
-64
lines changed

‎charts/kubeflow-trainer/README.md‎

Lines changed: 10 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -17,44 +17,20 @@ This chart bootstraps a [Kubernetes Trainer](https://github.com/kubeflow/trainer
1717

1818
## Usage
1919

20-
### Add Helm Repo
20+
### Install the Helm Chart
2121

22-
```bash
23-
helm repo add kubeflow-trainer https://kubeflow.github.io/trainer
24-
25-
helm repo update
26-
```
27-
28-
See [helm repo](https://helm.sh/docs/helm/helm_repo) for command documentation.
29-
30-
### Install the chart
22+
Install the released version (e.g. 2.1.0):
3123

3224
```bash
33-
helm install [RELEASE_NAME] kubeflow-trainer/kubeflow-trainer
34-
```
35-
36-
For example, if you want to create a release with name `kubeflow-trainer` in the `kubeflow-system` namespace:
37-
38-
```shell
39-
helm upgrade kubeflow-trainer kubeflow-trainer/kubeflow-trainer \
40-
--install \
41-
--namespace kubeflow-system \
42-
--create-namespace
25+
helm install kubeflow-trainer oci://ghcr.io/kubeflow/charts/kubeflow-trainer --version 2.1.0
4326
```
4427

45-
Note that by passing the `--create-namespace` flag to the `helm install` command, `helm` will create the release namespace if it does not exist.
46-
If you have already installed jobset controller/webhook, you can skip installing it by adding `--set jobset.install=false` to the command arguments.
47-
48-
See [helm install](https://helm.sh/docs/helm/helm_install) for command documentation.
49-
50-
### Upgrade the chart
28+
Alternatively, you can install the latest version from the master branch (e.g. `bfccb7b` commit):
5129

52-
```shell
53-
helm upgrade [RELEASE_NAME] kubeflow-trainer/kubeflow-trainer [flags]
30+
```bash
31+
helm install kubeflow-trainer oci://ghcr.io/kubeflow/charts/kubeflow-trainer --version 0.0.0-sha-bfccb7b
5432
```
5533

56-
See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade) for command documentation.
57-
5834
### Uninstall the chart
5935

6036
```shell
@@ -72,10 +48,11 @@ See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall) for command docum
7248
| nameOverride | string | `""` | String to partially override release name. |
7349
| fullnameOverride | string | `""` | String to fully override release name. |
7450
| jobset.install | bool | `true` | Whether to install jobset as a dependency managed by trainer. This must be set to `false` if jobset controller/webhook has already been installed into the cluster. |
51+
| jobset.fullnameOverride | string | `"jobset"` | String to fully override jobset release name. |
7552
| commonLabels | object | `{}` | Common labels to add to the resources. |
7653
| image.registry | string | `"ghcr.io"` | Image registry. |
7754
| image.repository | string | `"kubeflow/trainer/trainer-controller-manager"` | Image repository. |
78-
| image.tag | string | `"latest"` | Image tag. |
55+
| image.tag | string | `""` | Image tag. Defaults to the chart appVersion. |
7956
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy. |
8057
| image.pullSecrets | list | `[]` | Image pull secrets for private image registry. |
8158
| manager.replicas | int | `1` | Number of replicas of manager. |
@@ -89,7 +66,8 @@ See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall) for command docum
8966
| manager.envFrom | list | `[]` | Environment variable sources for manager containers. |
9067
| manager.volumeMounts | list | `[]` | Volume mounts for manager containers. |
9168
| manager.resources | object | `{}` | Pod resource requests and limits for manager containers. |
92-
| manager.securityContext | object | `{}` | Security context for manager containers. |
69+
| manager.securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"runAsNonRoot":true,"seccompProfile":{"type":"RuntimeDefault"}}` | Security context for manager containers. |
70+
| manager.config | object | `{"certManagement":{"enable":true,"webhookSecretName":"","webhookServiceName":""},"controller":{"groupKindConcurrency":{"clusterTrainingRuntime":1,"trainJob":5,"trainingRuntime":1}},"health":{"healthProbeBindAddress":":8081","livenessEndpointName":"healthz","readinessEndpointName":"readyz"},"leaderElection":{"leaderElect":true,"leaseDuration":"15s","renewDeadline":"10s","resourceName":"trainer.kubeflow.org","resourceNamespace":"","retryPeriod":"2s"},"metrics":{"bindAddress":":8443","secureServing":true},"webhook":{"host":"","port":9443}}` | Controller manager configuration. This configuration is used to generate the ConfigMap for the controller manager. |
9371
| webhook.failurePolicy | string | `"Fail"` | Specifies how unrecognized errors are handled. Available options are `Ignore` or `Fail`. |
9472

9573
## Maintainers

‎charts/kubeflow-trainer/README.md.gotmpl‎

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -35,44 +35,20 @@ This chart bootstraps a [Kubernetes Trainer]({{template "chart.homepage" . }}) d
3535

3636
## Usage
3737

38-
### Add Helm Repo
38+
### Install the Helm Chart
3939

40-
```bash
41-
helm repo add kubeflow-trainer https://kubeflow.github.io/trainer
42-
43-
helm repo update
44-
```
45-
46-
See [helm repo](https://helm.sh/docs/helm/helm_repo) for command documentation.
47-
48-
### Install the chart
40+
Install the released version (e.g. 2.1.0):
4941

5042
```bash
51-
helm install [RELEASE_NAME] kubeflow-trainer/kubeflow-trainer
52-
```
53-
54-
For example, if you want to create a release with name `kubeflow-trainer` in the `kubeflow-system` namespace:
55-
56-
```shell
57-
helm upgrade kubeflow-trainer kubeflow-trainer/kubeflow-trainer \
58-
--install \
59-
--namespace kubeflow-system \
60-
--create-namespace
43+
helm install kubeflow-trainer oci://ghcr.io/kubeflow/charts/kubeflow-trainer --version 2.1.0
6144
```
6245

63-
Note that by passing the `--create-namespace` flag to the `helm install` command, `helm` will create the release namespace if it does not exist.
64-
If you have already installed jobset controller/webhook, you can skip installing it by adding `--set jobset.install=false` to the command arguments.
65-
66-
See [helm install](https://helm.sh/docs/helm/helm_install) for command documentation.
67-
68-
### Upgrade the chart
46+
Alternatively, you can install the latest version from the master branch (e.g. `bfccb7b` commit):
6947

70-
```shell
71-
helm upgrade [RELEASE_NAME] kubeflow-trainer/kubeflow-trainer [flags]
48+
```bash
49+
helm install kubeflow-trainer oci://ghcr.io/kubeflow/charts/kubeflow-trainer --version 0.0.0-sha-bfccb7b
7250
```
7351

74-
See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade) for command documentation.
75-
7652
### Uninstall the chart
7753

7854
```shell

‎charts/kubeflow-trainer/values.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ image:
3939
registry: ghcr.io
4040
# -- Image repository.
4141
repository: kubeflow/trainer/trainer-controller-manager
42-
# -- Image tag.
43-
tag: latest
42+
# -- Image tag. Defaults to the chart appVersion.
43+
tag: ""
4444
# -- Image pull policy.
4545
pullPolicy: IfNotPresent
4646
# -- Image pull secrets for private image registry.

0 commit comments

Comments
 (0)