From 66a58ca4122f59ea5f450d47485da4a060300e11 Mon Sep 17 00:00:00 2001 From: Benedikt Rollik Date: Fri, 14 Mar 2025 15:13:14 +0100 Subject: [PATCH 1/2] feat(k8s): add macro & cards --- .../kubernetes/kubernetes-cockpit-intro.mdx | 19 ++++++++++++++ pages/kubernetes/how-to/access-audit-logs.mdx | 17 ++++++++++--- pages/kubernetes/how-to/monitor-cluster.mdx | 24 +++++++++++------- .../monitor-data-plane-with-cockpit.mdx | 25 +++++++++++-------- 4 files changed, 63 insertions(+), 22 deletions(-) create mode 100644 macros/kubernetes/kubernetes-cockpit-intro.mdx diff --git a/macros/kubernetes/kubernetes-cockpit-intro.mdx b/macros/kubernetes/kubernetes-cockpit-intro.mdx new file mode 100644 index 0000000000..fe7bff21a7 --- /dev/null +++ b/macros/kubernetes/kubernetes-cockpit-intro.mdx @@ -0,0 +1,19 @@ +--- +macro: kubernetes-cockpit-intro +--- + +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. + +With Cockpit, you can: + +- **Monitor your Kubernetes cluster**: Gain real-time visibility into the control plane, nodes, managed resources, and system applications. +- **Analyze logs**: View logs from all your Kubernetes containers in one place to enhance observability and simplify troubleshooting. +- **Track activity**: Audit logs provide detailed records of user actions, application API calls, and control plane operations, helping with compliance and security. + +Cockpit integrates with **Grafana** for rich data visualization and provides **automated monitoring** without the need to configuure additional infrastructure. + + + **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. + + **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/). + diff --git a/pages/kubernetes/how-to/access-audit-logs.mdx b/pages/kubernetes/how-to/access-audit-logs.mdx index 0d639b2b1c..863ba3d3e3 100644 --- a/pages/kubernetes/how-to/access-audit-logs.mdx +++ b/pages/kubernetes/how-to/access-audit-logs.mdx @@ -13,9 +13,7 @@ categories: - kubernetes --- -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. - -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. + 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. @@ -102,3 +100,16 @@ The Kubernetes audit policy defines the selection of log entries exported by the 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. +## Related documentation + + + + \ No newline at end of file diff --git a/pages/kubernetes/how-to/monitor-cluster.mdx b/pages/kubernetes/how-to/monitor-cluster.mdx index 8d4b6e3897..ccd814ef88 100644 --- a/pages/kubernetes/how-to/monitor-cluster.mdx +++ b/pages/kubernetes/how-to/monitor-cluster.mdx @@ -13,20 +13,13 @@ categories: - kubernetes --- -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. -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. - -[Cockpit](/cockpit/quickstart/) empowers you to monitor the clusters' control plane, nodes, managed resources and the cluster system applications. - -* Detect incidents and diagnose failures in the earliest stages -* Get new insights on control plane and worker nodes usage such as CPU and memory to optimize your resource allocation -* Achieve a better understanding of your infrastructure by analyzing data on your API server, system applications and up/down scaling behavior + **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/). - **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. + **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. **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/). @@ -78,3 +71,16 @@ For scenarios where you require consistent and predictable performance, along wi +## Related documentation + + + + \ No newline at end of file diff --git a/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx b/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx index dc62639820..6e49cb7a3e 100644 --- a/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx +++ b/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx @@ -13,16 +13,7 @@ dates: posted: 2025-01-17 --- -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/). - -This feature allows you to: - -- **Enhance observability**: View logs from all your Kubernetes containers in one place. -- **Simplify troubleshooting**: Quickly drill down into specific pods or containers without needing to configure a separate logging stack. - - - 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. - + @@ -178,3 +169,17 @@ Key points include: - [Send metrics from your Kubernetes cluster to your Cockpit (How-To)](/cockpit/how-to/send-metrics-from-k8s-to-cockpit/) - [Promtail Documentation](https://grafana.com/docs/loki/latest/clients/promtail/) - [Scaleway Kubernetes Kapsule and Kosmos Documentation](/kubernetes/quickstart/) + +## Related documentation + + + + \ No newline at end of file From 1037acdbb0a3b760d0f589d0bd50a37108373514 Mon Sep 17 00:00:00 2001 From: Benedikt Rollik Date: Fri, 14 Mar 2025 17:33:14 +0100 Subject: [PATCH 2/2] feat(K8s): add cards --- pages/kubernetes/how-to/access-audit-logs.mdx | 4 +++- pages/kubernetes/how-to/monitor-cluster.mdx | 12 ++++++++++-- .../how-to/monitor-data-plane-with-cockpit.mdx | 11 ++++++++++- 3 files changed, 23 insertions(+), 4 deletions(-) diff --git a/pages/kubernetes/how-to/access-audit-logs.mdx b/pages/kubernetes/how-to/access-audit-logs.mdx index 863ba3d3e3..afcedf539e 100644 --- a/pages/kubernetes/how-to/access-audit-logs.mdx +++ b/pages/kubernetes/how-to/access-audit-logs.mdx @@ -13,7 +13,9 @@ categories: - kubernetes --- - +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. + +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. 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. diff --git a/pages/kubernetes/how-to/monitor-cluster.mdx b/pages/kubernetes/how-to/monitor-cluster.mdx index ccd814ef88..2508d0aeac 100644 --- a/pages/kubernetes/how-to/monitor-cluster.mdx +++ b/pages/kubernetes/how-to/monitor-cluster.mdx @@ -14,12 +14,20 @@ categories: --- - +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. + +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. + +[Cockpit](/cockpit/quickstart/) empowers you to monitor the clusters' control plane, nodes, managed resources and the cluster system applications. + +* Detect incidents and diagnose failures in the earliest stages +* Get new insights on control plane and worker nodes usage such as CPU and memory to optimize your resource allocation +* Achieve a better understanding of your infrastructure by analyzing data on your API server, system applications and up/down scaling behavior **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/). - **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. + **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. **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/). diff --git a/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx b/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx index 6e49cb7a3e..e49e8ee3db 100644 --- a/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx +++ b/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx @@ -13,7 +13,16 @@ dates: posted: 2025-01-17 --- - +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/). + +This feature allows you to: + +- **Enhance observability**: View logs from all your Kubernetes containers in one place. +- **Simplify troubleshooting**: Quickly drill down into specific pods or containers without needing to configure a separate logging stack. + + + 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. +