diff --git a/README.md b/README.md
index c93fd29f..3c353e75 100644
--- a/README.md
+++ b/README.md
@@ -2,17 +2,6 @@
Welcome to my highly opinionated template for deploying a single Kubernetes ([k3s](https://k3s.io)) cluster with [Ansible](https://www.ansible.com) and managing applications with [Flux](https://toolkit.fluxcd.io/). Upon completion you will be able to expose web applications you choose to the internet with [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/).
-## Overview
-
-- [Introduction](https://github.com/onedr0p/flux-cluster-template#-introduction)
-- [Prerequisites](https://github.com/onedr0p/flux-cluster-template#-prerequisites)
-- [Repository structure](https://github.com/onedr0p/flux-cluster-template#-repository-structure)
-- [Lets go!](https://github.com/onedr0p/flux-cluster-template#-lets-go)
-- [Post installation](https://github.com/onedr0p/flux-cluster-template#-post-installation)
-- [Troubleshooting](https://github.com/onedr0p/flux-cluster-template#-troubleshooting)
-- [What's next](https://github.com/onedr0p/flux-cluster-template#-whats-next)
-- [Thanks](https://github.com/onedr0p/flux-cluster-template#-thanks)
-
## 👋 Introduction
The following components will be installed in your [k3s](https://k3s.io/) cluster by default. Most are only included to get a minimum viable cluster up and running.
@@ -28,26 +17,24 @@ The following components will be installed in your [k3s](https://k3s.io/) cluste
_Additional applications can be enabled in the [addons](./bootstrap/vars/addons.sample.yaml) configuration file_
-## 📝 Prerequisites
+## 📝 Pre-start checklist
-1. Please bring a **positive attitude** and be ready to learn and fail a lot. The more you fail, the more you can learn from.
-2. This was designed to run in your home network on bare metal machines or VMs **NOT** in the cloud.
-3. You **MUST** have a domain you can manage on Cloudflare.
-4. Secrets will be commited to your Git repository **AND** they will be encrypted by SOPS.
-5. By default your domain name will **NOT** be visible to the public.
-6. To reach internal-only apps you **MUST** have a DNS server that supports split DNS (Pi-Hole, Blocky, Dnsmasq, Unbound, etc...) deployed somewhere outside your cluster **ON** your home network.
-7. In order for this all to work you have to use nodes that have access to the internet. This is not going to work in air-gapped environments.
-8. Only **amd64** and/or **arm64** nodes are supported.
+Before we get started, everything below must be taken into consideration.
+
+- [ ] Bring a **positive attitude** and be ready to learn and fail a lot. _The more you fail, the more you can learn from._
+- [ ] This was designed to run in your home network on bare metal machines or VMs **NOT** in the cloud.
+- [ ] You **MUST** have a domain you can manage on Cloudflare.
+- [ ] Secrets will be commited to your Git repository **AND** they will be encrypted by SOPS.
+- [ ] Your domain name will **NOT** be visible to the public.
+- [ ] You **MUST** have a DNS server that supports split DNS (e.g. Pi-Hole) deployed somewhere outside your cluster **ON** your home network.
+- [ ] You have to use nodes that have access to the internet. _This is not going to work in air-gapped environments._
+- [ ] Only **amd64** and/or **arm64** nodes are supported.
With that out of the way please continue on if you are still interested...
-### 📚 Reading material
+## 💻 System Preparation
-- [Organizing Cluster Access Using kubeconfig Files](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/)
-
-### 💻 System Preparation
-
-Download [Debian 12](https://cdimage.debian.org/debian-cd/current/amd64/iso-dvd/) (for raspi/arm64 use the [tested images](https://raspi.debian.net/tested-images/))
+Download [Debian 12](https://cdimage.debian.org/debian-cd/current/amd64/iso-dvd/) (or if using ARM64 / Raspberry Pi use the [tested images](https://raspi.debian.net/tested-images/))
#### AMD64
@@ -56,10 +43,10 @@ There is a decent guide [here](https://www.linuxtechi.com/how-to-install-debian-
1. Deviations from that guide
```txt
- - Choose "Guided - use entire disk"
- - Choose "All files in one partition"
- - Delete Swap partition
- - Uncheck all Debian desktop environment options
+ Choose "Guided - use entire disk"
+ Choose "All files in one partition"
+ Delete Swap partition
+ Uncheck all Debian desktop environment options
```
2. [Post install] Remove CD/DVD as apt source
@@ -85,6 +72,8 @@ There is a decent guide [here](https://www.linuxtechi.com/how-to-install-debian-
4. [Post install] Add SSH keys (or use `ssh-copy-id` on the client that is connecting)
+ 📍 _First make sure your ssh keys are up-to-date and added to your github account as [instructed](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)._
+
```sh
mkdir -m 700 ~/.ssh
sudo apt install curl
@@ -92,7 +81,7 @@ There is a decent guide [here](https://www.linuxtechi.com/how-to-install-debian-
chmod 600 ~/.ssh/authorized_keys
```
-#### Raspberry Pi / ARM64
+#### ARM64 / Raspberry Pi
If you choose to use a Raspberry Pi for the cluster, it is recommended to have at minimum a Raspberry Pi4 (4GB) and preferably an 8GB model. Additionally, it is also recommended to boot from an external SSD, rather than the SD card. This is supported [natively](https://www.raspberrypi.com/documentation/computers/raspberry-pi.html), however if you have an early Raspberry Pi4, you may need to [update the bootloader](https://www.tomshardware.com/how-to/boot-raspberry-pi-4-usb).
@@ -103,17 +92,15 @@ According to the documentation [here](https://raspi.debian.net/defaults-and-sett
3. Change `root_pw` to your desired root password.
4. Change `hostname` to your desired hostname.
-## 🚀 Lets go
+## 🚀 First Steps
-Very first step will be to create a new **public** repository by clicking the big green **Use this template** button on this page.
+The very first step will be to create a new **public** repository by clicking the big green **Use this template** button on this page. Next clone **your new repo** to you local workstation and `cd` into it.
-Clone **your new repo** to you local workstation and `cd` into it.
+📍 _**All of the below commands** are run on your **local** workstation, **not** on any of your cluster nodes._
-📍 **All of the below commands** are run on your **local** workstation, **not** on any of your cluster nodes.
+## 🔧 Workstation Tools
-### 🔧 Workstation Tools
-
-📍 Install the **most recent version** of the CLI tools below. If you are **having trouble with future steps**, it is very likely you don't have the most recent version of these CLI tools. The most troublesome are `ansible`, `go-task`, and `sops`.
+📍 _Install the **most recent version** of the CLI tools below. If you are **having trouble with future steps**, it is very likely you **don't have the most recent version** of these CLI tools. The most troublesome are `ansible`, `go-task`, and `sops`._
1. Install the following CLI tools on your workstation, if you are using [Homebrew](https://brew.sh/) skip this step and move onto 2 & 3.
@@ -133,92 +120,100 @@ Clone **your new repo** to you local workstation and `cd` into it.
task brew:deps
```
-### 🔐 Setting up Age
+## 🌱 Environment
-📍 Using [SOPS](https://github.com/mozilla/sops) with [Age](https://github.com/FiloSottile/age) allows us to encrypt secrets and use them in Ansible and Flux.
+Take a moment and configure [direnv](https://direnv.net/). This tool will make it so anytime you `cd` to your repo's directory it export the required environment variables (e.g. `KUBECONFIG`). To set this up make sure you [hook it into your shell](https://direnv.net/docs/hook.html) and after that is done, run `direnv allow` while in your repos directory.
-1. Create a Age private / public key
+## 📄 Configuration
- ```sh
- age-keygen -o age.agekey
- ```
+📍 _Both `bootstrap/vars/config.yaml` and `bootstrap/vars/addons.yaml` files contain necessary information that is needed by bootstrap process._
-2. Create the directory for the Age key and move the Age file to it
-
- ```sh
- mkdir -p ~/.config/sops/age
- mv age.agekey ~/.config/sops/age/keys.txt
- ```
-
-3. Export the `SOPS_AGE_KEY_FILE` variable in your `bashrc`, `zshrc` or `config.fish` and source it, e.g.
-
- ```sh
- export SOPS_AGE_KEY_FILE=~/.config/sops/age/keys.txt
- source ~/.bashrc
- ```
-
-4. Fill out the Age public key in the appropriate variable in configuration section below, **note** the public key should start with `age`...
-
-### ☁️ Cloudflare API Token
-
-In order to use `cert-manager` with the Cloudflare DNS challenge you will need to create a API Token.
-
-1. Head over to Cloudflare and create a API Token by going [here](https://dash.cloudflare.com/profile/api-tokens).
-
-2. Under the `API Tokens` section, click the blue "Create Token" button.
-
-3. Click the "Use template" blue button for the `Edit zone DNS` template.
-
-4. Give your token a name like `home-k8s-cluster`
-
-5. Under `Permissions`, click `+ Add More` and add each permission below:
-
- ```text
- Zone - DNS - Edit # should be there already if using the template from the previous step
- Account - Cloudflare Tunnel - Read
- ```
-
- 📍 Feel free to limit the permissions to a specific account and zone resources.
-
-6. Use the API Token in the appropriate variable in configuration section below.
-
-### ☁️ Cloudflare Tunnel
-
-In order to expose services to the internet you will need to create a [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/).
-
-1. Authenticate cloudflared to your domain
-
- ```sh
- cloudflared tunnel login
- ```
-
-2. Create the tunnel
-
- ```sh
- cloudflared tunnel create k8s
- ```
-
-3. In the `~/.cloudflared` directory there will be a json file with details you need to populate in configuration section below. You can ignore the `cert.pem` file.
-
-### 📄 Configuration
-
-📍 The `bootstrap/vars/config.yaml` file contains necessary configuration that is needed by Ansible and Flux. The `bootstrap/vars/addons.yaml` file allows you to customize which additional apps you want deployed in your cluster. These files are added to the `.gitignore` file and will not be tracked by Git.
-
-1. Copy the configuration and addons files and start filling out all the variables.
+1. Generate the `bootstrap/vars/config.yaml` and `bootstrap/vars/addons.yaml` configuration files.
```sh
task init
```
-2. Once done run the following command which will verify and generate all the files needed to continue.
+2. Setup Age private / public key
+
+ 📍 _Using [SOPS](https://github.com/getsops/sops) with [Age](https://github.com/FiloSottile/age) allows us to encrypt secrets and use them in Ansible and Flux._
+
+ 2a. Create a Age private / public key
+
+ ```sh
+ age-keygen -o age.agekey
+ ```
+
+ 2b. Create the directory for the Age key and move the Age file to it
+
+ ```sh
+ mkdir -p ~/.config/sops/age
+ mv age.agekey ~/.config/sops/age/keys.txt
+ ```
+
+ 3b. Export the `SOPS_AGE_KEY_FILE` variable in your `bashrc`, `zshrc` or `config.fish` and source it, e.g.
+
+ ```sh
+ export SOPS_AGE_KEY_FILE=~/.config/sops/age/keys.txt
+ source ~/.bashrc
+ ```
+
+ 3c. Fill out the appropriate vars in `bootstrap/vars/config.yaml`
+
+3. Create Cloudflare API Token
+
+ 📍 _To use `cert-manager` with the Cloudflare DNS challenge you will need to create a API Token._
+
+ 3a. Head over to Cloudflare and create a API Token by going [here](https://dash.cloudflare.com/profile/api-tokens).
+
+ 3b. Under the `API Tokens` section click the blue `Create Token` button.
+
+ 3c. Click the blue `Use template` button for the `Edit zone DNS` template.
+
+ 3d. Name your token something like `home-kubernetes`
+
+ 3e. Under `Permissions`, click `+ Add More` and add each permission below:
+
+ ```text
+ Zone - DNS - Edit
+ Account - Cloudflare Tunnel - Read
+ ```
+
+ 3f. Limit the permissions to a specific account and zone resources.
+
+ 3g. Fill out the appropriate vars in `bootstrap/vars/config.yaml`
+
+4. Create Cloudflare Tunnel
+
+ 📍 _To expose services to the internet you will need to create a [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/)._
+
+ 4a. Authenticate cloudflared to your domain
+
+ ```sh
+ cloudflared tunnel login
+ ```
+
+ 4b. Create the tunnel
+
+ ```sh
+ cloudflared tunnel create k8s
+ ```
+
+ 4c. In the `~/.cloudflared` directory there will be a json file with details you need. Ignore the `cert.pem` file.
+
+ 4d. Fill out the appropriate vars in `bootstrap/vars/config.yaml`
+
+5. Complete filling out the rest of the `bootstrap/vars/config.yaml` configuration file.
+
+ 5a. [Optional] Update `bootstrap/vars/addons.yaml` and enable applications you would like included.
+
+6. Once done run the following command which will verify and generate all the files needed to continue.
```sh
task configure
```
-### 📂 Repository structure
-
-The configure script will have created a `./ansible` directory and the following directories under `./kubernetes`.
+📍 _The configure task will create a `./ansible` directory and the following directories under `./kubernetes`._
```sh
📁 kubernetes # Kubernetes cluster defined as code
@@ -227,11 +222,9 @@ The configure script will have created a `./ansible` directory and the following
└─📁 apps # Apps deployed into the cluster grouped by namespace
```
-### ⚡ Preparing Debian Server with Ansible
+## ⚡ Node Preparation
-📍 Here we will be running an Ansible Playbook to prepare Debian server for running a Kubernetes cluster.
-
-📍 Nodes are not security hardened by default, you can do this with [dev-sec/ansible-collection-hardening](https://github.com/dev-sec/ansible-collection-hardening) or similar if supported. This is an advanced configuration and generally not recommended unless you want to [DevSecOps](https://www.ibm.com/topics/devsecops) your cluster and nodes.
+📍 _Here we will be running an Ansible playbook to prepare your nodes for running a Kubernetes cluster._
1. Ensure you are able to SSH into your nodes from your workstation using a private SSH key **without a passphrase**. For example using a SSH agent. This is how Ansible is able to connect to your remote nodes.
@@ -253,23 +246,17 @@ The configure script will have created a `./ansible` directory and the following
task ansible:ping
```
-5. Run the Ansible prepare playbook
+5. Run the Ansible prepare playbook (nodes wil reboot when done)
```sh
task ansible:prepare
```
-6. Reboot the nodes (if not done in step 5)
+---
- ```sh
- task ansible:force-reboot
- ```
+## ⛵ Kubernetes Installation
-### ⛵ Installing k3s with Ansible
-
-📍 Here we will be running a Ansible Playbook to install [k3s](https://k3s.io/) with [this](https://galaxy.ansible.com/xanmanning/k3s) wonderful k3s Ansible galaxy role. After completion, Ansible will drop a `kubeconfig` in `./kubeconfig` for use with interacting with your cluster with `kubectl`.
-
-☢️ If you run into problems, you can run `task ansible:nuke` to destroy the k3s cluster and start over.
+📍 _Here we will be running a Ansible Playbook to install [k3s](https://k3s.io/) with [this](https://galaxy.ansible.com/xanmanning/k3s) Ansible galaxy role. If you run into problems, you can run `task ansible:nuke` to destroy the k3s cluster and start over from this point._
1. Verify Ansible can view your config
@@ -291,6 +278,8 @@ The configure script will have created a `./ansible` directory and the following
4. Verify the nodes are online
+ 📍 _If this command **fails** you likely haven't configured `direnv` as mentioned previously in the guide._
+
```sh
kubectl get nodes -o wide
# NAME STATUS ROLES AGE VERSION
@@ -298,9 +287,11 @@ The configure script will have created a `./ansible` directory and the following
# k8s-1 Ready worker 1h v1.27.3+k3s1
```
-### 🔹 GitOps with Flux
+5. The `kubeconfig` for interacting with your cluster should have been created in the root of your repository.
-📍 Here we will be installing [flux](https://toolkit.fluxcd.io/) after some quick bootstrap steps.
+## 🔹 GitOps with Flux
+
+📍 _Here we will be installing [flux](https://fluxcd.io/flux/) after some quick bootstrap steps._
1. Verify Flux can be installed
@@ -342,51 +333,51 @@ The configure script will have created a `./ansible` directory and the following
# source-controller-7d6875bcb4-zqw9f 1/1 Running 0 1h
```
-### 🎤 Verification Steps
+## 🎤 Verification Steps
_Mic check, 1, 2_ - In a few moments applications should be lighting up like Christmas in July 🎄
-```sh
-# Output the common resources in your cluster
-task cluster:resources
-```
+1. Output all the common resources in your cluster.
-_Feel free to use the provided [cluster tasks](.taskfiles/ClusterTasks.yaml) for validation of cluster resources or continue to get familiar with the `kubectl` and `flux` CLI tools._
+ 📍 _Feel free to use the provided [cluster tasks](.taskfiles/ClusterTasks.yaml) for validation of cluster resources or continue to get familiar with the `kubectl` and `flux` CLI tools._
-🏆 **Congratulations** if all goes smooth you will have a Kubernetes cluster managed by Flux and your Git repository is driving the state of your cluster. If you run into problems, you can run `task ansible:nuke` to destroy your Kubernetes cluster and start over.
-🧠 Now it's time to pause and go get some coffee ☕ and admire you made it this far!
+ ```sh
+ task cluster:resources
+ ```
+
+2. ⚠️ It might take `cert-manager` awhile to generate certificates, this is normal so be patient.
+
+3. 🏆 **Congratulations** if all goes smooth you will have a Kubernetes cluster managed by Flux and your Git repository is driving the state of your cluster.
+
+4. 🧠 Now it's time to pause and go get some motel motor oil ☕ and admire you made it this far!
## 📣 Post installation
-### 🌱 Environment
-
-[direnv](https://direnv.net/) will make it so anytime you `cd` to your repo's directory it export the required environment variables (e.g. `KUBECONFIG`). To set this up make sure you [hook it into your shell](https://direnv.net/docs/hook.html) and after that is done, run `direnv allow` while in your repos directory.
-
-### 🌐 DNS
+#### 🌐 DNS
The `external-dns` application created in the `networking` namespace will handle creating public DNS records. By default, `echo-server` and the `flux-webhook` are the only public sub-domains exposed. In order to make additional applications public you must set an ingress annotation (`external-dns.alpha.kubernetes.io/target`) like done in the `HelmRelease` for `echo-server`.
-For split DNS to work it is required to have `${SECRET_DOMAIN}` point to the `${K8S_GATEWAY_ADDR}` load balancer IP address on your home DNS server. This will ensure DNS requests for `${SECRET_DOMAIN}` will only get routed to your `k8s_gateway` service thus providing **internal** DNS resolution to your cluster applications/ingresses from any device that uses your home DNS server.
+For split DNS to work it is required to have `${bootstrap_cloudflare_domain}` point to the `${bootstrap_k8s_gateway_addr}` load balancer IP address on your home DNS server. This will ensure DNS requests for `${bootstrap_cloudflare_domain}` will only get routed to your `k8s_gateway` service thus providing **internal** DNS resolution to your cluster applications/ingresses from any device that uses your home DNS server.
For and example with Pi-Hole apply the following file and restart dnsmasq:
```sh
# /etc/dnsmasq.d/99-k8s-gateway-forward.conf
-server=/${SECRET_DOMAIN}/${K8S_GATEWAY_ADDR}
+server=/${bootstrap_cloudflare_domain}/${bootstrap_k8s_gateway_addr}
```
-Now try to resolve an internal-only domain with `dig @${pi-hole-ip} hajimari.${SECRET_DOMAIN}` it should resolve to your `${INGRESS_NGINX_ADDR}` IP.
+Now try to resolve an internal-only domain with `dig @${pi-hole-ip} hajimari.${bootstrap_cloudflare_domain}` it should resolve to your `${bootstrap_ingress_nginx_addr}` IP.
-If having trouble you can ask for help in [this](https://github.com/onedr0p/flux-cluster-template/discussions/719) Github discussion.
+If you're having trouble with DNS be sure to check out these two Github discussions, [Internal DNS](https://github.com/onedr0p/flux-cluster-template/discussions/719) and [Pod DNS resolution broken](https://github.com/onedr0p/flux-cluster-template/discussions/635).
-If nothing is working, that is expected. This is DNS after all!
+Nothing working? That is expected, this is DNS after all!
-### 📜 Certificates
+#### 📜 Certificates
By default this template will deploy a wildcard certificate with the Let's Encrypt staging servers. This is to prevent you from getting rate-limited on configuration that might not be valid on bootstrap using the production server. If you had `bootstrap_acme_enable_production_certs` set to `false` in your `bootstrap/vars/config.yaml`, make sure to switch to the Let's Encrypt production servers as outlined in that file. Do not enable the production certificate until you are sure you will keep the cluster up for more than a few hours.
-### 🤖 Renovatebot
+#### 🤖 Renovatebot
[Renovatebot](https://www.mend.io/free-developer-tools/renovate/) will scan your repository and offer PRs when it finds dependencies out of date. Common dependencies it will discover and update are Flux, Ansible Galaxy Roles, Terraform Providers, Kubernetes Helm Charts, Kubernetes Container Images, and more!
@@ -394,7 +385,7 @@ The base Renovate configuration provided in your repository can be view at [.git
To enable Renovate on your repository, click the 'Configure' button over at their [Github app page](https://github.com/apps/renovate) and choose your repository. Over time Renovate will create PRs for out-of-date dependencies it finds. Any merged PRs that are in the kubernetes directory Flux will deploy.
-### 🪝 Github Webhook
+#### 🪝 Github Webhook
Flux is pull-based by design meaning it will periodically check your git repository for changes, using a webhook you can enable Flux to update your cluster on `git push`. In order to configure Github to send `push` events from your repository you must find your hook id that is already generated.
@@ -413,19 +404,7 @@ Flux is pull-based by design meaning it will periodically check your git reposit
3. Navigate to the settings of your repository on Github, under "Settings/Webhooks" press the "Add webhook" button. Fill in the webhook url and your `bootstrap_flux_github_webhook_token` secret.
-### 💾 Storage
-
-Rancher's `local-path-provisioner` is a great start for storage but soon you might find you need more features like replicated block storage, or to connect to a NFS/SMB/iSCSI server. Check out the projects below to read up more on some storage solutions that might work for you.
-
-- [rook-ceph](https://github.com/rook/rook)
-- [longhorn](https://github.com/longhorn/longhorn)
-- [openebs](https://github.com/openebs/openebs)
-- [nfs-subdir-external-provisioner](https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner)
-- [democratic-csi](https://github.com/democratic-csi/democratic-csi)
-- [csi-driver-nfs](https://github.com/kubernetes-csi/csi-driver-nfs)
-- [synology-csi](https://github.com/SynologyOpenSource/synology-csi)
-
-### 🔏 Authenticate Flux over SSH
+#### 🔏 Authenticate Flux over SSH
Authenticating Flux to your git repository has a couple benefits like using a private git repository and/or using the Flux [Image Automation Controllers](https://fluxcd.io/docs/components/image/).
@@ -434,7 +413,7 @@ By default this template only works on a public GitHub repository, it is advised
The benefits of a public repository include:
- Debugging or asking for help, you can provide a link to a resource you are having issues with.
-- Adding a topic to your repository of `k8s-at-home` to be included in the [k8s-at-home-search](https://whazor.github.io/k8s-at-home-search/). This search helps people discover different configurations of Helm charts across others Flux based repositories.
+- Adding a topic to your repository of `k8s-at-home` to be included in the [k8s-at-home-search](https://nanne.dev/k8s-at-home-search/). This search helps people discover different configurations of Helm charts across others Flux based repositories.
Expand to read guide on adding Flux SSH authentication
@@ -514,6 +493,18 @@ The benefits of a public repository include:
+#### 💾 Storage
+
+Rancher's `local-path-provisioner` is a great start for storage but soon you might find you need more features like replicated block storage, or to connect to a NFS/SMB/iSCSI server. Check out the projects below to read up more on some storage solutions that might work for you.
+
+- [rook-ceph](https://github.com/rook/rook)
+- [longhorn](https://github.com/longhorn/longhorn)
+- [openebs](https://github.com/openebs/openebs)
+- [nfs-subdir-external-provisioner](https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner)
+- [democratic-csi](https://github.com/democratic-csi/democratic-csi)
+- [csi-driver-nfs](https://github.com/kubernetes-csi/csi-driver-nfs)
+- [synology-csi](https://github.com/SynologyOpenSource/synology-csi)
+
## 🐛 Debugging
Below is a general guide on trying to debug an issue with an resource or application. For example, if a workload/resource is not showing up or a pod has started but in a `CrashLoopBackOff` or `Pending` state.
@@ -552,6 +543,12 @@ Below is a general guide on trying to debug an issue with an resource or applica
kubectl -n describe
```
+6. Check the namespace events
+
+ ```sh
+ kubectl get events -n --sort-by='.metadata.creationTimestamp'
+ ```
+
Resolving problems that you have could take some tweaking of your YAML manifests in order to get things working, other times it could be a external factor like permissions on NFS. If you are unable to figure out your problem see the help section below.
## 👉 Help