0.6.0

orf · orf · commit c195d21ad081 · 2024-11-25T13:37:32.000Z
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,35 @@
+---
+name: Release Charts
+
+on:
+  push:
+    branches:
+    - main
+
+jobs:
+  release:
+    # depending on default permission settings for your org (contents being read-only or read-write for workloads), you will have to add permissions
+    # see: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Configure Git
+      run: |
+        git config user.name "$GITHUB_ACTOR"
+        git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
+
+    - name: Install Helm
+      uses: azure/setup-helm@v4
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Run chart-releaser
+      uses: helm/chart-releaser-action@v1.6.0
+      env:
+        CR_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -14,6 +14,8 @@ repos:
     language: node
     name: schema-bundle
     pass_filenames: false
+    additional_dependencies:
+    - '@sourcemeta/jsonschema'
   - entry: ./scripts/test.sh
     id: helm-unittest
     language: script
diff --git a/charts/nhi-explorer/.helmignore b/charts/nhi-explorer/.helmignore
diff --git a/charts/nhi-explorer/Chart.yaml b/charts/nhi-explorer/Chart.yaml
@@ -1,6 +1,6 @@
 ---
 apiVersion: v2
-name: inventory-agent
+name: nhi-explorer
 description: A Helm chart for Kubernetes
 
 # A chart can be either an 'application' or a 'library' chart.
diff --git a/charts/nhi-explorer/templates/NOTES.txt b/charts/nhi-explorer/templates/NOTES.txt
@@ -2,7 +2,7 @@ Thank you for installing {{ .Chart.Name }}.
 
 Your release is named {{ .Release.Name }}.
 
-The agent will run with the following schedule: {{ .Values.inventory.schedule }}
+The container will run with the following schedule: {{ .Values.inventory.schedule }}
 
 To learn more about the release, try:
 
diff --git a/charts/nhi-explorer/templates/_helpers.tpl b/charts/nhi-explorer/templates/_helpers.tpl
@@ -1,7 +1,7 @@
 {{/*
 Expand the name of the chart.
 */}}
-{{- define "inventory-agent.name" -}}
+{{- define "nhi-explorer.name" -}}
 {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
@@ -10,7 +10,7 @@ Create a default fully qualified app name.
 We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
 If release name contains chart name it will be used as a full name.
 */}}
-{{- define "inventory-agent.fullname" -}}
+{{- define "nhi-explorer.fullname" -}}
 {{- if .Values.fullnameOverride }}
 {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
 {{- else }}
@@ -26,16 +26,16 @@ If release name contains chart name it will be used as a full name.
 {{/*
 Create chart name and version as used by the chart label.
 */}}
-{{- define "inventory-agent.chart" -}}
+{{- define "nhi-explorer.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
 {{/*
 Common labels
 */}}
-{{- define "inventory-agent.labels" -}}
-helm.sh/chart: {{ include "inventory-agent.chart" . }}
-{{ include "inventory-agent.selectorLabels" . }}
+{{- define "nhi-explorer.labels" -}}
+helm.sh/chart: {{ include "nhi-explorer.chart" . }}
+{{ include "nhi-explorer.selectorLabels" . }}
 {{- if .Chart.AppVersion }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
 {{- end }}
@@ -45,17 +45,17 @@ app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{/*
 Selector labels
 */}}
-{{- define "inventory-agent.selectorLabels" -}}
-app.kubernetes.io/name: {{ include "inventory-agent.name" . }}
+{{- define "nhi-explorer.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "nhi-explorer.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end }}
 
 {{/*
 Create the name of the service account to use
 */}}
-{{- define "inventory-agent.serviceAccountName" -}}
+{{- define "nhi-explorer.serviceAccountName" -}}
 {{- if .Values.serviceAccount.create }}
-{{- default (include "inventory-agent.fullname" .) .Values.serviceAccount.name }}
+{{- default (include "nhi-explorer.fullname" .) .Values.serviceAccount.name }}
 {{- else }}
 {{- default "default" .Values.serviceAccount.name }}
 {{- end }}
diff --git a/charts/nhi-explorer/templates/configmap.yaml b/charts/nhi-explorer/templates/configmap.yaml
@@ -1,8 +1,8 @@
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: {{ include "inventory-agent.fullname" . }}
+  name: {{ include "nhi-explorer.fullname" . }}
   labels:
-    {{- include "inventory-agent.labels" . | nindent 4 }}
+    {{- include "nhi-explorer.labels" . | nindent 4 }}
 data:
   config.yml: {{ toYaml .Values.inventory.config|quote }}
diff --git a/charts/nhi-explorer/templates/cronjob.yaml b/charts/nhi-explorer/templates/cronjob.yaml
@@ -1,9 +1,9 @@
 apiVersion: batch/v1
 kind: CronJob
 metadata:
-  name: {{ include "inventory-agent.fullname" . }}
+  name: {{ include "nhi-explorer.fullname" . }}
   labels:
-    {{- include "inventory-agent.labels" . | nindent 4 }}
+    {{- include "nhi-explorer.labels" . | nindent 4 }}
 spec:
   schedule: {{ toJson .Values.inventory.schedule  }}
   jobTemplate:
@@ -14,7 +14,7 @@ spec:
           annotations: {{- toJson . }}
           {{- end }}
           labels:
-            {{- include "inventory-agent.labels" . | nindent 12 }}
+            {{- include "nhi-explorer.labels" . | nindent 12 }}
             {{- with .Values.podLabels }}
             {{ toYaml . | nindent 12 }}
             {{- end }}
@@ -34,7 +34,7 @@ spec:
           {{- with .Values.imagePullSecrets }}
           imagePullSecrets: {{ toJson . }}
           {{- end }}
-          serviceAccountName: {{ include "inventory-agent.serviceAccountName" . }}
+          serviceAccountName: {{ include "nhi-explorer.serviceAccountName" . }}
           securityContext: {{ toJson .Values.podSecurityContext }}
           {{- with .Values.nodeSelector }}
           nodeSelector: {{ toJson . }}
@@ -52,4 +52,4 @@ spec:
               configMap:
                 # Provide the name of the ConfigMap containing the files you want
                 # to add to the container
-                name: {{ include "inventory-agent.fullname" . }}
+                name: {{ include "nhi-explorer.fullname" . }}
diff --git a/charts/nhi-explorer/templates/serviceaccount.yaml b/charts/nhi-explorer/templates/serviceaccount.yaml
@@ -2,9 +2,9 @@
 apiVersion: v1
 kind: ServiceAccount
 metadata:
-  name: {{ include "inventory-agent.serviceAccountName" . }}
+  name: {{ include "nhi-explorer.serviceAccountName" . }}
   labels:
-    {{- include "inventory-agent.labels" . | nindent 4 }}
+    {{- include "nhi-explorer.labels" . | nindent 4 }}
   {{- with .Values.serviceAccount.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}
diff --git a/charts/nhi-explorer/test_values.yaml b/charts/nhi-explorer/test_values.yaml
diff --git a/charts/nhi-explorer/tests/configmap_test.yaml b/charts/nhi-explorer/tests/configmap_test.yaml
@@ -16,7 +16,7 @@ tests:
       of: ConfigMap
   - matchRegex:
       path: metadata.name
-      pattern: -inventory-agent$
+      pattern: -nhi-explorer$
   - equal:
       path: data["config.yml"]
       value: |-
diff --git a/charts/nhi-explorer/tests/cronjob_test.yaml b/charts/nhi-explorer/tests/cronjob_test.yaml
@@ -14,10 +14,10 @@ tests:
       of: CronJob
   - matchRegex:
       path: metadata.name
-      pattern: -inventory-agent$
+      pattern: -nhi-explorer$
   - equal:
       path: spec.jobTemplate.spec.template.spec.containers[0].image
-      value: ghcr.io/gitguardian/gg-inventory-agent:latest
+      value: ghcr.io/gitguardian/gg-nhi-explorer:latest
 
 - it: should set schedule
   set:
@@ -70,7 +70,7 @@ tests:
       content:
         name: config
         configMap:
-          name: RELEASE-NAME-inventory-agent
+          name: RELEASE-NAME-nhi-explorer
   - contains:
       path: spec.jobTemplate.spec.template.spec.containers[0].env
       content:
diff --git a/charts/nhi-explorer/values-base-schema.schema.json b/charts/nhi-explorer/values-base-schema.schema.json
@@ -9,7 +9,7 @@
         "version": {"type": "string"},
         "schedule": {"type": "string"},
         "config": {
-          "$ref": "inventory-agent-config.schema.json"
+          "$ref": "inventory-config.schema.json"
         }
       },
       "required": ["config"]
diff --git a/charts/nhi-explorer/values.schema.json b/charts/nhi-explorer/values.schema.json
@@ -14,7 +14,7 @@
       "minProperties": 1,
       "properties": {
         "config": {
-          "$ref": "#/definitions/inventory-agent-config.schema.json"
+          "$ref": "#/definitions/inventory-config.schema.json"
         },
         "schedule": {
           "type": "string",
@@ -40,7 +40,7 @@
     ]
   },
   "definitions": {
-    "inventory-agent-config.schema.json": {
+    "inventory-config.schema.json": {
       "$schema": "http://json-schema.org/draft-07/schema#",
       "title": "Config",
       "type": "object",
@@ -54,13 +54,13 @@
           "minProperties": 0,
           "properties": {},
           "additionalProperties": {
-            "$ref": "#/definitions/inventory-agent-config.schema.json/definitions/FetchSource"
+            "$ref": "#/definitions/inventory-config.schema.json/definitions/FetchSource"
           }
         },
         "upload": {
           "anyOf": [
             {
-              "$ref": "#/definitions/inventory-agent-config.schema.json/definitions/UploadConfig"
+              "$ref": "#/definitions/inventory-config.schema.json/definitions/UploadConfig"
             },
             {
               "enum": [
@@ -294,7 +294,7 @@
                   "description": "Auth mode: using Conjur Cloud workloads or CyberArk identity service",
                   "allOf": [
                     {
-                      "$ref": "#/definitions/inventory-agent-config.schema.json/definitions/AuthMode"
+                      "$ref": "#/definitions/inventory-config.schema.json/definitions/AuthMode"
                     }
                   ]
                 },
diff --git a/charts/nhi-explorer/values.yaml b/charts/nhi-explorer/values.yaml
@@ -1,18 +1,18 @@
 ---
 # yaml-language-server: $schema=values.schema.json
-# Default values for inventory-agent.
+# Default values for nhi-explorer.
 
-# Options for the agent configuration.
+# Options for the inventory configuration.
 inventory:
-  # Specific version of the agent to use
-  version: 0.2.0
-  # Schedule to run the agent on
+  # Specific version of the image to use
+  version: 0.6.0
+  # Schedule to run the collection on
   schedule: '* * * * *'
   config:
 
 # This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/
 image:
-  repository: ghcr.io/gitguardian/gg-inventory-agent
+  repository: ghcr.io/gitguardian/gg-nhi-explorer
   # This sets the pull policy for images.
   pullPolicy: IfNotPresent
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/schemas/inventory-config.schema.json b/schemas/inventory-config.schema.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "inventory-agent-config.schema.json",
+  "$id": "inventory-config.schema.json",
   "title": "Config",
   "type": "object",
   "required": [
@@ -281,4 +281,4 @@
       }
     }
   }
-}
+}
diff --git a/scripts/bundle_schemas.sh b/scripts/bundle_schemas.sh
@@ -10,9 +10,9 @@ process_json_schema() {
   temp_dir="$(mktemp -d)"
   local bundled_path="${temp_dir}"/resolved.json
   echo "Bundling schema from ${base_values_schema_path} to ${bundled_path}"
-  npx --yes @sourcemeta/jsonschema bundle --resolve schemas/ "${base_values_schema_path}" --without-id > "${bundled_path}"
+  jsonschema bundle --resolve schemas/ "${base_values_schema_path}" --without-id > "${bundled_path}"
   echo "Normalizing schema from ${bundled_path} to ${values_schema_path}"
-  npx --yes @sourcemeta/jsonschema canonicalize "${bundled_path}" > "${values_schema_path}"
+  jsonschema canonicalize "${bundled_path}" > "${values_schema_path}"
 }
 
 for chart in charts/*/
