elm-annotations.3.0.1.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 helm-annotations Show documentation

There is a newer version: 4.1.4

# Dekorate Autogenerated Notes

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

    
      io.dekorate
      helm-annotations
      ${project.version}
    

Build the project using:

    mvn clean install

You can find the generated Helm artifacts under: `target/classes/META-INF/dekorate/helm//` that should look like:
- Chart.yaml
- values.yaml
- templates/*.yml the generated resources by Dekorate

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

How can it be used?

First, make sure you have installed [the Helm command line](https://helm.sh/docs/intro/install/) and connected/logged to a kubernetes cluster.

Then, 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 -Ddekorate.push=true -Ddekorate.docker.registry= -Ddekorate.docker.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/classes/META-INF/dekorate/helm/
```

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/classes/META-INF/dekorate/helm/ --values ./target/classes/META-INF/dekorate/helm//values.dev.yaml
```

How can I update my deployment?

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

After making changes to your project, you would need to regenerate the resources using Dekorate:

```shell
mvn clean package
```

And then you need to upgrade your deployment:

```shell
helm upgrade helm-example ./target/classes/META-INF/dekorate/helm/
```

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

```shell
helm upgrade helm-example ./target/classes/META-INF/dekorate/helm/ --set app.replicas=1
```

How can we delete my deployment?

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