Skip to content

Commit

Permalink
mass migration to generated docs for charts
Browse files Browse the repository at this point in the history
  • Loading branch information
rlex committed Aug 31, 2022
1 parent bdbad34 commit 9c13559
Show file tree
Hide file tree
Showing 12 changed files with 339 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .helmdocsignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
charts/flame
charts/freetakserver
charts/prometheus-webhook-dingtalk
2 changes: 1 addition & 1 deletion charts/hcloud-fip-controller/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,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.
version: 0.2.3
version: 0.2.4

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application.
Expand Down
40 changes: 38 additions & 2 deletions charts/hcloud-fip-controller/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# hcloud-fip-controller

![Version: 0.2.3](https://img.shields.io/badge/Version-0.2.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.4.1](https://img.shields.io/badge/AppVersion-0.4.1-informational?style=flat-square)

hcloud-fip-controller is a small controller, to handle floating IP management in a kubernetes cluster on hetzner cloud virtual machines.

hcloud-fip-controller
-------

Expand All @@ -8,7 +14,7 @@ in a [Kubernetes][k8s-home] cluster on hetzner cloud virtual machines.

The running pods will check the hetzner cloud API every 30 seconds to check if
the configured IP Addresses (or subnets in case of IPv6) are assigned to the
server the leader is scheduled to. If not it will update the assignments.
server the leader is scheduled to. If not it will update the assignments.
You need to make sure to have the IP Addresses configured on **every** node for
this failover to correctly work, as the controller will not take care of the
network configuration of the nodes.
Expand Down Expand Up @@ -160,8 +166,38 @@ stringData:
$ kubectl apply -f configMap.yaml -f secretEnv.yaml
```

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | |
| configInline | object | `{}` | |
| deploymentKind | string | `"Deployment"` | |
| existingConfigMap | string | `"hcloud-fip-controller-config"` | |
| existingEnvSecret | string | `"hcloud-fip-controller-env"` | |
| fullnameOverride | string | `""` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"cbeneke/hcloud-fip-controller"` | |
| image.tag | string | `"v0.4.1"` | |
| imagePullSecrets | list | `[]` | |
| nameOverride | string | `""` | |
| nodeSelector | object | `{}` | |
| podSecurityContext | object | `{}` | |
| rbac.create | bool | `true` | |
| replicaCount | int | `3` | |
| resources | object | `{}` | |
| secretInline | object | `{}` | |
| securityContext | object | `{}` | |
| serviceAccount.create | bool | `true` | |
| serviceAccount.name | string | `nil` | |
| tolerations | list | `[]` | |

## Upgrading

A major chart version change indicates that there is an incompatible breaking change needing manual actions.

[helm-home]: https://helm.sh
[helm-usage]: https://docs.helm.sh/using_helm/
[k8s-home]: https://kubernetes.io
[hcloud-fip-controller-config]: https://github.com/cbeneke/hcloud-fip-controller/
[hcloud-fip-controller-home]: https://github.com/cbeneke/hcloud-fip-controller/
[hcloud-fip-controller-home]: https://github.com/cbeneke/hcloud-fip-controller/
183 changes: 183 additions & 0 deletions charts/hcloud-fip-controller/README.md.gotmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
{{ template "chart.header" . }}

{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}

{{ template "chart.description" . }}

{{ template "chart.sourcesSection" . }}

{{ template "chart.requirementsSection" . }}

hcloud-fip-controller
-------

Fork of [original controller chart][hcloud-fip-controller-home] with some stuff fixed

hcloud-fip-controller is a small controller, to handle floating IP management
in a [Kubernetes][k8s-home] cluster on hetzner cloud virtual machines.

The running pods will check the hetzner cloud API every 30 seconds to check if
the configured IP Addresses (or subnets in case of IPv6) are assigned to the
server the leader is scheduled to. If not it will update the assignments.
You need to make sure to have the IP Addresses configured on **every** node for
this failover to correctly work, as the controller will not take care of the
network configuration of the nodes.

TL;DR;
------

```console
$ helm repo add rlex https://rlex.github.com/helm-charts
$ helm repo update
$ kubectl apply -f configMap.yml -f secretEnv.yml
$ helm install --name hcloud-fip-controller rlex/hcloud-fip-controller
```

Introduction
------------

This chart bootstraps a [hcloud-fip-controller][hcloud-fip-controller-home]
installation on a [Kubernetes][k8s-home] cluster using the [Helm][helm-home]
package manager.

Prerequisites
-------------

- Kubernetes 1.10+

Installing the Chart
--------------------

The chart can be installed as follows:

```console
$ helm repo add rlex https://rlex.github.com/helm-charts
$ helm repo update
$ kubectl apply -f configMap.yml -f secretEnv.yml
$ helm install --name hcloud-fip-controller rlex/hcloud-fip-controller
```

The command deploys hcloud-fip-controller on the Kubernetes cluster. This chart
does not provide a default configuration; hcloud-fip-controller will not act on
your Kubernetes Services until you provide one. The
[configuration](#configuration) and [configuration files](#configuration-files)
sections lists various ways to provide this configuration.

Uninstalling the Chart
----------------------

To uninstall/delete the `hcloud-fip-controller` deployment:

```console
$ helm delete hcloud-fip-controller
$ kubectl delete -f configMap.yml -f secretEnv.yml
```

The command removes all the Kubernetes components associated with the chart, but
will not remove the release metadata from `helm` — this will prevent you, for
example, if you later try to create a release also named
`hcloud-fip-controller`). To fully delete the release and release history,
simply [include the `--purge` flag][helm-usage]:

```console
$ helm delete --purge hcloud-fip-controller
```

Configuration
-------------

See `values.yaml` for configuration notes. Specify each parameter using the
`--set key=value[,key=value]` argument to `helm install`. For example,

```console
$ helm install --name hcloud-fip-controller \
--set rbac.create=false \
cbeneke/hcloud-fip-controller
```

The above command disables the use of RBAC rules.

Alternatively, a YAML file that specifies the values for the above parameters
can be provided while installing the chart. For example,

```console
$ helm install --name hcloud-fip-controller -f values.yaml cbeneke/hcloud-fip-controller
```

By default, this chart does not install a configuration for
hcloud-fip-controller, and simply warns you that you must follow
[the configuration instructions on hcloud-fip-controller's
website][hcloud-fip-controller-config] to create an appropriate ConfigMap.

**Please note:** By default, this chart expects a ConfigMap named
'hcloud-fip-controller-config' within the same namespace as the chart is
deployed. _This is different than the hcloud-fip-controller documentation_,
which asks you to create a ConfigMap in the `fip-controller` namespace, with
the name of 'fip-controller-config'.

If you have a more complex configuration and want Helm to manage it for you, you
can provide it in the `config` parameter. The configuration format is
[documented on hcloud-fip-controller's website][hcloud-fip-controller-config].

```console
$ cat values.yaml
configInline:
hcloud_floating_ips:
- <10.0.0.1>
lease_duration: 30
lease_name: production
log_level: info

secretInline:
HCLOUD_API_TOKEN: <secret-token>

$ helm install --name hcloud-fip-controller -f values.yaml cbeneke/hcloud-fip-controller
```

Configuration Files
-------------------

By default the installed application expects both a configuration configMap and
an environment secret. The configuration will be mounted as config file, the
secret will be invoked with `KEY: value` pairs as environment configuration.

Example:

```console
$ cat configMap.yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: hcloud-fip-controller
data:
config.json: |
{
hcloud_floating_ips: [
<10.0.0.1>,
<10.0.0.2>
],
lease_duration: 30
}

$ cat secretEnv.yaml
apiVersion: v1
kind: Secret
metadata:
name: hcloud-fip-controller
stringData:
HCLOUD_API_TOKEN: <secret-token>

$ kubectl apply -f configMap.yaml -f secretEnv.yaml
```

{{ template "chart.valuesSection" . }}

## Upgrading

A major chart version change indicates that there is an incompatible breaking change needing manual actions.

[helm-home]: https://helm.sh
[helm-usage]: https://docs.helm.sh/using_helm/
[k8s-home]: https://kubernetes.io
[hcloud-fip-controller-config]: https://github.com/cbeneke/hcloud-fip-controller/
[hcloud-fip-controller-home]: https://github.com/cbeneke/hcloud-fip-controller/
2 changes: 1 addition & 1 deletion charts/kube-resource-report/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ apiVersion: v1
appVersion: "22.8.0"
description: Report Kubernetes cluster and pod resource requests vs usage and generate static HTML
name: kube-resource-report
version: 0.7.7
version: 0.7.8
home: https://codeberg.org/hjacobs/kube-resource-report
2 changes: 0 additions & 2 deletions charts/kube-resource-report/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

Report Kubernetes cluster and pod resource requests vs usage and generate static HTML

Report Kubernetes cluster and pod resource requests vs usage and generate static HTML

Forked from [official but unsupported chart](https://codeberg.org/hjacobs/kube-resource-report/src/branch/main/unsupported/chart/kube-resource-report) with some fixes

## Values
Expand Down
2 changes: 1 addition & 1 deletion charts/kube-web-view/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,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.3
version: 0.1.4

# 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
Expand Down
50 changes: 50 additions & 0 deletions charts/kube-web-view/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# kube-web-view

![Version: 0.1.3](https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 22.7.0](https://img.shields.io/badge/AppVersion-22.7.0-informational?style=flat-square)

Kubernetes Web View to list and view all Kubernetes resources

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | |
| autoscaling.enabled | bool | `false` | |
| autoscaling.maxReplicas | int | `100` | |
| autoscaling.minReplicas | int | `1` | |
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
| extraArgs[0] | string | `"--port=8080"` | |
| fullnameOverride | string | `""` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"hjacobs/kube-web-view"` | |
| image.tag | string | `"22.7.0"` | |
| imagePullSecrets | list | `[]` | |
| ingress.annotations | object | `{}` | |
| ingress.className | string | `""` | |
| ingress.enabled | bool | `false` | |
| ingress.hosts[0].host | string | `"chart-example.local"` | |
| ingress.hosts[0].paths[0].path | string | `"/"` | |
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
| ingress.tls | list | `[]` | |
| nameOverride | string | `""` | |
| nodeSelector | object | `{}` | |
| podAnnotations | object | `{}` | |
| podSecurityContext | object | `{}` | |
| replicaCount | int | `1` | |
| resources.limits.cpu | string | `"100m"` | |
| resources.limits.memory | string | `"128Mi"` | |
| resources.requests.cpu | string | `"100m"` | |
| resources.requests.memory | string | `"128Mi"` | |
| securityContext.readOnlyRootFilesystem | bool | `true` | |
| securityContext.runAsNonRoot | bool | `true` | |
| securityContext.runAsUser | int | `1000` | |
| service.port | int | `80` | |
| service.type | string | `"ClusterIP"` | |
| serviceAccount.annotations | object | `{}` | |
| serviceAccount.create | bool | `true` | |
| serviceAccount.name | string | `""` | |
| tolerations | list | `[]` | |

## Upgrading

A major chart version change indicates that there is an incompatible breaking change needing manual actions.
15 changes: 15 additions & 0 deletions charts/kube-web-view/README.md.gotmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{{ template "chart.header" . }}

{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}

{{ template "chart.description" . }}

{{ template "chart.sourcesSection" . }}

{{ template "chart.requirementsSection" . }}

{{ template "chart.valuesSection" . }}

## Upgrading

A major chart version change indicates that there is an incompatible breaking change needing manual actions.
2 changes: 1 addition & 1 deletion charts/kubernetes-diff-logger/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,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.0
version: 0.1.1

# 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
Expand Down
31 changes: 31 additions & 0 deletions charts/kubernetes-diff-logger/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# kubernetes-diff-logger

![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: 0.0.5](https://img.shields.io/badge/AppVersion-0.0.5-informational?style=flat-square)

This simple application by grafana labs is designed to watch Kubernetes objects and log diffs when they occur

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | |
| fullnameOverride | string | `""` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"grafana/kubernetes-diff-logger"` | |
| image.tag | string | `"0.0.5"` | |
| imagePullSecrets | list | `[]` | |
| nameOverride | string | `""` | |
| nodeSelector | object | `{}` | |
| podAnnotations | object | `{}` | |
| podSecurityContext | object | `{}` | |
| replicaCount | int | `1` | |
| resources | object | `{}` | |
| securityContext | object | `{}` | |
| serviceAccount.annotations | object | `{}` | |
| serviceAccount.create | bool | `true` | |
| serviceAccount.name | string | `""` | |
| tolerations | list | `[]` | |

## Upgrading

A major chart version change indicates that there is an incompatible breaking change needing manual actions.
Loading

0 comments on commit 9c13559

Please sign in to comment.