diff --git a/.helmdocsignore b/.helmdocsignore index 66e102cb..07926e47 100644 --- a/.helmdocsignore +++ b/.helmdocsignore @@ -1,6 +1,5 @@ confluence-server jira-software -k8s-resources nexus3 node-config overprovisioner diff --git a/charts/k8s-resources/Chart.yaml b/charts/k8s-resources/Chart.yaml index 0279d474..5a16680a 100644 --- a/charts/k8s-resources/Chart.yaml +++ b/charts/k8s-resources/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v2 name: k8s-resources -description: Helm chart for provisioning Kubernetes resources. +description: Helm chart for provisioning arbitrary Kubernetes resources. type: application version: 0.1.0 appVersion: 1.0.0 diff --git a/charts/k8s-resources/README.md b/charts/k8s-resources/README.md index 8f4703ad..985e6491 100644 --- a/charts/k8s-resources/README.md +++ b/charts/k8s-resources/README.md @@ -1,31 +1,42 @@ -# K8s Resources +# k8s-resources -The _K8s Resources_ chart is designed to deploy arbitrary Kubernetes resources to a _Kubernetes_ cluster. +![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) + +Helm chart for provisioning arbitrary Kubernetes resources. + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| stevehipwell | | | + +## Source Code + +* ## Installing the Chart -Before you can install the chart you will need to add the `stevehipwell` repo to [Helm](https://helm.sh/). +To install the chart using the recommended OCI method you can use the following command. ```shell -helm repo add stevehipwell https://stevehipwell.github.io/helm-charts/ +helm upgrade --install k8s-resources oci://ghcr.io/stevehipwell/helm-charts/k8s-resources --version 0.1.0 ``` -After you've installed the repo you can install the chart. +Alternatively you can use the legacy non-OCI method via the following commands. ```shell -helm upgrade --install --namespace default --values ./my-values.yaml my-release stevehipwell/k8s-resources +helm repo add stevehipwell https://stevehipwell.github.io/helm-charts/ +helm upgrade --install k8s-resources stevehipwell/k8s-resources --version 0.1.0 ``` -## Configuration +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| resources | list | `[]` | _Kubernetes_ resources to create. | -The following table lists the configurable parameters of the _K8s Resources_ chart and their default values. +---------------------------------------------- -| Parameter | Description | Default | -| ----------------------- | ---------------------------------------------------------------------------------- | ------- | -| `resources.apiVersion` | API version of the resource (required). | | -| `resources.kind` | Kind of the resource (required). | | -| `resources.name` | Name of the resource (required). | | -| `resources.namespace` | Namespace for the resource (don't provide this if the resource is cluster scoped). | | -| `resources.labels` | Labels for the resource (optional). | | -| `resources.annotations` | Annotations for the resource (optional). | | -| `resources.content` | Content of the resource (optional). | | +Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs/). diff --git a/charts/k8s-resources/README.md.gotmpl b/charts/k8s-resources/README.md.gotmpl new file mode 100644 index 00000000..e5eee599 --- /dev/null +++ b/charts/k8s-resources/README.md.gotmpl @@ -0,0 +1,35 @@ +{{ template "chart.header" . }} +{{ template "chart.deprecationWarning" . }} + +{{ template "chart.badgesSection" . }} + +{{ template "chart.description" . }} + +{{ template "chart.homepageLine" . }} + +{{ template "chart.maintainersSection" . }} + +{{ template "chart.sourcesSection" . }} + +## Installing the Chart + +To install the chart using the recommended OCI method you can use the following command. + +```shell +helm upgrade --install {{ template "chart.name" . }} oci://ghcr.io/stevehipwell/helm-charts/{{ template "chart.name" . }} --version {{ template "chart.version" . }} +``` + +Alternatively you can use the legacy non-OCI method via the following commands. + +```shell +helm repo add stevehipwell https://stevehipwell.github.io/helm-charts/ +helm upgrade --install {{ template "chart.name" . }} stevehipwell/{{ template "chart.name" . }} --version {{ template "chart.version" . }} +``` + +{{ template "chart.requirementsSection" . }} + +{{ template "chart.valuesSection" . }} + +---------------------------------------------- + +Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs/). diff --git a/charts/k8s-resources/values.yaml b/charts/k8s-resources/values.yaml index d5cf66b9..968f68fe 100644 --- a/charts/k8s-resources/values.yaml +++ b/charts/k8s-resources/values.yaml @@ -1,3 +1,8 @@ +# Default values for k8s-resources. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +# -- _Kubernetes_ resources to create. resources: [] # - apiVersion: v1 # kind: ConfigMap