From eaec12cc82af123bbeabd75113f646487df8ce38 Mon Sep 17 00:00:00 2001 From: Dennis Zhang Date: Tue, 29 Mar 2022 00:44:32 -0700 Subject: [PATCH] [kube-ops-view] Add chart for kube-ops-view (#1459) * Add chart for kube-ops-view Signed-off-by: Dennis Zhang --- charts/stable/kube-ops-view/.helmignore | 26 ++++ charts/stable/kube-ops-view/Chart.yaml | 23 ++++ charts/stable/kube-ops-view/README.md | 118 ++++++++++++++++++ .../kube-ops-view/README_CONFIG.md.gotmpl | 9 ++ .../stable/kube-ops-view/templates/NOTES.txt | 1 + .../kube-ops-view/templates/common.yaml | 1 + .../stable/kube-ops-view/templates/rbac.yaml | 28 +++++ charts/stable/kube-ops-view/values.yaml | 44 +++++++ 8 files changed, 250 insertions(+) create mode 100644 charts/stable/kube-ops-view/.helmignore create mode 100644 charts/stable/kube-ops-view/Chart.yaml create mode 100644 charts/stable/kube-ops-view/README.md create mode 100644 charts/stable/kube-ops-view/README_CONFIG.md.gotmpl create mode 100644 charts/stable/kube-ops-view/templates/NOTES.txt create mode 100644 charts/stable/kube-ops-view/templates/common.yaml create mode 100644 charts/stable/kube-ops-view/templates/rbac.yaml create mode 100644 charts/stable/kube-ops-view/values.yaml diff --git a/charts/stable/kube-ops-view/.helmignore b/charts/stable/kube-ops-view/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/kube-ops-view/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/stable/kube-ops-view/Chart.yaml b/charts/stable/kube-ops-view/Chart.yaml new file mode 100644 index 00000000..9f09ad3f --- /dev/null +++ b/charts/stable/kube-ops-view/Chart.yaml @@ -0,0 +1,23 @@ +apiVersion: v2 +appVersion: 20.4.0 +description: kube-ops-view helm package +name: kube-ops-view +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: +- kube-ops-view +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/kube-ops-view +icon: https://codeberg.org/repo-avatars/677-c51f6426305941cab515fdd98368f0bb +sources: +- https://codeberg.org/hjacobs/kube-ops-view +maintainers: + - name: FlipEnergy + email: dennis.zhang.nrg@gmail.com +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 4.3.0 +annotations: + artifacthub.io/changes: | + - kind: added + description: Initial version diff --git a/charts/stable/kube-ops-view/README.md b/charts/stable/kube-ops-view/README.md new file mode 100644 index 00000000..ed453237 --- /dev/null +++ b/charts/stable/kube-ops-view/README.md @@ -0,0 +1,118 @@ +# kube-ops-view + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 20.4.0](https://img.shields.io/badge/AppVersion-20.4.0-informational?style=flat-square) + +kube-ops-view is a read-only system dashboard for multiple K8s clusters. + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** + +## Source Code + +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://library-charts.k8s-at-home.com | common | 4.3.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install kube-ops-view k8s-at-home/kube-ops-view +``` + +## Installing the Chart + +To install the chart with the release name `kube-ops-view` + +```console +helm install kube-ops-view k8s-at-home/kube-ops-view +``` + +## Uninstalling the Chart + +To uninstall the `kube-ops-view` deployment + +```console +helm uninstall kube-ops-view +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install kube-ops-view \ + --set env.TZ="America/New York" \ + k8s-at-home/kube-ops-view +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install kube-ops-view k8s-at-home/kube-ops-view -f values.yaml +``` + +## Custom configuration + +N/A + +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | See below | environment variables. See more environment variables in the [kube-ops-view documentation](https://kube-ops-view.org/docs). | +| env.TZ | string | `"UTC"` | Set the container timezone | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"hjacobs/kube-ops-view"` | image repository | +| image.tag | string | `"20.4.0"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| securityContext.readOnlyRootFilesystem | bool | `true` | | +| securityContext.runAsNonRoot | bool | `true` | | +| securityContext.runAsUser | int | `1000` | | +| service | object | See values.yaml | Configures service settings for the chart. | +| serviceAccount.create | bool | `true` | create needed service account | + +## Changelog + +### Version 1.0.0 + +#### Added + +* Initial version + +#### Changed + +N/A + +#### Fixed + +N/A + +### Older versions + +A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/kube-ops-view?modal=changelog) + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1) diff --git a/charts/stable/kube-ops-view/README_CONFIG.md.gotmpl b/charts/stable/kube-ops-view/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/kube-ops-view/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/stable/kube-ops-view/templates/NOTES.txt b/charts/stable/kube-ops-view/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/kube-ops-view/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/kube-ops-view/templates/common.yaml b/charts/stable/kube-ops-view/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/stable/kube-ops-view/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/stable/kube-ops-view/templates/rbac.yaml b/charts/stable/kube-ops-view/templates/rbac.yaml new file mode 100644 index 00000000..a64c3547 --- /dev/null +++ b/charts/stable/kube-ops-view/templates/rbac.yaml @@ -0,0 +1,28 @@ +--- +kind: ClusterRole +apiVersion: rbac.authorization.k8s.io/v1 +metadata: + name: {{ include "common.names.serviceAccountName" . }} +rules: +- apiGroups: [""] + resources: ["nodes", "pods"] + verbs: + - list +- apiGroups: ["metrics.k8s.io"] + resources: ["nodes", "pods"] + verbs: + - get + - list +--- +kind: ClusterRoleBinding +apiVersion: rbac.authorization.k8s.io/v1 +metadata: + name: {{ include "common.names.serviceAccountName" . }} +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: ClusterRole + name: {{ include "common.names.serviceAccountName" . }} +subjects: +- kind: ServiceAccount + name: {{ include "common.names.serviceAccountName" . }} + namespace: {{ .Release.Namespace }} diff --git a/charts/stable/kube-ops-view/values.yaml b/charts/stable/kube-ops-view/values.yaml new file mode 100644 index 00000000..4555850b --- /dev/null +++ b/charts/stable/kube-ops-view/values.yaml @@ -0,0 +1,44 @@ +# +# IMPORTANT NOTE +# +# This chart inherits from our common library chart. You can check the default values/options here: +# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml +# + +image: + # -- image repository + repository: hjacobs/kube-ops-view + # -- image tag + # @default -- chart.appVersion + tag: + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [kube-ops-view documentation](https://codeberg.org/hjacobs/kube-ops-view/#configuration). +# @default -- See below +env: + # -- Set the container timezone + TZ: UTC + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 8080 + +securityContext: + readOnlyRootFilesystem: true + runAsNonRoot: true + runAsUser: 1000 + +serviceAccount: + # -- create needed service account + create: true + +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See values.yaml + main: + enabled: false