Skip to content

Commit d3704b3

Browse files
authored
fixed file and title names (#35)
1 parent d3a7453 commit d3704b3

File tree

7 files changed

+20
-20
lines changed

7 files changed

+20
-20
lines changed

docs/hardware_ready/ADRs/Cilium_as_network_plugin.md renamed to docs/hardware_ready/ADRs/network_plugin_cilium.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Use Cilium as Network Plugin
2+
title: "Network Plugin: Cilium"
33
---
44

55
| status: | date: | decision-makers: |
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
---
2-
title: "Use Talos OS as the Preferred Operating System for Kubernetes Operations"
2+
title: "OS: Talos Linux"
33
date: "2025-02-25"
44
---
55

66

77
| status: | date: | decision-makers: |
88
| --- | --- | --- |
9-
| proposed | 2025-02-25 | Sofus Albertsen |
9+
| approved | 2025-02-25 | Sofus Albertsen |
1010

1111
## Context and Problem Statement
1212

1313
Choosing the right operating system for your Kubernetes cluster is crucial for stability, security, and operational efficiency. The OS should be optimized for container workloads, minimize overhead, and integrate well with Infrastructure as Code (IaC) practices.
1414

1515
## Considered Options
1616

17-
* Talos OS
17+
* Talos Linux
1818
* Red Hat OpenShift
1919
* SUSE Rancher (RancherOS/RKE)
2020

2121
## Decision Outcome
2222

23-
Chosen option: **Talos OS**, because its minimal footprint, API-driven configuration, and singular focus on Kubernetes make it ideal for automated infrastructure management and reduce operational overhead.
23+
Chosen option: **Talos Linux**, because its minimal footprint, API-driven configuration, and singular focus on Kubernetes make it ideal for automated infrastructure management and reduce operational overhead.
2424

25-
Talos OS's immutable architecture and security-focused design further enhance its suitability for Kubernetes deployments, giving you a minimal attack surface from the OS point of view. As an example, the OS does not have any shell, so no bash scripts can be executed.
25+
Talos's immutable architecture and security-focused design further enhance its suitability for Kubernetes deployments, giving you a minimal attack surface from the OS point of view. As an example, the OS does not have any shell, so no bash scripts can be executed.
2626

2727
OpenShift and Rancher were considered, but their comprehensive feature sets, while beneficial in some scenarios, introduce increased complexity and overhead.
2828

2929
While their dashboards can simplify initial setup, they can also encourage "click-ops" and deviate from IaC best practices. These platforms might be suitable if existing Red Hat or SUSE expertise is a primary driver, but becuase they are fully fledged OS's underneath, they introduce more operational overhead than Talos.
3030

3131
### Consequences
3232

33-
* **Good:** Talos OS's minimal package selection makes it a smaller attack surface.
34-
* **Good:** The API-driven configuration of Talos OS allows for seamless integration with IaC tools like Terraform, enabling fully automated cluster provisioning and management.
35-
* **Good:** The immutable infrastructure of Talos OS simplifies updates and adds recilliency because of it's dual boot bank setup.
33+
* **Good:** Talos's minimal package selection makes it a smaller attack surface.
34+
* **Good:** The API-driven configuration of Talos allows for seamless integration with IaC tools like Terraform, enabling fully automated cluster provisioning and management.
35+
* **Good:** The immutable infrastructure of Talos simplifies updates and adds recilliency because of it's dual boot bank setup.
3636
* **Good:** The "two package" approach simplifies maintenance (day 2 operations) and reduces the likelihood of OS-related issues, as all known package combinations can be tested from the vendor.
3737

38-
* **Bad:** The learning curve for Talos OS might be steeper initially for teams unfamiliar with its API-driven approach.
38+
* **Bad:** The learning curve for Talos might be steeper initially for teams unfamiliar with its API-driven approach.
3939
* **Bad:** The lack of a graphical user interface might be a drawback for some users accustomed to traditional OS management.
4040
* **Bad:** Talos is a relatively newer project compared to OpenShift or Rancher, therefore community support and available resources might be smaller.

docs/hardware_ready/ADRs/Longhorn_as_storage_solution.md renamed to docs/hardware_ready/ADRs/storage_solution_longhorn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Longhorn_as_storage_solution"
2+
title: "Storage Solution: Longhorn"
33
date: "2025-03-18"
44
---
55

docs/hardware_ready/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ title: Getting your hardware ready
55

66
| Problem domain | Description | Reason for importance | Tool recommendation |
77
|:---:|:---:|:---:|:---:|
8-
| Kubernetes Node Operating System | The Operating System running on each of the hosts that will be part of your Kubernetes cluster | Choosing the right OS will be the foundation for building a production-grade Kubernetes cluster | [Talos OS](hardware_ready/ADRs/talos_as_os.md) |
9-
| Storage solution | The underlying storage capabilities which Kubernetes will leverage to provide persistence for stateful workloads | Choosing the right storage solution for your clusters needs is important as there is a lot of balance tradeoffs associated with it, e.g redundancy vs. complexity | [Longhorn](Longhorn_as_storage_solution.md) |
8+
| OS | The Operating System running on each of the hosts that will be part of your Kubernetes cluster | Choosing the right OS will be the foundation for building a production-grade Kubernetes cluster | [Talos Linux](hardware_ready/ADRs/os_talos_linux.md) |
9+
| Storage solution | The underlying storage capabilities which Kubernetes will leverage to provide persistence for stateful workloads | Choosing the right storage solution for your clusters needs is important as there is a lot of balance tradeoffs associated with it, e.g redundancy vs. complexity | [Longhorn](storage_solution_longhorn.md) |
1010
| Container Runtime (CRI) | The software that is responsible for running containers | You need a working container runtime on each node in your cluster, so that the kubelet can launch pods and their containers | |
11-
| Network plugin (CNI) | Plugin used for cluster networking | A CNI plugin is required to implement the Kubernetes network model | [Cilium](Cilium_as_network_plugin.md) |
11+
| Network plugin (CNI) | Plugin used for cluster networking | A CNI plugin is required to implement the Kubernetes network model | [Cilium](network_plugin_cilium.md) |
1212
| Virtualisation | An optional layer between your hardware and your Kubernetes tech stack | In some scenarioes it might be benefitial to abstract the underlying hardeware away, and have everything running in virtual machines | |

docs/working_with_k8s/ADRs/harbor_as_image_registry.md renamed to docs/working_with_k8s/ADRs/image_registry_habour.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: "Harbor as Image Registry"
2+
title: "Image Registry: Habour"
33
date: "2025-03-31"
44
---
55

66
| status: | date: | decision-makers: |
77
| --- | --- | --- |
8-
| proposed | 2025-03-31 | Kasper Møller |
8+
| approved | 2025-03-31 | Kasper Møller |
99

1010
## Context and Problem Statement
1111

docs/working_with_k8s/ADRs/hashicorp_vault_as_secret_management.md renamed to docs/working_with_k8s/ADRs/secret_management_hashicorp_vault.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: "Hashicorp Vault as Secret Management"
2+
title: "Secret Management: Hashicorp Vault"
33
date: "2025-04-14"
44
---
55

66

77
| status: | date: | decision-makers: |
88
| --- | --- | --- |
9-
| proposed | 2025-04-14 | Kasper Møller |
9+
| approved | 2025-04-14 | Kasper Møller |
1010

1111
## Context and Problem Statement
1212

docs/working_with_k8s/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ title: Working With Kubernetes
66

77
| Problem domain | Description | Reason for importance | Tool recommendation |
88
|:---:|:---:|:---:|:---:|
9-
| Image Registry | A common place to store and fetch images | High availability, secure access control | [Harbor](ADRs/harbor_as_image_registry.md) |
10-
| Secret Management | Securely store and manage sensitive information like passwords and API keys | Prevent unauthorized access and data leaks | [HashiCorp Vault](ADRs/hashicorp_vault_as_secret_management.md) |
9+
| Image Registry | A common place to store and fetch images | High availability, secure access control | [Harbor](ADRs/image_registry_habour.md) |
10+
| Secret Management | Securely store and manage sensitive information like passwords and API keys | Prevent unauthorized access and data leaks | [HashiCorp Vault](ADRs/secret_management_hashicorp_vault.md) |
1111
| Ingress Controller / Gateway API | Manage external access to services in the cluster | Enable routing, load balancing, and secure communication | |
1212
| GitOps / Deployment Pipelines | Automate application deployments using Git as the source of truth | Ensure consistency, traceability, and faster deployments | |
1313
| Monitoring Infrastructure | Observe and analyze the health and performance of the cluster and applications | Proactive issue detection and resolution | |

0 commit comments

Comments
 (0)