Add a readme and examples

Author: Thomas Forbes

.pre-commit-config.yaml

@@ -6,7 +6,7 @@ repos:
   - id: yamlfmt
     files: .*.(yaml|yml)
     exclude: (templates|.github)/
-    args: [--mapping, '2', --sequence, '2', --offset, '0']
+    args: [--mapping, '2', --sequence, '2', --offset, '0', --preserve-quotes, --preserve_null]
 - repo: local
   hooks:
   - entry: ./scripts/bundle_schemas.sh

README.md

@@ -1,5 +1,45 @@
 # GitGuardian NHI Helm Charts
 
+## Installation
+
+Add the repository to Helm with:
+
+```shell
+helm repo add gg-nhi https://gitguardian.github.io/nhi-explorer-helm-charts
+```
+
+Then install the explorer, with a values file (examples below):
+
+```shell
+helm upgrade explorer gg-nhi/nhi-explorer --install --values values.yml
+```
+
+An example values file that fetches from HashiCorp Vault:
+
+```yaml
+inventory:
+  # Run every 15 minutes
+  schedule: '*/15 * * * *'
+  config:
+    sources:
+      vault-secrets:
+        type: hashicorpvault
+        vault_address: "https://your-vault-address-here"
+        # Token configuration can be read from environment variables like so:
+        auth_token: "${HASHICORP_VAULT_TOKEN}"
+        fetch_all_versions: true
+        path: "secret/"
+
+# This needs to be created separately, and contain a `HASHICORP_VAULT_TOKEN` key with 
+# the token to use.
+envFrom:
+  - secretRef:
+      name: hashicorpvault-secrets
+```
+
+Other examples can be found in [charts/nhi-explorer/examples](charts/nhi-explorer/examples).
+
+
 ## Development
 
 Install the [helm unittest plugin](https://github.com/helm-unittest/helm-unittest)

charts/nhi-explorer/Chart.yaml

@@ -16,7 +16,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.5
+version: 0.1.6
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/nhi-explorer/examples/k8s/secret.yaml

@@ -0,0 +1,8 @@
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: test-secret
+stringData:
+  secret-one: "some-secret-value"
+  secret-two: "another-secret-value"

charts/nhi-explorer/examples/k8s/values_k8s.yaml

@@ -0,0 +1,8 @@
+---
+# yaml-language-server: $schema=../../values.schema.json
+
+inventory:
+  config:
+    sources:
+      vault-secrets:
+        type: k8s

charts/nhi-explorer/values.yaml

@@ -8,8 +8,9 @@ inventory:
   version: 0.6.1
   upload: false
   # Schedule to run the collection on
-  schedule: '* * * * *'
-  config:
+  schedule: '*/15 * * * *'
+  # Need to add this explicitly
+  config: null
 
 # This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/
 image: