still not done but fixes the md ref

caas-team · Nov 5, 2024 · 2f7acf6 · 2f7acf6
1 parent 7d3bb55
commit 2f7acf6
Show file tree

Hide file tree

Showing 22 changed files with 106 additions and 96 deletions.
diff --git a/website/content/_global_md_links.mdx b/website/content/_global_md_links.mdx
@@ -17,26 +17,28 @@
 [docs-helm-components]: /GoKubeDownscaler/docs/helm-chart/components "Helm Components"
 [docs-helm-permissions]: /GoKubeDownscaler/docs/helm-chart/permissions "Permissions"
 {/* TODO */}
-[docs-arguments]: /GoKubeDownscaler/docs/ "arguments"
+[docs-arguments]: /GoKubeDownscaler/docs/ "Arguments"
+[docs-environment-variables]: /GoKubeDownscaler/docs/ "Environment Variables"
+[docs-layer-values]: /GoKubeDownscaler/docs/ "Layer Values"
 
 {/* Helm Value links */}
-[replicaCount]: /GoKubeDownscaler/docs/helm-chart/Values/replicaCount
-[image]: /GoKubeDownscaler/docs/helm-chart/Values/image
-[arguments]: /GoKubeDownscaler/docs/helm-chart/Values/arguments
-[includedResources]: /GoKubeDownscaler/docs/helm-chart/Values/includedResources
-[fullnameOverride]: /GoKubeDownscaler/docs/helm-chart/Values/fullnameOverride
-[nameOverride]: /GoKubeDownscaler/docs/helm-chart/Values/nameOverride
-[constrainedDownscaler]: /GoKubeDownscaler/docs/helm-chart/Values/constrainedDownscaler
-[constrainedNamespaces]: /GoKubeDownscaler/docs/helm-chart/Values/constrainedNamespaces
-[serviceAccount]: /GoKubeDownscaler/docs/helm-chart/Values/serviceAccount
-[podSecurityContext]: /GoKubeDownscaler/docs/helm-chart/Values/podSecurityContext
-[securityContext]: /GoKubeDownscaler/docs/helm-chart/Values/securityContext
-[resources]: /GoKubeDownscaler/docs/helm-chart/Values/resources
-[nodeSelector]: /GoKubeDownscaler/docs/helm-chart/Values/nodeSelector
-[tolerations]: /GoKubeDownscaler/docs/helm-chart/Values/tolerations
-[affinity]: /GoKubeDownscaler/docs/helm-chart/Values/affinity
-[excludedNamespaces]: /GoKubeDownscaler/docs/helm-chart/Values/excludedNamespaces
-[configMap]: /GoKubeDownscaler/docs/helm-chart/Values/configMap
+[replicaCount]: /GoKubeDownscaler/docs/helm-chart/Values/replicaCount "replicaCount"
+[image]: /GoKubeDownscaler/docs/helm-chart/Values/image "image"
+[arguments]: /GoKubeDownscaler/docs/helm-chart/Values/arguments "arguments"
+[includedResources]: /GoKubeDownscaler/docs/helm-chart/Values/includedResources "includedResources"
+[fullnameOverride]: /GoKubeDownscaler/docs/helm-chart/Values/fullnameOverride "fullnameOverride"
+[nameOverride]: /GoKubeDownscaler/docs/helm-chart/Values/nameOverride "nameOverride"
+[constrainedDownscaler]: /GoKubeDownscaler/docs/helm-chart/Values/constrainedDownscaler "constrainedDownscaler"
+[constrainedNamespaces]: /GoKubeDownscaler/docs/helm-chart/Values/constrainedNamespaces "constrainedNamespaces"
+[serviceAccount]: /GoKubeDownscaler/docs/helm-chart/Values/serviceAccount "serviceAccount"
+[podSecurityContext]: /GoKubeDownscaler/docs/helm-chart/Values/podSecurityContext "podSecurityContext"
+[securityContext]: /GoKubeDownscaler/docs/helm-chart/Values/securityContext "securityContext"
+[resources]: /GoKubeDownscaler/docs/helm-chart/Values/resources "resources"
+[nodeSelector]: /GoKubeDownscaler/docs/helm-chart/Values/nodeSelector "nodeSelector"
+[tolerations]: /GoKubeDownscaler/docs/helm-chart/Values/tolerations "tolerations"
+[affinity]: /GoKubeDownscaler/docs/helm-chart/Values/affinity "affinity"
+[excludedNamespaces]: /GoKubeDownscaler/docs/helm-chart/Values/excludedNamespaces "excludedNamespaces"
+[configMap]: /GoKubeDownscaler/docs/helm-chart/Values/configMap "configMap"
 
 {/* External links */}
 [docusaurus]: https://docusaurus.io "Docusaurus"
@@ -50,4 +52,7 @@
 [helm-intro]: https://helm.sh/docs/intro/ "Helm Intro"
 
 {/* K8s Pages */}
-[kubernetes-security-context]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ "Security context"
+[kubernetes-security-context]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ "Kubernetes Security Context"
+[kubernetes-resource-management]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ "Kubernetes Resource Management"
+[kubernetes-taints-and-tolerations]: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ "Kubernetes Taints and Tolerations"
+[kubernetes-affinity]: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ "Kubernetes Affinity"
diff --git a/...elm-chart/3 - values/0 - replicaCount.mdx → ...elm-chart/2 - values/0 - replicaCount.mdx b/...elm-chart/3 - values/0 - replicaCount.mdx → ...elm-chart/2 - values/0 - replicaCount.mdx
@@ -5,7 +5,7 @@ id: replicaCount
 
 # replicaCount
 
-`replicaCount` adjusts the number of replicas that the GoKubeDownscaler deployment will have.
+The `replicaCount` value adjusts the number of replicas that the GoKubeDownscaler deployment will have.
 
 :::info
 The default value of `replicaCount` is:

diff --git a/...s/0 - helm-chart/3 - values/1 - image.mdx → ...s/0 - helm-chart/2 - values/1 - image.mdx b/...s/0 - helm-chart/3 - values/1 - image.mdx → ...s/0 - helm-chart/2 - values/1 - image.mdx
@@ -5,7 +5,7 @@ id: image
 
 # image
 
-`image` contains the two fields `repository` and `tag`:
+The `image` value contains the two fields `repository` and `tag`:
 
 - `repository` is the repository URL where the image versions of the GoKubeDownscaler are located.
 - `tag` is the version tag of the image.

diff --git a/...chart/3 - values/10 - securityContext.mdx → ...chart/2 - values/10 - securityContext.mdx b/...chart/3 - values/10 - securityContext.mdx → ...chart/2 - values/10 - securityContext.mdx
@@ -5,7 +5,7 @@ id: securityContext
 
 # securityContext
 
-`securityContext` defines the SecurityContext on container level.
+The `securityContext` value defines the SecurityContext on container level.
 
 :::info
 The default values for `securityContext` are:
@@ -24,4 +24,4 @@ securityContext:
 
 In this field you can customize privilege and access control settings for the GoKubeDownscaler container.
 
-You can find more information on security context in [the official kubernetes documentation][kubernetes-security-context].
+For more information on possible configuration you can reference [the official Kubernetes documentation][kubernetes-security-context].
diff --git a/... helm-chart/3 - values/11 - resources.mdx → ... helm-chart/2 - values/11 - resources.mdx b/... helm-chart/3 - values/11 - resources.mdx → ... helm-chart/2 - values/11 - resources.mdx
@@ -5,7 +5,7 @@ id: resources
 
 # resources
 
-`resources` defines the CPU and memory limits and requests.
+The `resources` value defines the CPU and memory limits and requests.
 
 :::info
 The default values for `resources` are:
@@ -26,4 +26,4 @@ Here you can adjust the minimum and maximum amounts of cpu and memory the GoKube
 
 The requests being the minimum and the limits being the maximum.
 
-You can read more about this [here](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/).
+For more information on resource management you can reference [the official Kubernetes documentation][kubernetes-resource-management].
diff --git a/...lm-chart/3 - values/12 - nodeSelector.mdx → ...lm-chart/2 - values/12 - nodeSelector.mdx b/...lm-chart/3 - values/12 - nodeSelector.mdx → ...lm-chart/2 - values/12 - nodeSelector.mdx
@@ -5,7 +5,7 @@ id: nodeSelector
 
 # nodeSelector
 
-`nodeSelector` defines labels of nodes that you want the deployment to be scheduled on.
+The `nodeSelector` value defines labels of nodes that you want the deployment to be scheduled on.
 
 :::info
 The default value for `nodeSelector` is:

diff --git a/website/content/docs/0 - helm-chart/2 - values/13 - tolerations.mdx b/website/content/docs/0 - helm-chart/2 - values/13 - tolerations.mdx
@@ -0,0 +1,31 @@
+---
+title: tolerations
+id: tolerations
+---
+
+# tolerations
+
+The `tolerations` value adds tolerations to the pods of the deployment to be able to be scheduled on nodes with matching taints.
+
+:::info
+The default value for `tolerations` is:
+
+```yaml
+tolerations: []
+```
+
+:::
+
+This field allows the GoKubeDownscaler pods to be scheduled on Nodes with certain taints.
+
+If you want to allow the GoKubeDownscaler pods to schedule on a Node with a taint `key1=value1:NoSchedule` you can set:
+
+```yaml
+tolerations:
+  - key: "key1"
+    operator: "Equal"
+    value: "value1"
+    effect: "NoSchedule"
+```
+
+For more information on taints and tolerations you can reference [the official Kubernetes documentation][kubernetes-taints-and-tolerations].
diff --git a/website/content/docs/0 - helm-chart/2 - values/14 - affinity.mdx b/website/content/docs/0 - helm-chart/2 - values/14 - affinity.mdx
@@ -0,0 +1,21 @@
+---
+title: affinity
+id: affinity
+---
+
+# affinity
+
+The `affinity` value defines rules for node affinity and pod affinity/anti-affinity.
+
+:::info
+The default value for `affinity` is:
+
+```yaml
+affinity: {}
+```
+
+:::
+
+By default the `affinity` field is empty. You can add affinity rules to this field for two .
+
+For more information on affinity you can reference [the official Kubernetes documentation][kubernetes-affinity].
diff --git a/...rt/3 - values/15 - excludedNamespaces.mdx → ...rt/2 - values/15 - excludedNamespaces.mdx b/...rt/3 - values/15 - excludedNamespaces.mdx → ...rt/2 - values/15 - excludedNamespaces.mdx
@@ -5,7 +5,7 @@ id: excludedNamespaces
 
 # excludedNamespaces
 
-`excludedNamespaces` is a list of namespaces that are supposed to be excluded from the downscaling process of the GoKubeDownscaler.
+The `excludedNamespaces` value is a list of namespaces that are supposed to be excluded from the downscaling process of the GoKubeDownscaler.
 
 :::info
 The default value for `excludedNamespaces` is:

diff --git a/... helm-chart/3 - values/16 - configMap.mdx → ... helm-chart/2 - values/16 - configMap.mdx b/... helm-chart/3 - values/16 - configMap.mdx → ... helm-chart/2 - values/16 - configMap.mdx
@@ -5,7 +5,7 @@ id: configMap
 
 # configMap
 
-`configMap` contains the two fields `name` and `extraConfig`:
+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.
@@ -21,7 +21,9 @@ configMap:
 
 :::
 
-By default the `extraConfig` field is empty. Adding a line will change how the GoKubeDownscaler behaves.
+By default the `extraConfig` field is empty. Appending a line will add the corresponding environment variable to the configMap.
+
+This then changes how the GoKubeDownscaler behaves.
 
 :::tip For example:
 
@@ -38,4 +40,4 @@ The given configuration will exclude the deployments with the name deployment1 a
 
 :::
 
-You can find a list of all possible environment variables [here][docs-environment-variables].
+You can find a list of all possible environment variables on [our documentation page][docs-environment-variables].
diff --git a/...- helm-chart/3 - values/2 - arguments.mdx → ...- helm-chart/2 - values/2 - arguments.mdx b/...- helm-chart/3 - values/2 - arguments.mdx → ...- helm-chart/2 - values/2 - arguments.mdx
@@ -5,7 +5,7 @@ id: arguments
 
 # arguments
 
-`arguments` set [layer values](#values) and runtime configuration at the start of the program.
+The `arguments` value sets [layer values][docs-layer-values] and runtime configuration at the startup of the container.
 
 :::info
 The default value for `arguments` is:
@@ -27,6 +27,7 @@ arguments:
 ```
 
 This configuration will set the GoKubeDownscaler to dry run mode, which makes it only print the actions it would have performed instead of actually scaling resources and sets the wait time between workload scans to 10 seconds.
+
 :::
 
-You can find a list of all possible arguments [here][docs-arguments].
+You can find a list of all possible arguments on [our documentation page][docs-arguments].
diff --git a/...hart/3 - values/3 - includedResources.mdx → ...hart/2 - values/3 - includedResources.mdx b/...hart/3 - values/3 - includedResources.mdx → ...hart/2 - values/3 - includedResources.mdx
@@ -5,7 +5,7 @@ id: includedResources
 
 # includedResources
 
-`includedResources` defines all the resource types that the GoKubeDownscaler is supposed to be able to handle.
+The `includedResources` value defines all the resource types that the GoKubeDownscaler is supposed to be able to handle.
 
 :::info
 The default value for `includedResources` is:

diff --git a/...chart/3 - values/4 - fullnameOverride.mdx → ...chart/2 - values/4 - fullnameOverride.mdx b/...chart/3 - values/4 - fullnameOverride.mdx → ...chart/2 - values/4 - fullnameOverride.mdx
@@ -5,7 +5,7 @@ id: fullnameOverride
 
 # fullnameOverride
 
-`fullnameOverride` overrides the names of the created Kubernetes objects with the provided name.
+The `fullnameOverride` value overrides the names of the created Kubernetes objects with the provided name.
 
 :::info
 The default value for `fullnameOverride` is:
@@ -19,6 +19,7 @@ fullnameOverride: ""
 If a value for `fullnameOverride` is set the Helm Chart will change the names of the following kubernetes objects to the one provided:
 
 - Deployment
+- ServiceAccount
 - ClusterRole
 - ClusterRoleBinding
 - Role

diff --git a/...elm-chart/3 - values/5 - nameOverride.mdx → ...elm-chart/2 - values/5 - nameOverride.mdx b/...elm-chart/3 - values/5 - nameOverride.mdx → ...elm-chart/2 - values/5 - nameOverride.mdx
@@ -5,7 +5,7 @@ id: nameOverride
 
 # nameOverride
 
-`nameOverride` overrides the chart name for the created Kubernetes objects.
+The `nameOverride` value overrides the chart name for the created Kubernetes objects.
 
 :::info
 The default value for `nameOverride` is:
@@ -19,12 +19,13 @@ nameOverride: ""
 If a value for `nameOverride` is set the Helm Chart will adjust the names of the following kubernetes objects:
 
 - Deployment
+- ServiceAccount
 - ClusterRole
 - ClusterRoleBinding
 - Role
 - RoleBinding
 
-So if you for example install the Helm Chart with the release name `my-release` and set:
+So if you for example install the Helm Chart with a release name `my-release` and set:
 
 ```yaml
 nameOverride: my-custom-name

diff --git a/.../3 - values/6 - constrainedDownscaler.mdx → .../2 - values/6 - constrainedDownscaler.mdx b/.../3 - values/6 - constrainedDownscaler.mdx → .../2 - values/6 - constrainedDownscaler.mdx
@@ -5,7 +5,7 @@ id: constrainedDownscaler
 
 # constrainedDownscaler
 
-`constrainedDownscaler` sets the GoKubeDownscaler to a constrained state if true, meaning that it does not run clusterwide but restricted to a list of namespaces.
+The `constrainedDownscaler` value sets the GoKubeDownscaler to a constrained state if true, meaning that it does not run clusterwide but restricted to a list of namespaces.
 
 :::info
 The default value for `constrainedDownscaler` is:

diff --git a/.../3 - values/7 - constrainedNamespaces.mdx → .../2 - values/7 - constrainedNamespaces.mdx b/.../3 - values/7 - constrainedNamespaces.mdx → .../2 - values/7 - constrainedNamespaces.mdx
@@ -5,7 +5,7 @@ id: constrainedNamespaces
 
 # constrainedNamespaces
 
-`constrainedNamespaces` is a comma separated list of namespaces the GoKubeDownscaler is going to operate on when constrained.
+The `constrainedNamespaces` value is a comma separated list of namespaces the GoKubeDownscaler is going to operate on when constrained.
 
 :::info
 The default value for `constrainedNamespaces` is:

diff --git a/...m-chart/3 - values/8 - serviceAccount.mdx → ...m-chart/2 - values/8 - serviceAccount.mdx b/...m-chart/3 - values/8 - serviceAccount.mdx → ...m-chart/2 - values/8 - serviceAccount.mdx
@@ -5,7 +5,7 @@ id: serviceAccount
 
 # serviceAccount
 
-`serviceAccount` contains the two fields `create` and `name`:
+The `serviceAccount` value contains the two fields `create` and `name`:
 
 - `create` is a boolean value indicating if a new ServiceAccount is supposed to be created.
 - `name` is the name of the ServiceAccount the GoKubeDownscaler is supposed to use.
@@ -28,6 +28,6 @@ This name can be overridden by the serviceAccount.name field.
 
 If you don't want to create a new service account you can set the serviceAccount.create field to false.
 
-The Helm Chart will then by default try to assign the default service account to the GoKubeDownscaler.
+The Helm Chart will then by default try to assign the service account with the `default` name to the GoKubeDownscaler.
 
 This can again be changed by providing a name in the serviceAccount.name field.
diff --git a/...art/3 - values/9 - podSecurityContext.mdx → ...art/2 - values/9 - podSecurityContext.mdx b/...art/3 - values/9 - podSecurityContext.mdx → ...art/2 - values/9 - podSecurityContext.mdx
@@ -5,7 +5,7 @@ id: podSecurityContext
 
 # podSecurityContext
 
-`podSecurityContext` defines the SecurityContext on pod level.
+The `podSecurityContext` value defines the SecurityContext on pod level.
 
 :::info
 The default values for `podSecurityContext` are:
@@ -23,4 +23,4 @@ podSecurityContext:
 
 In this field you can customize privilege and access control settings for the GoKubeDownscaler Pod.
 
-More info on all the possible configurations can be found [here](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/).
+For more information on possible configuration you can reference [the official Kubernetes documentation][kubernetes-security-context].
diff --git a/.../docs/0 - helm-chart/3 - values/index.mdx → .../docs/0 - helm-chart/2 - values/index.mdx b/.../docs/0 - helm-chart/3 - values/index.mdx → .../docs/0 - helm-chart/2 - values/index.mdx
diff --git a/website/content/docs/0 - helm-chart/3 - values/13 - tolerations.mdx b/website/content/docs/0 - helm-chart/3 - values/13 - tolerations.mdx
diff --git a/website/content/docs/0 - helm-chart/3 - values/14 - affinity.mdx b/website/content/docs/0 - helm-chart/3 - values/14 - affinity.mdx
diff --git a/website/content/guides/getting-started/0 - Installation.mdx b/website/content/guides/getting-started/0 - Installation.mdx
@@ -11,11 +11,9 @@ We provide a Helm Chart for an easy installation of the GoKubeDownscaler.
 
 In order to get started installing the GoKubeDownscaler using our Helm Chart you need:
 
-- Helm installed on a system
+- [Helm installed][helm-intro] on a system
 - have access to a Kubernetes cluster in some kind of way.
 
-You can find out how to install Helm [here][helm-intro].
-
 Also make sure your context is set to the right cluster and namespace where you want to deploy the GoKubeDownscaler.
 
 ## Install the chart
@@ -35,5 +33,5 @@ helm install go-kube-downscaler caas-team/go-kube-downscaler
 Now the GoKubeDownscaler should be properly installed.
 
 :::tip
-You can find out how to customize your installation of the GoKubeDownscaler [here][docs-helm-values].
+You can find out how to customize your installation of the GoKubeDownscaler [on our documentation page][docs-helm-values].
 :::