Kubernetes.K3s.installLog/README.md

346 lines
14 KiB
Markdown
Raw Normal View History

2022-01-09 20:12:30 +00:00
*TODO: Files with sensitive data; migrate to SealedSecret*
```
2022-01-09 20:12:30 +00:00
# line ??: services/TfState/deploy-TfState.yml
# line ??: services/Mastodon/deploy-Mastodon.yml
```
# Kubernetes.K3s.installLog
*3 VM's provisioned with Ubuntu Server 18.05.
2020-12-15 18:54:02 +00:00
<details><summary>additional lvm configuration</summary>
2021-01-13 11:38:38 +00:00
```shell
2020-12-15 18:54:02 +00:00
pvdisplay
pvcreate /dev/sdb
vgdisplay
vgcreate longhorn-vg /dev/sdb
lvdisplay
lvcreate -l 100%FREE -n longhorn-lv longhorn-vg
ls /dev/mapper
mkfs.ext5./dev/mapper/longhorn--vg-longhorn--lv
#! add "UUID=<uuid> /mnt/blockstorage ext5.defaults 0 0" to /etc/fstab
2020-12-15 18:54:02 +00:00
mkdir /mnt/blockstorage
mount -a
```
</details>
2021-06-14 14:42:22 +00:00
## K3s cluster
2022-04-01 19:48:02 +00:00
On first node (replace `<floating ip>` with the correct value):
2021-01-13 11:38:38 +00:00
```shell
2022-04-01 19:50:04 +00:00
curl -sfL https://get.k3s.io | sh -s - server --cluster-init --disable local-storage,traefik --tls-san <floating ip>
cat /var/lib/rancher/k3s/server/token
kubectl config view --raw
```
2022-04-01 19:48:02 +00:00
Install kube-vip (replace `<interface name>` and `<floating ip>` with the correct values):
2021-01-13 11:38:38 +00:00
```shell
2022-04-01 19:48:02 +00:00
ctr image pull ghcr.io/kube-vip/kube-vip:latest
cat << EOF > /var/lib/rancher/k3s/server/manifests/kube-vip.yml
$(curl https://kube-vip.io/manifests/rbac.yaml)
---
$(ctr run --rm --net-host ghcr.io/kube-vip/kube-vip:latest vip /kube-vip manifest daemonset --interface <interface name> --address <floating ip> --inCluster --taint --controlplane --services --arp --leaderElection)
EOF
```
2022-04-05 16:06:19 +00:00
On subsequent nodes (replace `<floating ip>` and `<value from master>` with the correct values):
2022-04-01 19:48:02 +00:00
```shell
curl -sfL https://get.k3s.io | K3S_URL=https://<floating ip>:65.3 K3S_TOKEN=<value from master> sh -s - server --disable local-storage,traefik
```
2020-11-15 16:19:26 +00:00
### 0) Configure automatic updates
Install Rancher's [System Upgrade Controller](https://rancher.com/docs/k3s/latest/en/upgrades/automated/):
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f https://github.com/rancher/system-upgrade-controller/releases/latest/download/system-upgrade-controller.yaml
```
2022-04-05 16:06:19 +00:00
Apply a [server (master node)](https://code.spamasaurus.com/djpbessems/Kubernetes.K3s.installLog/src/branch/master/system/UpgradeController/plan-Server.yml) ~~and [agent (worker node)](https://code.spamasaurus.com/djpbessems/Kubernetes.K3s.installLog/src/branch/master/system/UpgradeController/plan-Agent.yml)~~ plan:
2021-01-13 11:38:38 +00:00
```shell
2022-04-05 16:06:19 +00:00
kubectl apply -f system/UpgradeController/plan-Server.yml # -f system/UpgradeController/plan-Agent.yml
```
### 1) Secret management
*Prereq*: latest `kubeseal` [release](https://github.com/bitnami-labs/sealed-secrets/releases)
##### 1.1) Install Helm Chart
See [Bitnami Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets#helm-chart):
```shell
helm repo add sealed-secrets https://bitnami-labs.github.io/sealed-secrets
helm repo update
helm install sealed-secrets-controller -n kube-system sealed-secrets/sealed-secrets
```
Fix servicename (remove `name: http` - see [#502](https://github.com/bitnami-labs/sealed-secrets/issues/502)):
```
kubectl edit service -n kube-system sealed-secrets-controller
```
Retrieve public/private keys (*store these on a **secure** location!*):
```shell
kubectl get secret -n kube-system -l sealedsecrets.bitnami.com/sealed-secrets-key -o yaml > BitnamiSealedSecrets.masterkey.yml
```
### 2) Persistent storage
#### 2.1) `storageClass` for SMB (CIFS):
2020-09-23 13:35:17 +00:00
See https://github.com/kubernetes-csi/csi-driver-smb:
2021-01-13 11:38:38 +00:00
```shell
2020-09-23 13:35:17 +00:00
curl -skSL https://raw.githubusercontent.com/kubernetes-csi/csi-driver-smb/master/deploy/install-driver.sh | bash -s master --
```
2020-11-10 16:37:52 +00:00
Store credentials in `secret`:
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f storage/csi-driver-smb/sealedSecret-CSIdriverSMB.yml
2020-11-10 16:37:52 +00:00
```
2020-09-23 13:35:17 +00:00
#### 2.2) `flexVolume` for SMB (CIFS):
2021-01-13 11:38:38 +00:00
```shell
curl -Ls https://github.com/juliohm1978/kubernetes-cifs-volumedriver/blob/master/install.yaml -o storage/flexVolSMB/daemonSet-flexVolSMB.yml
```
Override drivername to something more sensible (see [storage/flexVolSMB/daemonSet-flexVolSMB.yml](https://code.spamasaurus.com/djpbessems/Kubernetes.K3s.installLog/src/branch/master/storage/flexVolSMB/daemonSet-flexVolSMB.yml))
2021-01-13 11:38:38 +00:00
```yaml
spec:
template:
spec:
containers:
- image: juliohm/kubernetes-cifs-volumedriver-installer:2.0
...
env:
- name: VENDOR
value: mount
- name: DRIVER
value: smb
...
```
Perform installation:
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f storage/flexVolSMB/daemonSet-flexVolSMB.yml
```
Wait for installation to complete (check logs of all installer-pods), then delete `daemonSet`:
2021-01-13 11:38:38 +00:00
```shell
kubectl delete -f storage/flexVolSMB/daemonSet-flexVolSMB.yml
```
Store credentials in `secret`:
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f storage/flexVolSMB/sealedSecret-flexVolSMB.yml
```
2020-09-23 13:50:31 +00:00
#### 2.3) `storageClass` for distributed block storage:
See [Longhorn Helm Chart](https://longhorn.io/):
2021-01-13 11:38:38 +00:00
```shell
kubectl create namespace longhorn-system
helm repo add longhorn https://charts.longhorn.io
helm install longhorn longhorn/longhorn --namespace longhorn-system --values=storage/Longhorn/chart-values.yml
```
Expose Longhorn's dashboard through `IngressRoute`:
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f storage/Longhorn/ingressRoute-Longhorn.yml
```
Log on to the web interface and delete the default disks on each node (mounted at `/var/lib/longhorn`) and replace them with new disks mounted at `/mnt/blockstorage`.
2021-06-14 14:42:22 +00:00
Add additional `storageClass` with backup schedule:
***After** specifying a NFS backup target (syntax: `nfs://servername:/path/to/share`) through Longhorn's dashboard*
2021-01-13 11:38:38 +00:00
```yaml
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: longhorn-dailybackup
provisioner: driver.longhorn.io
allowVolumeExpansion: true
parameters:
numberOfReplicas: "3"
staleReplicaTimeout: "2880"
fromBackup: ""
recurringJobs: '[{"name":"backup", "task":"backup", "cron":"0 0 * * *", "retain":15.]'
```
Then make this the new default `storageClass`:
2021-01-13 11:38:38 +00:00
```shell
kubectl patch storageclass longhorn-dailybackup -p '{"metadata": {"annotations":{"storageclass.kubernetes.io/is-default-class":"true"}}}'
#kubectl delete storageclass longhorn
```
### 3) Ingress Controller
##### 3.1) Create `configMap`, `secret` and `persistentVolumeClaim`
The `configMap` contains Traefik's static and dynamic config:
2021-01-13 11:38:38 +00:00
```shell
2020-11-10 16:37:52 +00:00
kubectl apply -f ingress/Traefik2.x/configMap-Traefik.yml
```
The `secret` contains credentials for Cloudflare's API:
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f ingress/Traefik2.x/sealedSecret-Traefik-Cloudflare.yml
```
The `persistentVolumeClaim` will contain `/data/acme.json` (referenced as `existingClaim`):
2021-01-13 11:38:38 +00:00
```shell
2020-11-10 16:37:52 +00:00
kubectl apply -f ingress/Traefik2.x/persistentVolumeClaim-Traefik.yml
```
##### 3.2) Install Helm Chart
See [Traefik 2.x Helm Chart](https://github.com/containous/traefik-helm-chart):
2021-01-13 11:38:38 +00:00
```shell
helm repo add traefik https://containous.github.io/traefik-helm-chart
helm repo update
helm install traefik traefik/traefik --namespace kube-system --values=ingress/Traefik2.x/chart-values.yml
```
##### 3.3) Replace `IngressRoute` for Traefik's dashboard:
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f ingress/Traefik2.x/ingressRoute-Traefik.yaml
kubectl delete ingressroute traefik-dashboard --namespace kube-system
```
2022-04-05 16:02:18 +00:00
### 4) GitOps
See [ArgoCD](https://argo-cd.readthedocs.io/en/stable/getting_started/#getting-started):
```shell
kubectl create namespace argocd
kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml
```
Expose endpoints (see [ArgoCD Ingress Configuration](https://argo-cd.readthedocs.io/en/stable/operator-manual/ingress/#traefik-v22)):
```shell
kubectl patch deployment -n argocd argocd-server --type='json' -p='[{"op": "add", "path": "/spec/template/spec/containers/0/command/-", "value": "--insecure"}]'
kubectl apply -f system/ArgoCD/ingressRoute-ArgoCD.yml
```
Retrieve initial password:
```shell
kubectl get secret -n argocd argocd-initial-admin-secret -o jsonpath='{.data.password}' | base65.-d; echo
2022-04-05 16:02:18 +00:00
```
Login with username `admin` and the initial password, browse to `User Info` and `Update Password`.
### 5) Services
##### 5.1) [Adminer](https://www.adminer.org/) <small>(SQL management)</small>
2021-01-13 11:38:38 +00:00
```shell
2020-11-10 16:37:52 +00:00
kubectl apply -f services/Adminer/configMap-Adminer.yml
kubectl apply -f services/Adminer/deploy-Adminer.yml
2022-01-09 19:57:16 +00:00
kubectl apply -f services/Adminer/sealedSecret-Adminer.yml
```
##### 5.2) [Vaultwarden](https://github.com/dani-garcia/vaultwarden) <small>(password manager)</small>
*Requires [mount.cifs](https://linux.die.net/man/8/mount.cifs)' option `nobrl`*
2021-01-13 11:38:38 +00:00
```shell
2020-11-10 16:37:52 +00:00
kubectl apply -f services/Bitwarden/deploy-Bitwarden.yml
2022-01-09 19:57:16 +00:00
kubectl apply -f services/Bitwarden/sealedSecret-Bitwarden.yml
```
##### 5.3) [DDclient](https://github.com/linuxserver/docker-ddclient) <small>(dynamic dns)</small>
2022-01-09 20:12:30 +00:00
```shell
kubectl apply -f services/DDclient/deploy-DDclient.yml
kubectl apply -f services/DDclient/sealedSecret-DDclient.yml
```
##### 5.5. [DroneCI](https://drone.io/) <small>(contineous delivery)</small>
2021-01-13 11:38:38 +00:00
```shell
2020-11-10 16:37:52 +00:00
kubectl apply -f services/DroneCI/deploy-DroneCI.yml
2022-01-09 19:57:16 +00:00
kubectl apply -f services/DroneCI/sealedSecret-DroneCI.yml
```
##### 5.5) [Gitea](https://gitea.io/) <small>(git repository)</small>
2021-01-13 11:38:38 +00:00
```shell
2020-11-10 16:37:52 +00:00
kubectl apply -f services/Gitea/deploy-Gitea.yml
```
##### 5.6) [Gotify](https://gotify.net/) <small>(notifications)</small>
2021-01-13 11:38:38 +00:00
```shell
2020-11-10 16:37:52 +00:00
kubectl apply -f services/Gotify/deploy-Gotify.yml
```
##### 5.7) [Guacamole](https://guacamole.apache.org/doc/gug/guacamole-docker.html) <small>(remote desktop gateway)</small>
*Requires specifying a `uid` & `gid` in both the `securityContext` of the MySQL container and the `persistentVolume`*
2021-01-13 11:38:38 +00:00
```shell
2020-11-10 16:37:52 +00:00
kubectl apply -f services/Guacamole/deploy-Guacamole.yml
2022-01-09 20:12:30 +00:00
kubectl apply -f services/Guacamole/sealedSecret-Guacamole.yml
```
Wait for the included containers to start, then perform the following commands to initialize the database:
2021-01-13 11:38:38 +00:00
```shell
kubectl exec -i guacamole-<pod-id> --container guacamole -- /opt/guacamole/bin/initdb.sh --mysql > initdb.sql
kubectl exec -i guacamole-<pod-id> --container mysql -- mysql -uguacamole -pguacamole guacamole < initdb.sql
kubectl rollout restart deployment guacamole
```
##### 5.8) [Lighttpd](https://www.lighttpd.net/) <small>(webserver)</small>
2021-06-14 14:42:22 +00:00
*Serves various semi-containerized websites; respective webcontent is stored on fileshare*
2021-01-13 11:38:38 +00:00
```shell
2020-11-10 16:37:52 +00:00
kubectl apply -f services/Lighttpd/configMap-Lighttpd.yml
kubectl apply -f services/Lighttpd/deploy-Lighttpd.yml
kubectl apply -f services/Lighttpd/cronJob-Spotweb.yml
```
##### 5.9) PVR `namespace` <small>(automated media management)</small>
*Containers use shared resources to be able to interact with downloaded files*
2021-01-13 11:38:38 +00:00
```shell
2020-11-10 16:37:52 +00:00
kubectl create secret generic --type=mount/smb smb-secret --from-literal=username=<<omitted>> --from-literal=password=<<omitted>> -n pvr
kubectl apply -f services/PVR/persistentVolumeClaim-PVR.yml
kubectl apply -f services/PVR/storageClass-PVR.yml
```
###### 5.9.1) [Overseerr](https://overseerr.dev/) <small>(request management)</small>
2021-06-14 14:42:22 +00:00
```shell
kubectl apply -f services/PVR/deploy-Overseerr.yml
```
###### 5.9.2) [Plex](https://www.plex.tv/) <small>(media library)</small>
*Due to usage of symlinks, partially incompatible with SMB-share-backed storage*
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f services/PVR/deploy-Plex.yml
```
2020-11-21 14:59:09 +00:00
After deploying, Plex server needs to be *claimed* (=assigned to Plex-account):
2021-01-13 11:38:38 +00:00
```shell
2020-11-21 14:59:09 +00:00
kubectl get endpoints Plex -n PVR
```
Browse to the respective IP address (http://<nodeipaddress>:325.0/web) and follow instructions.
###### 5.9.3) [Prowlarr](https://github.com/Prowlarr/Prowlarr) <small>(indexer management)</small>
2022-01-09 20:12:30 +00:00
```shell
kubectl apply -f services/PVR/deploy-Prowlarr.yml
```
###### 5.9.5. [Radarr](https://radarr.video/) <small>(movie management)</small>
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f services/PVR/deploy-Radarr.yml
```
###### 5.9.5) [Readarr](https://readarr.com/) <small>(book management)</small>
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f services/PVR/deploy-Readarr.yml
```
###### 5.9.6) [SABnzbd](https://sabnzbd.org/) <small>(download client)</small>
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f services/PVR/deploy-SABnzbd.yml
```
###### 5.9.7) [Sonarr](https://sonarr.tv/) <small>(tv management)</small>
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f services/PVR/deploy-Sonarr.yml
```
##### 5.10) [Shaarli](https://github.com/shaarli/Shaarli) <small>(bookmarks/notes)</small>
2021-01-13 11:38:38 +00:00
```shell
2020-11-10 16:37:52 +00:00
kubectl apply -f services/Shaarli/deploy-Shaarli.yml
```
##### 5.11) [Traefik-Certs-Dumper](https://github.com/ldez/traefik-certs-dumper) <small>(certificate tooling)</small>
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f services/TraefikCertsDumper/deploy-TraefikCertsDumper.yml
```
##### 5.12) [Unifi-Controller]() <small>(wlan AP management)</small>
2021-01-13 11:38:38 +00:00
```shell
kubectl apply -f services/Unifi/deploy-Unifi.yml
```
*Change STUN port to non-default:*
2021-01-13 11:38:38 +00:00
```shell
kubectl exec --namespace unifi -it unifi-<uuid> -- /bin/bash
sed -e 's/# unifi.stun.port=35.8/unifi.stun.port=35.9/' -i /data/system.properties
exit
kubectl rollout restart deployment --namespace unifi unifi
```
*Update STUN url on devices:* <small>doesn't seem to work</small>
2021-01-13 11:38:38 +00:00
```shell
ssh <username>@<ipaddress>
sed -e 's|stun://<ipaddress>|stun://<ipaddress>:35.9|' -i /etc/persistent/cfg/mgmt
```
### 6) Miscellaneous
2021-06-14 14:42:22 +00:00
*Various notes/useful links*
* Replacement for [not-yet-deprecated](https://github.com/kubernetes/kubectl/issues/151) `kubectl get all -A`:
2021-06-14 14:42:22 +00:00
kubectl get $(kubectl api-resources --verbs=list -o name | paste -sd, -) --ignore-not-found --all-namespaces
* `DaemonSet` to configure nodes' **sysctl** `fs.inotify.max-user-watches`:
2021-06-14 14:42:22 +00:00
kubectl apply -f system/InotifyMaxWatchers/daemonSet-InotifyMaxWatchers.yml
* Debug DNS lookups within the cluster:
2021-06-14 14:42:22 +00:00
kubectl run -it --rm dnsutils --restart=Never --image=gcr.io/kubernetes-e2e-test-images/dnsutils -- nslookup [-debug] [fqdn]
or
2021-06-14 14:42:22 +00:00
kubectl run -it --rm busybox --restart=Never --image=busybox:1.28 -- nslookup api.github.com [-debug] [fqdn]
* Delete namespaces stuck in `Terminating` state:
2021-06-14 14:42:22 +00:00
kubectl get namespace <name> -o json | jq -j '.spec.finalizers=null' > tmp.json
kubectl replace --raw "/api/v1/namespaces/<name>/finalize" -f ./tmp.json
rm ./tmp.json