Skip to content

Commit 2bcd546

Browse files
authored
Merge pull request #366 from axivo/docs/website-update
fix: website update
2 parents 10c6cf5 + f494c12 commit 2bcd546

File tree

32 files changed

+160
-160
lines changed

32 files changed

+160
-160
lines changed

claude/content/wiki/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The result is collaboration that feels like working with an expert colleague who
3131
The platform consists of two primary architectural systems that work together to transform AI interactions into persistent professional collaboration.
3232

3333
> [!NOTE]
34-
> The platform was designed using **Site Reliability Engineering** methodologies and **behavioral psychology** principles, treating AI collaboration as infrastructure requiring systematic observability, monitoring, and reliability engineering for consistent professional partnership.
34+
> The platform was [designed](/wiki/guide/components/design) using **Site Reliability Engineering** methodologies and **behavioral psychology** principles, treating AI collaboration as infrastructure requiring systematic observability, monitoring, and reliability engineering for consistent professional partnership.
3535
3636
### Platform Components
3737

k3s-cluster/content/tutorials/handbook/ansible/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ ansible_password: !vault |
5757
36613833363662323261373266333565633430643639366435303061313039643637
5858
```
5959

60-
Insert the `ansible_password` encrypted output into [`all.yaml`](https://{{< param variables.repository.cluster >}}/blob/main/inventory/cluster/group_vars/all.yaml) group variables file, while respecting the *existing* indentation.
60+
Insert the `ansible_password` encrypted output into [`all.yaml`](https://{{< param variables.repository.cluster >}}/blob/main/inventory/cluster/group_vars/all.yaml) group variables file, while respecting the _existing_ indentation.
6161

6262
> [!TIP]
63-
> Once all variables have been initially encrypted with the same global password, they can be decrypted or updated with the [Vault](/k3s-cluster/wiki/guide/playbooks/vault) playbook.
63+
> Once all variables have been initially encrypted with the same global password, they can be decrypted or updated with the [Vault](/wiki/guide/playbooks/vault) playbook.
6464
6565
### Playbook Usage
6666

k3s-cluster/content/tutorials/handbook/argocd/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This repository uses [ArgoCD](https://argoproj.github.io/cd) to deploy applicati
1313
See the related role variables, defined into [`main.yaml`](https://{{< param variables.repository.cluster >}}/blob/main/roles/argo-cd/defaults/main.yaml) defaults file. Review the [`README.md`](https://{{< param variables.repository.cluster >}}/tree/main/roles/argo-cd) file, for additional details and the advanced configuration settings, listed below.
1414

1515
> [!IMPORTANT]
16-
> A [role upgrade](/k3s-cluster/wiki/guide/configuration/roles/argocd/#upgrade) is required, in order to apply any changes related to configuration.
16+
> A [role upgrade](/wiki/guide/configuration/roles/argocd/#upgrade) is required, in order to apply any changes related to configuration.
1717
1818
### Credentials
1919

@@ -23,9 +23,9 @@ While still implemented, the `admin` credentials are disabled by default and `us
2323
argocd_resources:
2424
server:
2525
users:
26-
- name: '{{ argocd_map.credentials.server.user.name }}'
27-
password: '{{ argocd_map.credentials.server.user.password }}'
28-
permissions: 'apiKey, login'
26+
- name: "{{ argocd_map.credentials.server.user.name }}"
27+
password: "{{ argocd_map.credentials.server.user.password }}"
28+
permissions: "apiKey, login"
2929
role: admin
3030
enabled: true
3131
```
@@ -40,15 +40,15 @@ The `name` and `password` keys listed above are defined into [`all.yaml`](https:
4040
Additional configuration parameters can be defined into [`config_params.j2`](https://{{< param variables.repository.cluster >}}/blob/main/roles/argo-cd/templates/config_params.j2) template.
4141

4242
> [!TIP]
43-
> Perform a [role validation](/k3s-cluster/wiki/guide/configuration/roles/argocd/#validation), to visualize all rendered templates and variables.
43+
> Perform a [role validation](/wiki/guide/configuration/roles/argocd/#validation), to visualize all rendered templates and variables.
4444

4545
### RBAC
4646

4747
Additional RBAC policies can be defined into [`config_rbac.j2`](https://{{< param variables.repository.cluster >}}/blob/main/roles/argo-cd/templates/config_rbac.j2) template. The role automatically injects the users specified into [`facts.yaml`](https://{{< param variables.repository.cluster >}}/blob/main/roles/argo-cd/tasks/facts.yaml) tasks file, under `argocd_resources.server.users` collection.
4848

4949
## Repository Setup
5050

51-
Login into [ArgoCD UI](/k3s-cluster/tutorials/handbook/externaldns/#argocd), navigate to `ArgoCD Settings` > `Repositories` and connect to official project repository:
51+
Login into [ArgoCD UI](/tutorials/handbook/externaldns/#argocd), navigate to `ArgoCD Settings` > `Repositories` and connect to official project repository:
5252

5353
| Key | Value |
5454
| :------ | :------------------------------------------------------------ |

k3s-cluster/content/tutorials/handbook/cilium/_index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Due to the intricate nature of its requirements, Cilium is deployed in three ste
1818

1919
## Dependencies
2020

21-
See below the required Cilium dependencies, used into chart configuration.
21+
See below the required Cilium dependencies, used into chart configuration.
2222

2323
### CertManager
2424

@@ -30,6 +30,7 @@ During chart post-install provisioning, Cilium Hubble is configured to take adva
3030

3131
> [!IMPORTANT]
3232
> Cilium details the following instructions, into their `cert-manager` [installation](https://docs.cilium.io/en/latest/observability/hubble/configuration/tls) steps:
33+
>
3334
> > Please make sure that your issuer is able to create certificates under the `cilium.io` domain name.
3435
>
3536
> CertManager cannot control a domain not owned by end-user, therefore the above listed `Certificate` and `ClusterIssuer` resources are created.
@@ -42,7 +43,7 @@ Refer to Cilium Hubble [documentation](https://docs.cilium.io/en/stable/gettings
4243

4344
#### Usage Example
4445

45-
This is an example of `Gateway` and `HTTPRoute` resources usage for [Cilium Hubble UI](/k3s-cluster/tutorials/handbook/externaldns/#cilium), as replacement for `Ingress` resource:
46+
This is an example of `Gateway` and `HTTPRoute` resources usage for [Cilium Hubble UI](/tutorials/handbook/externaldns/#cilium), as replacement for `Ingress` resource:
4647

4748
- `Gateway` resource template, see [`gateway.j2`](https://{{< param variables.repository.cluster >}}/blob/main/roles/cilium/templates/gateway.j2)
4849
- `HTTPRoute` insecure resource template, see [`http_route_insecure.j2`](https://{{< param variables.repository.cluster >}}/blob/main/roles/cilium/templates/http_route_insecure.j2)

k3s-cluster/content/tutorials/handbook/externaldns/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ This repository uses [ExternalDNS](https://github.com/kubernetes-sigs/external-d
1313
Generate the Cloudflare domain [API token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/), with following permissions:
1414

1515
{{< filetree/container >}}
16-
{{< filetree/folder name="ACCOUNT" >}}
17-
{{< filetree/folder name="domain.com - Zone:Read, DNS:Edit" state="closed" >}}
18-
{{< /filetree/folder >}}
19-
{{< /filetree/folder >}}
16+
{{< filetree/folder name="ACCOUNT" >}}
17+
{{< filetree/folder name="domain.com - Zone:Read, DNS:Edit" state="closed" >}}
18+
{{< /filetree/folder >}}
19+
{{< /filetree/folder >}}
2020
{{< /filetree/container >}}
2121

22-
Encrypt the `global_map.credentials.externaldns.cloudflare.api.token` value with [`ansible-vault`](/k3s-cluster/tutorials/handbook/ansible/#vault) and insert it into
22+
Encrypt the `global_map.credentials.externaldns.cloudflare.api.token` value with [`ansible-vault`](/tutorials/handbook/ansible/#vault) and insert it into
2323
[`all.yaml`](https://{{< param variables.repository.cluster >}}/blob/main/inventory/cluster/group_vars/all.yaml) group variables file.
2424

2525
## Front-Ends

k3s-cluster/content/tutorials/handbook/k3s-monitor/_index.md

Lines changed: 63 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -13,78 +13,78 @@ The **K3s Monitor** tool is a comprehensive Python utility designed to collect,
1313

1414
## Tool Features
1515

16-
* **Cluster Resource Monitoring**: Collects various resource metrics from nodes and pods
17-
* **Component-Specific Monitoring**: Tracks resource usage for all K3s Cluster [components](/k3s-cluster/wiki/guide/configuration/roles/#charts)
18-
* **Log Collection**: Gathers logs from system services and Kubernetes components
19-
* **Automated Analysis**: Identifies high resource consumption and potential issues
20-
* **Comparative Reporting**: Compares current metrics with previous monitoring runs
21-
* **Comprehensive Summary**: Generates detailed reports with recommendations, ready for AI-assisted analysis with tools like [Claude](https://claude.ai)
16+
- **Cluster Resource Monitoring**: Collects various resource metrics from nodes and pods
17+
- **Component-Specific Monitoring**: Tracks resource usage for all K3s Cluster [components](/wiki/guide/configuration/roles/#charts)
18+
- **Log Collection**: Gathers logs from system services and Kubernetes components
19+
- **Automated Analysis**: Identifies high resource consumption and potential issues
20+
- **Comparative Reporting**: Compares current metrics with previous monitoring runs
21+
- **Comprehensive Summary**: Generates detailed reports with recommendations, ready for AI-assisted analysis with tools like [Claude](https://claude.ai)
2222

2323
## Prerequisites
2424

25-
The following dependencies are required to run the **K3s Monitor** tool, automatically deployed with [Provisioning](/k3s-cluster/wiki/guide/playbooks/provisioning) playbook:
25+
The following dependencies are required to run the **K3s Monitor** tool, automatically deployed with [Provisioning](/wiki/guide/playbooks/provisioning) playbook:
2626

27-
* Python 3.8+
28-
* `python3-kubernetes` library
29-
* `python3-yaml` library
30-
* `kubectl` configured to access the K3s cluster
31-
* `journalctl` for log collection
32-
* `jq` for JSON processing
27+
- Python 3.8+
28+
- `python3-kubernetes` library
29+
- `python3-yaml` library
30+
- `kubectl` configured to access the K3s cluster
31+
- `journalctl` for log collection
32+
- `jq` for JSON processing
3333

3434
## Generated Reports
3535

3636
The following reports are generated:
3737

38-
* **cilium-metrics.log**: Detailed Cilium networking status, endpoints and services information
39-
* **cluster-info.log**: Basic information about the cluster
40-
* **comparison.log**: Comparison with previous monitoring runs
41-
* **component-metrics.csv**: Time-series data for component resource usage
42-
* **summary.log**: Overall resource usage summary and recommendations
43-
* **etcd-metrics.log**: Status of HA clusters, `etcd` cluster health and metrics
44-
* **k3s-monitor.log**: Operational log of the monitoring tool itself, including all actions taken during execution
45-
* **log-summary.txt**: Summary of important log events (errors, warnings)
46-
* **pod-metrics.csv**: Detailed pod-level resource metrics
47-
* **sysctl.txt**: System kernel parameter settings
48-
* **summary.log**: Overall resource usage summary and recommendations
38+
- **cilium-metrics.log**: Detailed Cilium networking status, endpoints and services information
39+
- **cluster-info.log**: Basic information about the cluster
40+
- **comparison.log**: Comparison with previous monitoring runs
41+
- **component-metrics.csv**: Time-series data for component resource usage
42+
- **summary.log**: Overall resource usage summary and recommendations
43+
- **etcd-metrics.log**: Status of HA clusters, `etcd` cluster health and metrics
44+
- **k3s-monitor.log**: Operational log of the monitoring tool itself, including all actions taken during execution
45+
- **log-summary.txt**: Summary of important log events (errors, warnings)
46+
- **pod-metrics.csv**: Detailed pod-level resource metrics
47+
- **sysctl.txt**: System kernel parameter settings
48+
- **summary.log**: Overall resource usage summary and recommendations
4949

5050
See below the directories and files structure, containing the generated reports.
5151

5252
> [!NOTE]
5353
> Submit the generated tarball to [Claude](https://claude.ai), for AI-assisted analysis. Upload the tarball to a chat with Claude and ask for an analysis of your K3s cluster metrics and performance.
5454
5555
{{< filetree/container >}}
56-
{{< filetree/folder name="/var/log/k3s" >}}
57-
{{< filetree/folder name="YYYYMMDD-HHMMSS (click to expand)" state="closed" >}}
58-
{{< filetree/file name="cilium-metrics.log" >}}
59-
{{< filetree/file name="cluster-info.log" >}}
60-
{{< filetree/file name="comparison.log" >}}
61-
{{< filetree/file name="component-metrics.csv" >}}
62-
{{< filetree/file name="etcd-metrics.log" >}}
63-
{{< filetree/file name="k3s-monitor.log" >}}
64-
{{< filetree/file name="log-summary.txt" >}}
65-
{{< filetree/file name="pod-metrics.csv" >}}
66-
{{< filetree/folder name="service" >}}
67-
{{< filetree/folder name="components" >}}
68-
{{< filetree/file name="argo-cd_YYYYMMDD-HHMMSS.log" >}}
69-
{{< filetree/file name="cert-manager_YYYYMMDD-HHMMSS.log" >}}
70-
{{< filetree/file name="cilium_YYYYMMDD-HHMMSS.log" >}}
71-
{{< filetree/file name="coredns_YYYYMMDD-HHMMSS.log" >}}
72-
{{< filetree/file name="external-dns_YYYYMMDD-HHMMSS.log" >}}
73-
{{< filetree/file name="kured_YYYYMMDD-HHMMSS.log" >}}
74-
{{< filetree/file name="longhorn_YYYYMMDD-HHMMSS.log" >}}
75-
{{< filetree/file name="metrics-server_YYYYMMDD-HHMMSS.log" >}}
76-
{{< filetree/file name="victorialogs_YYYYMMDD-HHMMSS.log" >}}
77-
{{< filetree/file name="victoriametrics_YYYYMMDD-HHMMSS.log" >}}
78-
{{< /filetree/folder >}}
79-
{{< filetree/file name="containerd.log" >}}
80-
{{< filetree/file name="k3s.log" >}}
81-
{{< filetree/file name="kubelet.log" >}}
82-
{{< /filetree/folder >}}
83-
{{< filetree/file name="summary.log" >}}
84-
{{< filetree/file name="sysctl.txt" >}}
85-
{{< /filetree/folder >}}
86-
{{< filetree/file name="k3s-monitor-YYYYMMDD-HHMMSS.tar.gz" >}}
87-
{{< /filetree/folder >}}
56+
{{< filetree/folder name="/var/log/k3s" >}}
57+
{{< filetree/folder name="YYYYMMDD-HHMMSS (click to expand)" state="closed" >}}
58+
{{< filetree/file name="cilium-metrics.log" >}}
59+
{{< filetree/file name="cluster-info.log" >}}
60+
{{< filetree/file name="comparison.log" >}}
61+
{{< filetree/file name="component-metrics.csv" >}}
62+
{{< filetree/file name="etcd-metrics.log" >}}
63+
{{< filetree/file name="k3s-monitor.log" >}}
64+
{{< filetree/file name="log-summary.txt" >}}
65+
{{< filetree/file name="pod-metrics.csv" >}}
66+
{{< filetree/folder name="service" >}}
67+
{{< filetree/folder name="components" >}}
68+
{{< filetree/file name="argo-cd_YYYYMMDD-HHMMSS.log" >}}
69+
{{< filetree/file name="cert-manager_YYYYMMDD-HHMMSS.log" >}}
70+
{{< filetree/file name="cilium_YYYYMMDD-HHMMSS.log" >}}
71+
{{< filetree/file name="coredns_YYYYMMDD-HHMMSS.log" >}}
72+
{{< filetree/file name="external-dns_YYYYMMDD-HHMMSS.log" >}}
73+
{{< filetree/file name="kured_YYYYMMDD-HHMMSS.log" >}}
74+
{{< filetree/file name="longhorn_YYYYMMDD-HHMMSS.log" >}}
75+
{{< filetree/file name="metrics-server_YYYYMMDD-HHMMSS.log" >}}
76+
{{< filetree/file name="victorialogs_YYYYMMDD-HHMMSS.log" >}}
77+
{{< filetree/file name="victoriametrics_YYYYMMDD-HHMMSS.log" >}}
78+
{{< /filetree/folder >}}
79+
{{< filetree/file name="containerd.log" >}}
80+
{{< filetree/file name="k3s.log" >}}
81+
{{< filetree/file name="kubelet.log" >}}
82+
{{< /filetree/folder >}}
83+
{{< filetree/file name="summary.log" >}}
84+
{{< filetree/file name="sysctl.txt" >}}
85+
{{< /filetree/folder >}}
86+
{{< filetree/file name="k3s-monitor-YYYYMMDD-HHMMSS.tar.gz" >}}
87+
{{< /filetree/folder >}}
8888
{{< /filetree/container >}}
8989

9090
## Tool Usage
@@ -111,7 +111,7 @@ options:
111111
-n NAMESPACE, --namespace NAMESPACE
112112
Default namespace (default: kube-system)
113113
-v, --verbose Enable verbose logging (default: False)
114-
```
114+
```
115115

116116
See below various **K3s Monitor** tool usage examples.
117117

@@ -145,9 +145,9 @@ sudo k3s-monitor --duration 600 --interval 60
145145

146146
## Best Practices
147147

148-
* **Regular Monitoring**: Run the tool periodically (e.g., weekly) to establish baseline metrics
149-
* **After Changes**: Run after cluster upgrades or significant workload changes
150-
* **Retention**: Keep monitoring results for trend analysis
151-
* **Size Appropriately**: Adjust duration and interval based on cluster size:
152-
* Small clusters: 1-hour duration, 5-minute intervals
153-
* Large clusters: 6-hour duration, 15-minute intervals
148+
- **Regular Monitoring**: Run the tool periodically (e.g., weekly) to establish baseline metrics
149+
- **After Changes**: Run after cluster upgrades or significant workload changes
150+
- **Retention**: Keep monitoring results for trend analysis
151+
- **Size Appropriately**: Adjust duration and interval based on cluster size:
152+
- Small clusters: 1-hour duration, 5-minute intervals
153+
- Large clusters: 6-hour duration, 15-minute intervals

k3s-cluster/content/tutorials/handbook/k3s/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ The end-user can use `kubectl` to operate the cluster via local terminal, or [Le
2525
[![K3s: Lens](k3s-lens.webp)](k3s-lens.webp)
2626

2727
> [!TIP]
28-
> Lens automatically detects and exposes the metrics produced by [VictoriaMetrics](/k3s-cluster/wiki/guide/configuration/roles/victoriametrics) role.
28+
> Lens automatically detects and exposes the metrics produced by [VictoriaMetrics](/wiki/guide/configuration/roles/victoriametrics) role.
2929
3030
## Upgrade
3131

32-
Upon a new K3s version release, end-user can perform a [role upgrade](/k3s-cluster/wiki/guide/configuration/roles/k3s/#upgrade), which will schedule a [Kured](/k3s-cluster/wiki/guide/configuration/roles/kured) reboot.
32+
Upon a new K3s version release, end-user can perform a [role upgrade](/wiki/guide/configuration/roles/k3s/#upgrade), which will schedule a [Kured](/wiki/guide/configuration/roles/kured) reboot.
3333

3434
### Manual Upgrade
3535

36-
Once the [role upgrade](/k3s-cluster/wiki/guide/configuration/roles/k3s/#upgrade) performed, end-user can choose to manually upgrade each cluster node. A [node drain](/k3s-cluster/tutorials/handbook/longhorn/#node-drain) must be executed one node at the time, followed by a node reboot. Once the node is up and running, it can be uncordoned with Lens or `kubectl`, via local terminal:
36+
Once the [role upgrade](/wiki/guide/configuration/roles/k3s/#upgrade) performed, end-user can choose to manually upgrade each cluster node. A [node drain](/tutorials/handbook/longhorn/#node-drain) must be executed one node at the time, followed by a node reboot. Once the node is up and running, it can be uncordoned with Lens or `kubectl`, via local terminal:
3737

3838
```shell
3939
kubectl uncordon <node>

k3s-cluster/content/tutorials/handbook/kured/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ https://hooks.slack.com/services/<token>/<token>/<token>
3030

3131
### Notify URL
3232

33-
Encrypt the `global_map.credentials.kured.slack.notify.url` value with [`ansible-vault`](/k3s-cluster/tutorials/handbook/ansible/#vault) and insert it into
33+
Encrypt the `global_map.credentials.kured.slack.notify.url` value with [`ansible-vault`](/tutorials/handbook/ansible/#vault) and insert it into
3434
[`all.yaml`](https://{{< param variables.repository.cluster >}}/blob/main/inventory/cluster/group_vars/all.yaml) group variables file. Notify URL decrypted format:
3535

3636
```yaml

0 commit comments

Comments
 (0)