Feat/add helm docs #67

JTaeuber · 2024-11-04T11:53:18Z

Motivation

Adding documentation for the Helm Chart

Part of #38

Blocked by #80 and #69

Changes

fixed pre-commit email
refactored values.yaml
added documentation pages for the helm chart

Tests done

Ran the site locally

TODO

Make links to arguments and environment variable pages.

…HelmDocs

…ing issues

JTaeuber · 2025-02-25T15:21:10Z

Still missing Basic Night Time Saving
Refactor of installation to be in sync with helm chart readme
Add documentation for leader election
Add values.yaml changes to Migrating docs

@jonathan-mayer feel free to look over the rest if you have the time

jonathan-mayer · 2025-02-28T06:35:31Z

we should consider updating these packages:

Package                           Current  Wanted  Latest  Location                                       Depended by
@eslint/compat                      1.2.6   1.2.7   1.2.7  node_modules/@eslint/compat                    website
@tailwindcss/postcss                4.0.6   4.0.9   4.0.9  node_modules/@tailwindcss/postcss              website
@typescript-eslint/eslint-plugin   8.24.0  8.25.0  8.25.0  node_modules/@typescript-eslint/eslint-plugin  website
@typescript-eslint/parser          8.24.0  8.25.0  8.25.0  node_modules/@typescript-eslint/parser         website
eslint                             9.20.1  9.21.0  9.21.0  node_modules/eslint                            website
postcss                             8.5.2   8.5.3   8.5.3  node_modules/postcss                           website
tailwindcss                         4.0.6   4.0.9   4.0.9  node_modules/tailwindcss                       website

jonathan-mayer · 2025-02-28T07:29:04Z

We dont need this right? the crds permission is unnessessary since we dont need to do anything with the definitions themselves. We also currently dont need the admission controller ones and taking the recent comments in the issues topic into account it seems as though we won't need them.

{{- if not .Values.constrainedDownscaler }}
- apiGroups:
  - constraints.gatekeeper.sh
  resources:
  - kubedownscalerjobsconstraint
  verbs:
  - get
  - create
  - watch
  - list
  - update
  - patch
  - delete
- apiGroups:
  - kyverno.io
  resources:
  - policies
  resourceNames:
  - kube-downscaler-jobs-policy
  verbs:
  - get
  - create
  - watch
  - list
  - update
  - patch
  - delete
- apiGroups:
  - kyverno.io
  resources:
  - policies
  verbs:
  - get
  - create
  - watch
  - list
- apiGroups:
  - templates.gatekeeper.sh
  resources:
  - constrainttemplate
  verbs:
  - create
  - get
  - list
  - watch
- apiGroups:
  - apiextensions.k8s.io
  resources:
  - customresourcedefinitions
  verbs:
  - create
  - get
  - list
  - watch
{{- end }}

also we only ever do get, list and update on the resources so i would change that too

jonathan-mayer · 2025-02-28T07:34:36Z

please change every admonition to have empty lines around its contents. see https://docusaurus.io/docs/markdown-features/admonitions#usage-with-prettier for why we (at least sometimes) need it and we should be consistent across the whole docs

jonathan-mayer

LLYHSWCOTM

jonathan-mayer · 2024-11-06T08:29:02Z

website/content/guides/getting-started/0 - Installation.mdx

+In order to get started installing the GoKubeDownscaler using our Helm Chart you need:
+
+- [Helm installed][helm-intro] on a system
+- have access to a Kubernetes cluster in some kind of way.


this makes the sentence strucutre better: "... to use our Helm Chart you need access to a Kubernetes ...".

Suggested change

- have access to a Kubernetes cluster in some kind of way.

- access to a Kubernetes cluster

jonathan-mayer · 2025-02-28T06:59:59Z

website/content/docs/1 - helm-chart/2 - values/1 - image.mdx

+If left empty like it is by default the GoKubeDownscaler will use the
+[appVersion](repo:deployments/chart/Chart.yaml#L10) of the currently used Helm Chart.
+
+You can find all versions of the GoKubeDownscaler [on the github releases page](repo/releases).


"/home/installadm/dev/gokubedownscaler2/website/content/docs/1 - helm-chart/2 - values/1 - image.mdx:32:51": No repository path specified

Suggested change

You can find all versions of the GoKubeDownscaler [on the github releases page](repo/releases).

You can find all versions of the GoKubeDownscaler [on the github releases page](https://github.com/caas-team/GoKubeDownscaler/releases).

jonathan-mayer · 2025-02-28T07:11:01Z

website/content/docs/1 - Workflows.mdx

the order right now is not only wierd, since its "Downcsaler", "Workflows", "Helm Chart", "Docker Image" but also has duplicate indexes. I would put the Workflow docs after the Helm Chart. Update the index of the Docker Image docs along with this change.

jonathan-mayer · 2025-02-28T07:15:31Z

website/content/docs/1 - helm-chart/0 - Components.mdx

+## Serviceaccount
+
+The [serviceaccount.yaml](repo:deployments/chart/templates/serviceaccount.yaml) file creates a ServiceAccount
+that will be used by the go-kube-downscaler to interact with Kubernetes.


we should only use one way to write GoKubeDownscaler in the docs.

Suggested change

that will be used by the go-kube-downscaler to interact with Kubernetes.

that will be used by the GoKubeDownscaler to interact with Kubernetes.

jonathan-mayer · 2025-02-28T07:31:09Z

website/content/docs/1 - helm-chart/1 - Permissions.mdx

+
+## Workload Permissions
+
+The Helm Chart assigns get, watch, list, update and patch permissions for the workloads defined in [`includedResources`](ref:docs-helm-included-resources).


Suggested change

The Helm Chart assigns get, watch, list, update and patch permissions for the workloads defined in [`includedResources`](ref:docs-helm-included-resources).

The Helm Chart assigns `get`, `watch`, `list`, `update` and `patch` permissions for the workloads defined in [`includedResources`](ref:docs-helm-included-resources).

jonathan-mayer · 2025-02-28T09:38:45Z

website/content/docs/1 - helm-chart/2 - values/16 - configMap.mdx

+The `configMap` value contains the two fields `name` and `extraConfig`:
+
+- `name` defines the name of the configmap for the GoKubeDownscaler.
+- `extraConfig` adds additional specified environment variables to the ConfigMap.


Suggested change

- `extraConfig` adds additional specified environment variables to the ConfigMap.

- `extraConfig` adds additional specified [environment variables](ref:docs-environment-variables) to the ConfigMap.

jonathan-mayer · 2025-02-28T09:40:00Z

website/content/docs/1 - helm-chart/2 - values/16 - configMap.mdx

+:::
+
+By default the `extraConfig` field is empty.
+Appending a line will add the corresponding environment variable to the configMap.


Suggested change

Appending a line will add the corresponding environment variable to the configMap.

Appending a line will add the corresponding [environment variable](ref:docs-environment-variables) to the configMap.

jonathan-mayer · 2025-02-28T09:40:18Z

website/content/docs/1 - helm-chart/2 - values/16 - configMap.mdx

+
+This then changes how the GoKubeDownscaler behaves.
+
+:::tip For example:


Suggested change

:::tip For example:

:::tip Example

jonathan-mayer · 2025-02-28T09:40:56Z

website/content/docs/1 - helm-chart/2 - values/12 - nodeSelector.mdx

+
+If you want the GoKubeDownscaler to be scheduled on a specific type of node you can specify the determining labels of the node here.
+
+:::tip For example:


Suggested change

:::tip For example:

:::tip Example

jonathan-mayer · 2025-02-28T09:42:39Z

website/content/docs/1 - helm-chart/2 - values/16 - configMap.mdx

+
+This will add the `EXCLUDE_DEPLOYMENTS` environment variable to the configMap.
+
+The given configuration will exclude the deployments with the name deployment1 and deployment2


Suggested change

The given configuration will exclude the deployments with the name deployment1 and deployment2

The given configuration will exclude the deployments with the name `deployment1` and `deployment2`

* fix: correction for leader election flag assignment (#123) * refactor: added release namespace to k8s resources in the chart * Update configmap fields * chore: automatically push pre-commit changes --------- Co-authored-by: Jan <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

jonathan-mayer and others added 26 commits October 24, 2024 15:50

fix: invalid email in pre commit workflow (#66)

e20981b

Merge branch 'main' into feat/add-content-to-site

7371c33

feat: add how to run the website in readme

f5f10da

feat: added installation guide

0309fa8

feat: added prometheuses to values.yaml

fab90f1

feat: added helm chart sidebar to docs

e5bdc2c

chore: add pre-commit whinery

49863cd

Merge commit 'e20981b9ca279d1dbc6692f2b8046e2bb01a4e43' into feat/Add…

4f1b863

…HelmDocs

feat: add skeleton markdown files

82a39a8

refactored configMap parameters

6f43f4a

refactor site structure

ea03897

changed comment

3d24007

add default values

f1b3ce7

add included resources skeleton

c545c88

change filetype to mdx

be52ad8

change layout

b421186

added content

82b599b

made todo a comment

75e1480

changed index structure

2912755

docs: changed code comments to match convention

54ce506

feat: update pre commit config to match new files

4a0f7cf

docs: fix spelling mistakes in docs

fc4e17c

docs: update readme to refer to the website

3cbd3e2

fix: update pre commit to not fail because of markdown headings

da0fca8

fix: made regexList match whole string

10a9b8b

add contents

9765e72

JTaeuber added the documentation Improvements or additions to documentation label Nov 4, 2024

JTaeuber requested review from jonathan-mayer and jon4skl as code owners November 4, 2024 11:53

github-actions bot assigned JTaeuber Nov 4, 2024

jonathan-mayer and others added 17 commits February 19, 2025 11:00

fix: add select none

50870fd

chore: better syntax

bb738d3

this did something

1646ec3

fix: it actually works now :)

35ce84b

fix: pr threads

342ac98

Merge branch 'main' into feat/add-content-to-site

7cb2e06

feat: add docs on default layer implemented in #118 + fix anchors

652fcab

chore: add new lines in admonitions for consistency and formatting

f1752a2

fix: idk

40b0470

fix: finally

f4b1430

fix: button underline

a8091a8

fix: weird margin

8987d1e

refactor: error logs to not be stupid long

b038ba1

Merge branch 'feat/add-content-to-site' into feat/AddHelmDocs

b1a2874

chore: automatically push pre-commit changes

cd441fb

Merge branch 'feat/add-docusaurus' into feat/AddHelmDocs and fix lint…

429e5ba

…ing issues

fix: eslint in pipeline

eadd8ba

jonathan-mayer removed the blocked A PR which is blocked by other Issues/PRs label Feb 24, 2025

JTaeuber added 4 commits February 24, 2025 16:13

fix: issues with leasRole and constrained role creation

540ac55

adjust helm readme

aff1ded

try workflow fix

15a9a61

make button not draggable

400862b

JTaeuber requested a review from jonathan-mayer February 25, 2025 15:18

jonathan-mayer requested changes Feb 28, 2025

View reviewed changes

JTaeuber linked an issue Mar 2, 2025 that may be closed by this pull request

LeaderElection helm value is not parsed properly #128

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/add helm docs #67

Feat/add helm docs #67

JTaeuber commented Nov 4, 2024 •

edited

Loading

JTaeuber commented Feb 25, 2025 •

edited by jonathan-mayer

Loading

jonathan-mayer commented Feb 28, 2025

jonathan-mayer commented Feb 28, 2025 •

edited

Loading

jonathan-mayer commented Feb 28, 2025

jonathan-mayer left a comment •

edited

Loading

jonathan-mayer Nov 6, 2024

jonathan-mayer Feb 28, 2025

jonathan-mayer Feb 28, 2025

jonathan-mayer Feb 28, 2025

jonathan-mayer Feb 28, 2025

jonathan-mayer Feb 28, 2025

jonathan-mayer Feb 28, 2025

jonathan-mayer Feb 28, 2025

jonathan-mayer Feb 28, 2025

jonathan-mayer Feb 28, 2025

	- have access to a Kubernetes cluster in some kind of way.
	- access to a Kubernetes cluster

	You can find all versions of the GoKubeDownscaler [on the github releases page](repo/releases).
	You can find all versions of the GoKubeDownscaler [on the github releases page](https://github.com/caas-team/GoKubeDownscaler/releases).

	that will be used by the go-kube-downscaler to interact with Kubernetes.
	that will be used by the GoKubeDownscaler to interact with Kubernetes.


		## Workload Permissions

		The Helm Chart assigns get, watch, list, update and patch permissions for the workloads defined in [`includedResources`](ref:docs-helm-included-resources).

	The Helm Chart assigns get, watch, list, update and patch permissions for the workloads defined in [`includedResources`](ref:docs-helm-included-resources).
	The Helm Chart assigns `get`, `watch`, `list`, `update` and `patch` permissions for the workloads defined in [`includedResources`](ref:docs-helm-included-resources).

	- `extraConfig` adds additional specified environment variables to the ConfigMap.
	- `extraConfig` adds additional specified [environment variables](ref:docs-environment-variables) to the ConfigMap.

	Appending a line will add the corresponding environment variable to the configMap.
	Appending a line will add the corresponding [environment variable](ref:docs-environment-variables) to the configMap.


		This then changes how the GoKubeDownscaler behaves.

		:::tip For example:


		If you want the GoKubeDownscaler to be scheduled on a specific type of node you can specify the determining labels of the node here.

		:::tip For example:


		This will add the `EXCLUDE_DEPLOYMENTS` environment variable to the configMap.

		The given configuration will exclude the deployments with the name deployment1 and deployment2

Feat/add helm docs #67

Are you sure you want to change the base?

Feat/add helm docs #67

Conversation

JTaeuber commented Nov 4, 2024 • edited Loading

Motivation

Changes

Tests done

TODO

JTaeuber commented Feb 25, 2025 • edited by jonathan-mayer Loading

jonathan-mayer commented Feb 28, 2025

jonathan-mayer commented Feb 28, 2025 • edited Loading

jonathan-mayer commented Feb 28, 2025

jonathan-mayer left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JTaeuber commented Nov 4, 2024 •

edited

Loading

JTaeuber commented Feb 25, 2025 •

edited by jonathan-mayer

Loading

jonathan-mayer commented Feb 28, 2025 •

edited

Loading

jonathan-mayer left a comment •

edited

Loading