Skip to content

Commit

Permalink
Merge pull request #357 from Qovery/update_helm_documentation_labels
Browse files Browse the repository at this point in the history
Add warning on label/annotation to add
  • Loading branch information
jul-dan authored Dec 21, 2023
2 parents 19b5be3 + de5cfa3 commit cb09e65
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 1 deletion.
38 changes: 37 additions & 1 deletion website/docs/using-qovery/configuration/helm.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_modified_on: "2023-12-19"
last_modified_on: "2023-12-21"
title: "Helm"
description: "Learn how to configure your Helm on Qovery"
---
Expand Down Expand Up @@ -91,6 +91,24 @@ You can override values in the arguments section with the `--set` option.

</Alert>

<Alert type="warning">

If you want to get all the Qovery features (access your container logs, apply the stop/restart actions, display the pod status in the overview page), make sure to create an override and assign the macros `qovery.labels.service` and `qovery.annotations.service` to the labels and annotations of any deployed Pods/Deployments/Services/Jobs.

Override example:

```yaml
commonLabels:
mylabel: "test"
qovery.labels.service
annotations:
qovery.annotations.service
```
These macros will be automatically replaced by Qovery during the deployment phase.
</Alert>
You can use the Qovery environment variables as overrides by using the placeholder “qovery.env.<env_var_name>” (Example: qovery.env.DB_URL. Qovery will manage the replacement of those placeholders at deployment time.
</li>
Expand Down Expand Up @@ -222,6 +240,24 @@ You can override values in the arguments section with the `--set` option.

</Alert>

<Alert type="warning">

If you want to get all the Qovery features (access your container logs, apply the stop/restart actions, display the pod status in the overview page), make sure to create an override and assign the macros `qovery.labels.service` and `qovery.annotations.service` to the labels and annotations of any deployed Pods/Deployments/Services/Jobs.

Override example:

```yaml
commonLabels:
mylabel: "test"
qovery.labels.service
annotations:
qovery.annotations.service
```

These macros will be automatically replaced by Qovery during the deployment phase.

</Alert>

### Ports

Within this section you can define the port exposed publicly.
Expand Down
36 changes: 36 additions & 0 deletions website/docs/using-qovery/configuration/helm.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,24 @@ You can override values in the arguments section with the `--set` option.

</Alert>

<Alert type="warning">

If you want to get all the Qovery features (access your container logs, apply the stop/restart actions, display the pod status in the overview page), make sure to create an override and assign the macros `qovery.labels.service` and `qovery.annotations.service` to the labels and annotations of any deployed Pods/Deployments/Services/Jobs.

Override example:

```yaml
commonLabels:
mylabel: "test"
qovery.labels.service
annotations:
qovery.annotations.service
```

These macros will be automatically replaced by Qovery during the deployment phase.

</Alert>

You can use the Qovery environment variables as overrides by using the placeholder “qovery.env.<env_var_name>” (Example: qovery.env.DB_URL. Qovery will manage the replacement of those placeholders at deployment time.

</li>
Expand Down Expand Up @@ -210,6 +228,24 @@ You can override values in the arguments section with the `--set` option.

</Alert>

<Alert type="warning">

If you want to get all the Qovery features (access your container logs, apply the stop/restart actions, display the pod status in the overview page), make sure to create an override and assign the macros `qovery.labels.service` and `qovery.annotations.service` to the labels and annotations of any deployed Pods/Deployments/Services/Jobs.

Override example:

```yaml
commonLabels:
mylabel: "test"
qovery.labels.service
annotations:
qovery.annotations.service
```

These macros will be automatically replaced by Qovery during the deployment phase.

</Alert>

### Ports

Within this section you can define the port exposed publicly.
Expand Down

0 comments on commit cb09e65

Please sign in to comment.