Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A helm chart similar to the nuts-node #81

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rolandgroen
Copy link
Contributor

  • Added and tested a helm chart.
  • Documented with a README.md

  - Added and tested a helm chart.
  - Documented with a README.md
@woutslakhorst
Copy link
Member

@JorisHeadease could you help reviewing this?

apiVersion: v2
name: nuts-registry-admin-demo-chart
description: A NUTS demo adin Helm chart for Kubernetes

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo in description adin

{{- regexReplaceAll ".*:([0-9]+)" .Values.nuts.config.network.grpcaddr "${1}" }}
{{- else }}
{{- default 5555}}
{{- end }}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This helper is probably not needed as it's specific to the nuts-node


admin:
config:
# Everything below `nuts.config` will be placed into the `nuts.yaml` config file of the Pods

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rename nuts.config and nuts.yaml to the actual values

Copy link

@JorisHeadease JorisHeadease left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the PR, added a few comments that require some changes

Comment on lines +51 to +66
Add the NUTS helm Repo with the following command:
```shell
helm repo add nuts-repo https://nuts-foundation.github.io/nuts-registry-admin-demo/
```
This should list available releases with the following command:
```shell
helm search repo nuts-registry-admin-demo
```

After this, the desired version can be installed with the following command:
```shell
helm repo update # Make sure we get the latest list of charts
helm install -f values.yaml <NAME> nuts-repo/nuts-registry-admin-demo-chart
```

Note that the `values.yaml` in the above command is the result from the [configuration step](#from-the-nuts-helm-repo).
Copy link

@JorisHeadease JorisHeadease Apr 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no GitHub action that deploys the chart to the nuts repo, so this will not be possible.

### Special properties
NUTS demo-adminn allows binding to specific interfaces on the host machines. In the case of Kubernetes, this is already
taken care
of. However, we do need to expose the `http` and `gRPC` ports. This is extracted from the following properties:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no exposed gRPC port in this project

All the configurable properties can be found at [./values.yaml](./values.yaml).

The configuration contains default Helm properties. In addition to these values,
there are `demo-admin` config properties. This contains 3 sections:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 sections

All the NUTS demo-admin information is persisted on [Persisted Volumes](https://kubernetes.
io/docs/concepts/storage/persistent-volumes/).

## Configure your NUTS node

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NUTS demo-admin, not NUTS node

| `admin.data` | Contains configurable properties for the `PersistedVolume` that will be created. This will be used to write all NUTS demo-admin data to. |

### Special properties
NUTS demo-adminn allows binding to specific interfaces on the host machines. In the case of Kubernetes, this is already

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo adminn

Note that the `values.yaml` in the above command is the result from the [configuration step](#from-the-nuts-helm-repo).

## Uninstalling NUTS
As the `PersistedVolume` can contain crucial data (like the private keys), by default, the uninstall command will not remove it and its

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not the case for this application, we should probably just clear everything up by default

Comment on lines +8 to +9
annotations:
"helm.sh/resource-policy": keep

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is probably not needed

Comment on lines +25 to +26
annotations:
"helm.sh/resource-policy": keep

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is probably not needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants