e.helm.quarkus-helm-deployment.1.2.2.source-code.NOTES.template.txt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-helm-deployment Show documentation

There is a newer version: 1.2.6

Show newest version

# Quarkus Helm Notes

To access the Helm annotations or properties you just need to have the following dependency in your
class path:

    
        io.quarkiverse.helm
        quarkus-helm
        {quarkus-helm-version}
    

Build the project using:

    mvn clean package

You can find the generated Helm artifacts under: `target/helm/kubernetes//` that should look like:
- Chart.yaml
- values.yaml
- templates/*.yml the generated resources by Quarkus Helm

**Note**: The `` is set from either the property `quarkus.helm.name` or the `@HelmChart` annotation or the Quarkus application.

# Requirements

- Have installed [the Helm command line](https://helm.sh/docs/intro/install/)
- Have connected/logged to a kubernetes cluster
- Configure your Quarkus application to use any of the Quarkus Kubernetes extensions like Quarkus Kubernetes, Quarkus OpenShift or Quarkus Knative.
- Configure your Quarkus application to use any of [the Quarkus Container Image extensions](https://quarkus.io/guides/container-image) - This example uses `container-image-docker`.

# How can it be used?

You can run the following Maven command in order to generate the Helm artifacts and build/push the image into a container registry:

```shell
mvn clean package -Dquarkus.container-image.build=true -Dquarkus.container-image.push=true -Dquarkus.container-image.registry= -Dquarkus.container-image.group=
```

This command will push the image to a container registry and will become available when a pod or container is created.

Finally, let's use Helm to deploy it into the cluster:

```shell
helm install helm-example ./target/helm/kubernetes/
```

The above command will deploy a chart using the default values (as defined within the `values.yaml` file). We can override the default values to use your `values.dev.yaml` file by executing the following command:

```shell
helm install helm-example ./target/helm/kubernetes/ --values ./target/helm//kubernetes/values.dev.yaml
```

How can I update my deployment?

- Via the `upgrade` option of Helm command line:

After making changes to your project and regenerating the Helm resources and the application container image, then you need to upgrade your deployment:

```shell
helm upgrade helm-example ./target/helm/kubernetes/
```

- Via the `set` option of Helm command line:

```shell
helm upgrade helm-example ./target/helm/kubernetes/ --set .replicas=1
```

How can we delete my deployment?

```shell
helm uninstall helm-example
```