Annotations

You can manage the extra annotations of the different Kubernetes objects deployed by Qovery directly from the Qovery console.

In order to have a centralized section to manage the annotations, you can create annotation groups in the Annotations section within the organization settings and then link them to the services.

As a Qovery service is mapped to multiple Kubernetes objects (pods, deployments, ingress etc..) you will be able to define the kubernetes scope.

How to access your annotations section

Create an annotation group

You can create a new annotation group by pressing the Add annotation button. You need to provide:

  • A group name
  • The different annotations keys/values constituting the group. The key/value have to respect a certain syntax, check the official Kubernetes documentation to learn more.
  • A scope: this allows you to define the kubernetes objects where the extra annotations should be applied. Example: If you make your application accessible publicly and add an annotation group with the scope set to ingress, all annotations within that group will only be added to the ingress of your service.

Example:

Annotation group form

Once validated the annotation group will be displayed on the interface.

You can now apply it your applications, cronjobs, lifecycle jobs and database containers.

Edit an annotation group

You can edit your annotation group to add/remove/edit labels or update the scope. If this annotation group was already used in your services. You will have to redeploy them for these changes to be taken into account.

Delete an annotation group

You can delete an annotation group. If this annotation group was already used in your services. You will have to redeploy them for removing the annotations linked to your services.