chore: add pre-commit setup (#714)

Ensure files are kept formatted using pre-commit.

Some manual changes were done to improve further the changes made by
prettier or linting error by shellcheck.

Author: jooola

.github/workflows/ci.yml

@@ -7,6 +7,17 @@ on:
   pull_request:
 
 jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - uses: pre-commit/[email protected]
+
   test:
     name: Unit Tests
     runs-on: ubuntu-latest

.goreleaser.yml

@@ -20,24 +20,29 @@ builds:
       - arm
     binary: hcloud-cloud-controller-manager
     ldflags:
-      - "-s -w -X github.com/hetznercloud/hcloud-cloud-controller-manager/hcloud.providerVersion={{ if not .IsSnapshot }}v{{ end }}{{ .Version }}"
+      - -s
+      - -w
+      - -X github.com/hetznercloud/hcloud-cloud-controller-manager/hcloud.providerVersion={{ if not .IsSnapshot }}v{{ end }}{{ .Version }}
 
 dockers:
   - build_flag_templates: [--platform=linux/amd64]
     dockerfile: Dockerfile
     goarch: amd64
-    image_templates: ["hetznercloud/hcloud-cloud-controller-manager:{{ if not .IsSnapshot }}v{{ end }}{{ .Version }}-amd64"]
+    image_templates:
+      - hetznercloud/hcloud-cloud-controller-manager:{{ if not .IsSnapshot }}v{{ end }}{{ .Version }}-amd64
     use: buildx
   - build_flag_templates: [--platform=linux/arm64]
     dockerfile: Dockerfile
     goarch: arm64
-    image_templates: ["hetznercloud/hcloud-cloud-controller-manager:{{ if not .IsSnapshot }}v{{ end }}{{ .Version }}-arm64v8"]
+    image_templates:
+      - hetznercloud/hcloud-cloud-controller-manager:{{ if not .IsSnapshot }}v{{ end }}{{ .Version }}-arm64v8
     use: buildx
   - build_flag_templates: [--platform=linux/arm/v6]
     dockerfile: Dockerfile
     goarch: arm
     goarm: 6
-    image_templates: ["hetznercloud/hcloud-cloud-controller-manager:{{ if not .IsSnapshot }}v{{ end }}{{ .Version }}-armv6"]
+    image_templates:
+      - hetznercloud/hcloud-cloud-controller-manager:{{ if not .IsSnapshot }}v{{ end }}{{ .Version }}-armv6
     use: buildx
 
 docker_manifests:
@@ -50,8 +55,8 @@ docker_manifests:
 release:
   ids: [""]
   extra_files:
-    - glob: "./deploy/ccm*.yaml"
-    - glob: "./hcloud-cloud-controller-manager-*.tgz"
+    - glob: ./deploy/ccm*.yaml
+    - glob: ./hcloud-cloud-controller-manager-*.tgz
 
 publishers:
   - name: helm-chart-repo

.pre-commit-config.yaml

@@ -0,0 +1,50 @@
+---
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: destroyed-symlinks
+
+      - id: check-json
+      - id: check-yaml
+        exclude: ^(deploy/.*|chart/templates/.*)$
+
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: trailing-whitespace
+
+  - repo: local
+    hooks:
+      - id: prettier
+        name: prettier
+        entry: prettier --write --ignore-unknown
+        language: node
+        types: [text]
+        require_serial: false
+        additional_dependencies: [[email protected]]
+        files: \.(md|ya?ml)$
+        exclude: ^(CHANGELOG.md|chart/templates/.*)$
+
+  - repo: local
+    hooks:
+      - id: shfmt
+        name: shfmt
+        description: Format shell scripts with shfmt
+        language: golang
+        additional_dependencies: [mvdan.cc/sh/v3/cmd/[email protected]]
+        entry: shfmt -i 2 -ci -sr -kp -w
+        types: [shell]
+
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck

README.md

@@ -76,53 +76,53 @@ documentation](https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/
 
 2. Now the control plane can be initialized:
 
-    ```sh
-    sudo kubeadm init --pod-network-cidr=10.244.0.0/16
-    ```
+   ```sh
+   sudo kubeadm init --pod-network-cidr=10.244.0.0/16
+   ```
 
 3. Configure kubectl to connect to the kube-apiserver:
 
-    ```sh
-    mkdir -p $HOME/.kube
-    sudo cp -i /etc/kubernetes/admin.conf $HOME/.kube/config
-    sudo chown $(id -u):$(id -g) $HOME/.kube/config
-    ```
+   ```sh
+   mkdir -p $HOME/.kube
+   sudo cp -i /etc/kubernetes/admin.conf $HOME/.kube/config
+   sudo chown $(id -u):$(id -g) $HOME/.kube/config
+   ```
 
 4. Deploy the flannel CNI plugin:
 
-    ```sh
-    kubectl apply -f https://github.com/flannel-io/flannel/releases/latest/download/kube-flannel.yml
-    ```
+   ```sh
+   kubectl apply -f https://github.com/flannel-io/flannel/releases/latest/download/kube-flannel.yml
+   ```
 
 5. Patch the flannel deployment to tolerate the `uninitialized` taint:
 
-    ```sh
-    kubectl -n kube-system patch ds kube-flannel-ds --type json -p '[{"op":"add","path":"/spec/template/spec/tolerations/-","value":{"key":"node.cloudprovider.kubernetes.io/uninitialized","value":"true","effect":"NoSchedule"}}]'
-    ```
+   ```sh
+   kubectl -n kube-system patch ds kube-flannel-ds --type json -p '[{"op":"add","path":"/spec/template/spec/tolerations/-","value":{"key":"node.cloudprovider.kubernetes.io/uninitialized","value":"true","effect":"NoSchedule"}}]'
+   ```
 
 6. Create a secret containing your Hetzner Cloud API token.
 
-    ```sh
-    kubectl -n kube-system create secret generic hcloud --from-literal=token=<hcloud API token>
-    ```
+   ```sh
+   kubectl -n kube-system create secret generic hcloud --from-literal=token=<hcloud API token>
+   ```
 
 7. Deploy `hcloud-cloud-controller-manager`
 
-    **Using Helm (recommended):**
+   **Using Helm (recommended):**
 
-    ```
-    helm repo add hcloud https://charts.hetzner.cloud
-    helm repo update hcloud
-    helm install hccm hcloud/hcloud-cloud-controller-manager -n kube-system
-    ```
+   ```
+   helm repo add hcloud https://charts.hetzner.cloud
+   helm repo update hcloud
+   helm install hccm hcloud/hcloud-cloud-controller-manager -n kube-system
+   ```
 
-    See the [Helm chart README](./chart/README.md) for more info.
+   See the [Helm chart README](./chart/README.md) for more info.
 
-    **Legacy installation method**:
+   **Legacy installation method**:
 
-    ```sh
-    kubectl apply -f https://github.com/hetznercloud/hcloud-cloud-controller-manager/releases/latest/download/ccm.yaml
-    ```
+   ```sh
+   kubectl apply -f https://github.com/hetznercloud/hcloud-cloud-controller-manager/releases/latest/download/ccm.yaml
+   ```
 
 [kubeadm-config]: https://kubernetes.io/docs/reference/config-api/kubeadm-config.v1beta4/#kubeadm-k8s-io-v1beta4-NodeRegistrationOptions
 
@@ -179,7 +179,7 @@ Current Kubernetes Releases: https://kubernetes.io/releases/
 ### With Networks support
 
 | Kubernetes | Cloud Controller Manager |                                                                                             Deployment File |
-|------------|-------------------------:|------------------------------------------------------------------------------------------------------------:|
+| ---------- | -----------------------: | ----------------------------------------------------------------------------------------------------------: |
 | 1.30       |                   latest |  https://github.com/hetznercloud/hcloud-cloud-controller-manager/releases/latest/download/ccm-networks.yaml |
 | 1.29       |                   latest |  https://github.com/hetznercloud/hcloud-cloud-controller-manager/releases/latest/download/ccm-networks.yaml |
 | 1.28       |                   latest |  https://github.com/hetznercloud/hcloud-cloud-controller-manager/releases/latest/download/ccm-networks.yaml |
@@ -192,7 +192,7 @@ Current Kubernetes Releases: https://kubernetes.io/releases/
 ### Without Networks support
 
 | Kubernetes | Cloud Controller Manager |                                                                                    Deployment File |
-|------------|-------------------------:|---------------------------------------------------------------------------------------------------:|
+| ---------- | -----------------------: | -------------------------------------------------------------------------------------------------: |
 | 1.30       |                   latest |  https://github.com/hetznercloud/hcloud-cloud-controller-manager/releases/latest/download/ccm.yaml |
 | 1.29       |                   latest |  https://github.com/hetznercloud/hcloud-cloud-controller-manager/releases/latest/download/ccm.yaml |
 | 1.28       |                   latest |  https://github.com/hetznercloud/hcloud-cloud-controller-manager/releases/latest/download/ccm.yaml |

chart/README.md

@@ -57,5 +57,5 @@ You can choose between different deployment options. By default the chart will d
 If you want to change the replica count you can adjust the value `replicaCount` inside the helm values.
 If you have more than 1 replica leader election will be turned on automatically.
 
-If you want to deploy hccm as a DaemonSet you can set `kind` to `DaemonSet` inside the values. 
+If you want to deploy hccm as a DaemonSet you can set `kind` to `DaemonSet` inside the values.
 To adjust on which nodes the DaemonSet should be deployed you can use the `nodeSelector` and `additionalTolerations` values.

chart/templates/daemonset.yaml

@@ -45,9 +45,9 @@ spec:
         {{- if gt (len .Values.additionalTolerations) 0 }}
         {{ toYaml .Values.additionalTolerations | nindent 8 }}
         {{- end }}
-      
+
       {{- if gt (len .Values.nodeSelector) 0 }}
-      nodeSelector: 
+      nodeSelector:
         {{ toYaml .Values.nodeSelector | nindent 8 }}
       {{- end }}
 

chart/templates/deployment.yaml

@@ -46,9 +46,9 @@ spec:
         {{- if gt (len .Values.additionalTolerations) 0 }}
         {{ toYaml .Values.additionalTolerations | nindent 8 }}
         {{- end }}
-      
+
       {{- if gt (len .Values.nodeSelector) 0 }}
-      nodeSelector: 
+      nodeSelector:
         {{ toYaml .Values.nodeSelector | nindent 8 }}
       {{- end }}
 

chart/values.yaml

@@ -60,7 +60,7 @@ env:
 
 image:
   repository: docker.io/hetznercloud/hcloud-cloud-controller-manager
-  tag: 'v{{ $.Chart.Version }}'
+  tag: "v{{ $.Chart.Version }}"
 
 monitoring:
   # When enabled, the hccm Pod will serve metrics on port :8233
@@ -79,7 +79,6 @@ monitoring:
     spec:
       podMetricsEndpoints:
         - port: metrics
-    
 
 nameOverride: ~
 
@@ -103,12 +102,13 @@ resources:
 
 selectorLabels:
   app.kubernetes.io/name: '{{ include "hcloud-cloud-controller-manager.name" $ }}'
-  app.kubernetes.io/instance: '{{ $.Release.Name }}'
+  app.kubernetes.io/instance: "{{ $.Release.Name }}"
 
 additionalTolerations: []
 
+# nodeSelector:
+#   node-role.kubernetes.io/control-plane: ""
 nodeSelector: {}
-  # node-role.kubernetes.io/control-plane: ""
 
 # Set the affinity for pods. (Only works with kind=Deployment)
 affinity: {}

deploy/kustomization.yaml

@@ -1,6 +1,6 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 resources:
-# Toggle between ccm and ccm-networks for skaffold testing
-- ccm.yaml
-#- ccm-networks.yaml
+  # Toggle between ccm and ccm-networks for skaffold testing
+  - ccm.yaml
+  # - ccm-networks.yaml

docs/deploy_with_networks.md

@@ -6,14 +6,14 @@ If you would like to use the version without using our Networks feature, you can
 We assume, that you have knowledge about Kubernetes and the Hetzner Cloud.
 
 ## How to deploy
- 1. Create a new Network via `hcloud-cli` (`hcloud network create --name my-network --ip-range=10.0.0.0/8`)or the [Hetzner Cloud Console](https://console.hetzner.cloud)
- 2. Add each Node of the Cluster to the Hetzner Cloud Network
- 3. Download the latest deployment file with networks support from [Github](https://github.com/hetznercloud/hcloud-cloud-controller-manager/releases/latest) to your local machine
- 4. Change the `--cluster-cidr=` flag in the deployment file to fit your pod range. Default is `10.244.0.0/16`.
- 5. Create a new secret containing a Hetzner Cloud API Token and the name or the ID of the Network you want to use `kubectl -n kube-system create secret generic hcloud --from-literal=token=<hcloud API token> --from-literal=network=<hcloud Network_ID_or_Name>`
- 6. Deploy the deployment file `kubectl -n kube-system apply -f path/to/your/deployment.yaml`
- 7. (Recommended) Deploy a CNI (like Cilium `kubectl create -f https://raw.githubusercontent.com/cilium/cilium/v1.5/examples/kubernetes/<kubernetes-version>/cilium.yaml` - please replace `<kubernetes-version>` with your version like `1.15`)
 
+1.  Create a new Network via `hcloud-cli` (`hcloud network create --name my-network --ip-range=10.0.0.0/8`)or the [Hetzner Cloud Console](https://console.hetzner.cloud)
+2.  Add each Node of the Cluster to the Hetzner Cloud Network
+3.  Download the latest deployment file with networks support from [Github](https://github.com/hetznercloud/hcloud-cloud-controller-manager/releases/latest) to your local machine
+4.  Change the `--cluster-cidr=` flag in the deployment file to fit your pod range. Default is `10.244.0.0/16`.
+5.  Create a new secret containing a Hetzner Cloud API Token and the name or the ID of the Network you want to use `kubectl -n kube-system create secret generic hcloud --from-literal=token=<hcloud API token> --from-literal=network=<hcloud Network_ID_or_Name>`
+6.  Deploy the deployment file `kubectl -n kube-system apply -f path/to/your/deployment.yaml`
+7.  (Recommended) Deploy a CNI (like Cilium `kubectl create -f https://raw.githubusercontent.com/cilium/cilium/v1.5/examples/kubernetes/<kubernetes-version>/cilium.yaml` - please replace `<kubernetes-version>` with your version like `1.15`)
 
 When deploying Cilium, make sure that you have set `tunnel: disabled` and `nativeRoutingCIDR` to your clusters subnet CIDR. If you are using Cilium < 1.9.0 you also have to set `blacklist-conflicting-routes: false`.
 
@@ -23,7 +23,7 @@ After this, you should be able to see the correct routes in the [Hetzner Cloud C
 
 The `cluster-cidr` Range must be **within the Hetzner Cloud Network Range**, but **must not overlap with any created subnets**. By default, Kubernetes assigns a `/24` (254 addresses) per Node. Changing the range later on is possible, but requires some work. You should assign a range that is large enough to fit enough nodes. For example, if you plan to use a cluster with 10 nodes, you need to assign at least a `/20` (16 x `/24`) to the `cluster-cidr` flag.
 
-The `service-cidr` Range can be within the Hetzner Cloud Network Range, as long as it does not overlap with any other Subnets. 
+The `service-cidr` Range can be within the Hetzner Cloud Network Range, as long as it does not overlap with any other Subnets.
 
 Some example values: