GitGuardian NHI Helm Charts

Installation

Add the repository to Helm with:

helm repo add gg-nhi https://gitguardian.github.io/nhi-explorer-helm-charts

Then install the explorer, with a values file (examples below):

helm upgrade explorer gg-nhi/nhi-explorer --install --values values.yml

An example values file that fetches from HashiCorp Vault:

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/"
    # To upload, set the upload URL and tokens. Ensure the endpoint path ends with /v1
    # This is optional: omit this to prevent uploading and to only test collection.
    upload:
      endpoint: "https://your-gg-instance/v1"
      api_token: "${GG_API_TOKEN}"

# This needs to be created separately, and contain the following keys:
# - `HASHICORP_VAULT_TOKEN` - the hashicorp vault token to use
# - `GG_API_TOKEN` - the GitGuardian token to send results with
envFrom:
  - secretRef:
      name: inventory-explorer-secrets

Other examples can be found in charts/nhi-explorer/examples.

Development

Install the helm unittest plugin

$ helm plugin install https://github.com/helm-unittest/helm-unittest.git