Skip to content

Commit

Permalink
remove unnecessary macros helm (#407)
Browse files Browse the repository at this point in the history
* remove unnecessary macros helm

* Update helm tutos
  • Loading branch information
jul-dan authored Apr 10, 2024
1 parent a1e4356 commit adda500
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 180 deletions.
49 changes: 7 additions & 42 deletions website/docs/using-qovery/configuration/helm.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_modified_on: "2024-02-28"
last_modified_on: "2024-04-10"
title: "Helm"
description: "Learn how to configure your Helm on Qovery"
---
Expand Down Expand Up @@ -93,7 +93,7 @@ If you want to override it with a raw yaml you will have to click on `Create ove
<Alert type="warning">

- Git repository source is recommended as the raw yaml is not versioned.
- On both file types you can add `Qovery Macros` to add more functionalities to your helm deployment. Check [the section below][docs.using-qovery.configuration.helm#qovery-macros] before moving forward with your helm chart creation.
- On both file types you can use your environment variables in your chart. Check [the section below][docs.using-qovery.configuration.helm#using-the-environment-variables-in-your-chart].

</Alert>

Expand All @@ -115,7 +115,7 @@ Add a new variable by declaring:
<Alert type="warning">

- You can combine override as file and override as argument but, in case of collision, the priority will be given to the override as argument.
- You can add `Qovery Macros` to add more functionalities to your helm deployment. Check [the section below][docs.using-qovery.configuration.helm#qovery-macros] before moving forward with your helm chart creation.
- You can use your environment variables in your chart. Check [the section below][docs.using-qovery.configuration.helm#using-the-environment-variables-in-your-chart].

</Alert>

Expand Down Expand Up @@ -208,7 +208,7 @@ If you want to override it from another already existing values file from a Git
** Raw YAML **
If you want to override it with a raw yaml you will have to click on `Create override`. A new editor modal will be opened, to let you write your yaml override. The default values.yaml content will be displayed on the right to help you to respect the structure.

On both file types you can add `Qovery Macros` to add more functionalities to your helm deployment. Check [the section below][docs.using-qovery.configuration.helm#qovery-macros].
On both file types you can use your environment variables in your chart. Check [the section below][docs.using-qovery.configuration.helm#using-the-environment-variables-in-your-chart].

#### Override as arguments

Expand All @@ -225,9 +225,9 @@ You can combine override as file and override as argument but, in case of collis

</Alert>

You can add `Qovery Macros` to add more functionalities to your helm deployment. Check [the section below][docs.using-qovery.configuration.helm#qovery-macros].
You can use your environment variables in your chart. Check [the section below][docs.using-qovery.configuration.helm#using-the-environment-variables-in-your-chart].

#### Qovery macros
#### Using the environment variables in your chart

Qovery allows you to use the following macros within your override file. These macros will be automatically replaced by Qovery during the deployment phase, allowing you to access additional functionalities.

Expand All @@ -246,41 +246,6 @@ postgres:
password: qovery.env.DB_PASSWORD
```
** Enable all the Qovery features **
* Macro for labels: `qovery.labels.service`
* Macro for annotations: `qovery.annotations.service`

It allows to add all the labels and annotations required to activate all the Qovery features on the deployed Helm chart (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 macro to the labels of **any deployed Pods/Deployments/Services/Jobs**.

Example:

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

When your Pods/Deployments/Services/Jobs are deployed, you should see Qovery labels and annotations added to the resources. Something like:

```yaml
apiVersion: v1
kind: Pod
metadata:
labels:
qovery.com/environment-id: 00000000-0000-0000-0000-000000000000
qovery.com/project-id: 00000000-0000-0000-0000-000000000000
qovery.com/service-id: 00000000-0000-0000-0000-000000000000
qovery.com/service-type: helm
...
annotations:
qovery.com/service-version: application:x.y.z
...
```

### Ports
Within this section you can define the port exposed publicly.
Expand Down Expand Up @@ -442,7 +407,7 @@ In the helm overview, click on the `3 dots` button and remove the helm.
[docs.using-qovery.configuration.advanced-settings#network-settings]: /docs/using-qovery/configuration/advanced-settings/#network-settings
[docs.using-qovery.configuration.advanced-settings]: /docs/using-qovery/configuration/advanced-settings/
[docs.using-qovery.configuration.environment]: /docs/using-qovery/configuration/environment/
[docs.using-qovery.configuration.helm#qovery-macros]: /docs/using-qovery/configuration/helm/#qovery-macros
[docs.using-qovery.configuration.helm#using-the-environment-variables-in-your-chart]: /docs/using-qovery/configuration/helm/#using-the-environment-variables-in-your-chart
[docs.using-qovery.configuration.organization.helm-repository]: /docs/using-qovery/configuration/organization/helm-repository/
[docs.using-qovery.configuration.organization.members-rbac]: /docs/using-qovery/configuration/organization/members-rbac/
[docs.using-qovery.deployment.logs#live-logs]: /docs/using-qovery/deployment/logs/#live-logs
Expand Down
45 changes: 5 additions & 40 deletions website/docs/using-qovery/configuration/helm.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ If you want to override it with a raw yaml you will have to click on `Create ove
<Alert type="warning">

- Git repository source is recommended as the raw yaml is not versioned.
- On both file types you can add `Qovery Macros` to add more functionalities to your helm deployment. Check [the section below][docs.using-qovery.configuration.helm#qovery-macros] before moving forward with your helm chart creation.
- On both file types you can use your environment variables in your chart. Check [the section below][docs.using-qovery.configuration.helm#using-the-environment-variables-in-your-chart].

</Alert>

Expand All @@ -103,7 +103,7 @@ Add a new variable by declaring:
<Alert type="warning">

- You can combine override as file and override as argument but, in case of collision, the priority will be given to the override as argument.
- You can add `Qovery Macros` to add more functionalities to your helm deployment. Check [the section below][docs.using-qovery.configuration.helm#qovery-macros] before moving forward with your helm chart creation.
- You can use your environment variables in your chart. Check [the section below][docs.using-qovery.configuration.helm#using-the-environment-variables-in-your-chart].

</Alert>

Expand Down Expand Up @@ -196,7 +196,7 @@ If you want to override it from another already existing values file from a Git
** Raw YAML **
If you want to override it with a raw yaml you will have to click on `Create override`. A new editor modal will be opened, to let you write your yaml override. The default values.yaml content will be displayed on the right to help you to respect the structure.

On both file types you can add `Qovery Macros` to add more functionalities to your helm deployment. Check [the section below][docs.using-qovery.configuration.helm#qovery-macros].
On both file types you can use your environment variables in your chart. Check [the section below][docs.using-qovery.configuration.helm#using-the-environment-variables-in-your-chart].

#### Override as arguments

Expand All @@ -213,9 +213,9 @@ You can combine override as file and override as argument but, in case of collis

</Alert>

You can add `Qovery Macros` to add more functionalities to your helm deployment. Check [the section below][docs.using-qovery.configuration.helm#qovery-macros].
You can use your environment variables in your chart. Check [the section below][docs.using-qovery.configuration.helm#using-the-environment-variables-in-your-chart].

#### Qovery macros
#### Using the environment variables in your chart

Qovery allows you to use the following macros within your override file. These macros will be automatically replaced by Qovery during the deployment phase, allowing you to access additional functionalities.

Expand All @@ -234,41 +234,6 @@ postgres:
password: qovery.env.DB_PASSWORD
```

** Enable all the Qovery features **

* Macro for labels: `qovery.labels.service`
* Macro for annotations: `qovery.annotations.service`

It allows to add all the labels and annotations required to activate all the Qovery features on the deployed Helm chart (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 macro to the labels of **any deployed Pods/Deployments/Services/Jobs**.

Example:

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

When your Pods/Deployments/Services/Jobs are deployed, you should see Qovery labels and annotations added to the resources. Something like:

```yaml
apiVersion: v1
kind: Pod
metadata:
labels:
qovery.com/environment-id: 00000000-0000-0000-0000-000000000000
qovery.com/project-id: 00000000-0000-0000-0000-000000000000
qovery.com/service-id: 00000000-0000-0000-0000-000000000000
qovery.com/service-type: helm
...
annotations:
qovery.com/service-version: application:x.y.z
...
```

### Ports

Within this section you can define the port exposed publicly.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_modified_on: "2024-01-05"
last_modified_on: "2024-04-10"
$schema: "/.meta/.schemas/guides.json"
title: Kubernetes observability and monitoring with Datadog
description: How to integrate Datadog with Kubernetes on Qovery.
Expand Down Expand Up @@ -83,38 +83,6 @@ datadog:
site: datadoghq.eu
# Update the cluster name with the name of your choice
clusterName: qoverycluster

# in the section below, we are adding Qovery macros in order to automatically add a set
# of labels and annotations to the deployed Pods/Deployments/services etc.. This is not
# mandatory to install Datadog itself but it allows you to fully benefit from the Qovery
# functionalities (Display application logs, restart pods etc..). See the official Qovery
# Helm documentation for more information.
commonLabels:
qovery.labels.service

clusterAgent:
deploymentAnnotations:
qovery.annotations.service
podAnnotations:
qovery.annotations.service
additionalLabels:
qovery.labels.service

agents:
daemonsetAnnotations:
qovery.annotations.service
podAnnotations:
qovery.annotations.service
additionalLabels:
qovery.labels.service

clusterChecksRunner:
deploymentAnnotations:
qovery.annotations.service
podAnnotations:
qovery.annotations.service
additionalLabels:
qovery.labels.service
```
There are many other values you can set and modify the Datadog agent behaviour. For advanced usage, check: https://github.com/Datadog/helm-charts/blob/main/charts/datadog/values.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,38 +72,6 @@ datadog:
site: datadoghq.eu
# Update the cluster name with the name of your choice
clusterName: qoverycluster

# in the section below, we are adding Qovery macros in order to automatically add a set
# of labels and annotations to the deployed Pods/Deployments/services etc.. This is not
# mandatory to install Datadog itself but it allows you to fully benefit from the Qovery
# functionalities (Display application logs, restart pods etc..). See the official Qovery
# Helm documentation for more information.
commonLabels:
qovery.labels.service

clusterAgent:
deploymentAnnotations:
qovery.annotations.service
podAnnotations:
qovery.annotations.service
additionalLabels:
qovery.labels.service

agents:
daemonsetAnnotations:
qovery.annotations.service
podAnnotations:
qovery.annotations.service
additionalLabels:
qovery.labels.service

clusterChecksRunner:
deploymentAnnotations:
qovery.annotations.service
podAnnotations:
qovery.annotations.service
additionalLabels:
qovery.labels.service
```

There are many other values you can set and modify the Datadog agent behaviour. For advanced usage, check: https://github.com/Datadog/helm-charts/blob/main/charts/datadog/values.yaml
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_modified_on: "2024-01-12"
last_modified_on: "2024-04-10"
$schema: "/.meta/.schemas/guides.json"
title: Monitor and reduce Kubernetes spend with Kubecost
description: How to deploy Kubecost with Qovery
Expand Down Expand Up @@ -79,23 +79,7 @@ Deploy the Kubecost helm chart in your Qovery environment by following [this doc
```yaml
kubecostToken: qovery.env.KUBECOST_TOKEN #Used only if you have a Kubecost Token

global:
podAnnotations:
qovery.annotations.service
additionalLabels:
qovery.labels.service
```
<Alert type="info">
These are necessary to get all Qovery features, check [this documentation][docs.using-qovery.configuration.helm] for more information.
</Alert>
<Alert type="warning">
Currently it is not possible to **Stop** the Kubecost helm service. You can Start/Update/Delete it.
</Alert>
Then click on `Create and Deploy`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,23 +68,7 @@ Deploy the Kubecost helm chart in your Qovery environment by following [this doc
```yaml
kubecostToken: qovery.env.KUBECOST_TOKEN #Used only if you have a Kubecost Token

global:
podAnnotations:
qovery.annotations.service
additionalLabels:
qovery.labels.service
```
<Alert type="info">

These are necessary to get all Qovery features, check [this documentation][docs.using-qovery.configuration.helm] for more information.

</Alert>

<Alert type="warning">

Currently it is not possible to **Stop** the Kubecost helm service. You can Start/Update/Delete it.

</Alert>

Then click on `Create and Deploy`

Expand Down

0 comments on commit adda500

Please sign in to comment.