Skip to content

Commit 66a58ca

Browse files
committed
feat(k8s): add macro & cards
1 parent 143a777 commit 66a58ca

File tree

4 files changed

+63
-22
lines changed

4 files changed

+63
-22
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
macro: kubernetes-cockpit-intro
3+
---
4+
5+
Scaleway’s [Cockpit](/cockpit/quickstart/) provides a centralized solution for monitoring and logging in of your Kubernetes applications, helping you gain insights into cluster activity, performance, and security.
6+
7+
With Cockpit, you can:
8+
9+
- **Monitor your Kubernetes cluster**: Gain real-time visibility into the control plane, nodes, managed resources, and system applications.
10+
- **Analyze logs**: View logs from all your Kubernetes containers in one place to enhance observability and simplify troubleshooting.
11+
- **Track activity**: Audit logs provide detailed records of user actions, application API calls, and control plane operations, helping with compliance and security.
12+
13+
Cockpit integrates with **Grafana** for rich data visualization and provides **automated monitoring** without the need to configuure additional infrastructure.
14+
15+
<Message type="note">
16+
**Cost considerations**: Sending logs to Cockpit incurs costs based on ingestion volume. See the [Cockpit FAQ](/faq/cockpit/#how-am-i-billed-for-using-cockpit-with-custom-data) for pricing details and best practices.
17+
18+
**Security & compliance**: Monitoring Kubernetes API activity is critical for security and may be required for certain certifications. Audit logs are enabled by default for clusters with dedicated control planes. Learn more in the [audit logs documentation](/kubernetes/how-to/access-audit-logs/).
19+
</Message>

pages/kubernetes/how-to/access-audit-logs.mdx

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ categories:
1313
- kubernetes
1414
---
1515

16-
Kubernetes Kapsule and Kosmos control plane metrics and logs are integrated into Cockpit, providing you with a centralized hub for monitoring the control plane, nodes, managed resources, and cluster system applications.
17-
18-
While this initial integration empowers you with the autonomy to troubleshoot issues promptly, we have taken the next step by extending the functionality, now Kubernetes audit records are also exported into Cockpit.
16+
<Macro id="kubernetes-cockpit-intro" />
1917

2018
Kubernetes audit logs provide detailed insights into user-generated activities, actions initiated by applications using the Kubernetes API, and operations performed by the control plane.
2119

@@ -102,3 +100,16 @@ The Kubernetes audit policy defines the selection of log entries exported by the
102100
You can examine the [Kubernetes audit policy](https://github.com/scaleway/kubernetes-gists/blob/main/audit/policy.yaml) file, which contains a list of rules, giving you complete visibility into our API server configuration and the chosen request treatments or exclusions.
103101

104102

103+
## Related documentation
104+
<Grid>
105+
<DefaultCard
106+
title="How to monitor your Kubernetes Kapsule cluster with Cockpit"
107+
description="You can view the cluster metrics in a hosted Grafana without any configuration on your part."
108+
url="/kubernetes/how-to/monitor-cluster/"
109+
label="Learn more" />
110+
<DefaultCard
111+
title="How to monitor your Kubernetes Kapsule cluster with Cockpit using Promtail"
112+
description="Learn how to install and configure Promtail to monitor your Kubernetes applications in Cockpit."
113+
url="/kubernetes/how-to/monitor-data-plane-with-cockpit/"
114+
label="Learn more" />
115+
</Grid>

pages/kubernetes/how-to/monitor-cluster.mdx

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,13 @@ categories:
1313
- kubernetes
1414
---
1515

16-
Scaleway's observability Cockpit provides automated monitoring of your Kubernetes cluster. As Kubernetes environments grow in complexity, monitoring becomes crucial for optimal performance. Visualization of the clusters' metrics is available in a hosted Grafana.
1716

18-
Grafana's rich visualizations and ease of use make it an ideal choice. Cockpit offers a hassle-free solution, providing real-time insights without extra infrastructure.
19-
20-
[Cockpit](/cockpit/quickstart/) empowers you to monitor the clusters' control plane, nodes, managed resources and the cluster system applications.
21-
22-
* Detect incidents and diagnose failures in the earliest stages
23-
* Get new insights on control plane and worker nodes usage such as CPU and memory to optimize your resource allocation
24-
* Achieve a better understanding of your infrastructure by analyzing data on your API server, system applications and up/down scaling behavior
17+
<Macro id="kubernetes-cockpit-intro" />
2518

2619
<Message type="important">
2720
**Control plane monitoring**: Scaleway Kapsule natively provides monitoring for the control plane, free of charge. Additionally, monitoring of the data plane is possible. To monitor the data plane, refer to [How to monitor your Kubernetes Kapsule data plane with Cockpit](/kubernetes/how-to/monitor-data-plane-with-cockpit/). For detailed observability, refer to the [documentation on how to send logs from your Kubernetes cluster to your Cockpit](/cockpit/how-to/send-logs-from-k8s-to-cockpit/).
2821

29-
**Control plane vs. data plane**: The control plane is responsible for managing the Kubernetes cluster’s state and orchestrating workloads, while the data plane consists of the nodes that execute the workloads.
22+
**Control plane vs. data plane**: The control plane is responsible for managing the Kubernetes cluster’s state and orchestrating workloads, while the data plane (your Kubernetes application) consists of the nodes that execute the workloads.
3023

3124
**Security and compliance**: For enhanced security and compliance, Kapsule provides audit logs natively within Cockpit. Learn more in the [audit logs documentation](/kubernetes/how-to/access-audit-logs/).
3225
</Message>
@@ -78,3 +71,16 @@ For scenarios where you require consistent and predictable performance, along wi
7871
</Message>
7972

8073

74+
## Related documentation
75+
<Grid>
76+
<DefaultCard
77+
title="How to access the Kubernetes audit logs"
78+
description="Learn how you can visualize the audit logs of your Kubernetes Cluster in Grafana using Scaleway's Cockpit."
79+
url="/kubernetes/how-to/access-audit-logs/"
80+
label="Learn more" />
81+
<DefaultCard
82+
title="How to monitor your Kubernetes Kapsule cluster with Cockpit using Promtail"
83+
description="Learn how to install and configure Promtail to monitor your Kubernetes applications in Cockpit."
84+
url="/kubernetes/how-to/monitor-data-plane-with-cockpit/"
85+
label="Learn more" />
86+
</Grid>

pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,7 @@ dates:
1313
posted: 2025-01-17
1414
---
1515

16-
You can now send **data plane** logs from your [Kapsule](https://www.scaleway.com/en/kubernetes-kapsule/) or [Kosmos](https://www.scaleway.com/en/kubernetes-kosmos/) clusters to [Cockpit](https://www.scaleway.com/en/cockpit/), providing centralized, real-time access to application and system logs. Reduce complexity and manual work thanks to this integration, powered by a **Promtail** deployment via [Easy Deploy](/kubernetes/how-to/enable-easy-deploy/).
17-
18-
This feature allows you to:
19-
20-
- **Enhance observability**: View logs from all your Kubernetes containers in one place.
21-
- **Simplify troubleshooting**: Quickly drill down into specific pods or containers without needing to configure a separate logging stack.
22-
23-
<Message type="important">
24-
This feature does incur costs based on the volume of logs ingested. Refer to [Cockpit FAQ](/faq/cockpit/#how-am-i-billed-for-using-cockpit-with-custom-data) for more details and best practices to avoid unexpected bills.
25-
</Message>
16+
<Macro id="kubernetes-cockpit-intro" />
2617

2718
<Macro id="requirements" />
2819

@@ -178,3 +169,17 @@ Key points include:
178169
- [Send metrics from your Kubernetes cluster to your Cockpit (How-To)](/cockpit/how-to/send-metrics-from-k8s-to-cockpit/)
179170
- [Promtail Documentation](https://grafana.com/docs/loki/latest/clients/promtail/)
180171
- [Scaleway Kubernetes Kapsule and Kosmos Documentation](/kubernetes/quickstart/)
172+
173+
## Related documentation
174+
<Grid>
175+
<DefaultCard
176+
title="How to access the Kubernetes audit logs"
177+
description="Learn how you can visualize the audit logs of your Kubernetes Cluster in Grafana using Scaleway's Cockpit."
178+
url="/kubernetes/how-to/access-audit-logs/"
179+
label="Learn more" />
180+
<DefaultCard
181+
title="How to monitor your Kubernetes Kapsule cluster with Cockpit"
182+
description="You can view the cluster metrics in a hosted Grafana without any configuration on your part."
183+
url="/kubernetes/how-to/monitor-cluster/"
184+
label="Learn more" />
185+
</Grid>

0 commit comments

Comments
 (0)