Skip to content

Commit ad923ff

Browse files
nerda-codesSamyOubouaziz
authored andcommitted
docs(review): weekly review (#5359)
1 parent 3b07a3a commit ad923ff

File tree

14 files changed

+53
-52
lines changed

14 files changed

+53
-52
lines changed

pages/cockpit/concepts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ An endpoint is the point of entry in a communication channel when two systems ar
8686

8787
<Message type="important">
8888
- Having the default configuration on your agents might lead to more of your resources' metrics being sent, a high consumption and a high bill at the end of the month.
89-
- Sending metrics, logs and traces for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) for more information.
89+
- Sending metrics, logs and traces for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/managed-services/#cockpit) for more information.
9090
</Message>
9191

9292
## Grafana users

pages/cockpit/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,6 @@ configure the Grafana Alloy agent, push your data, and visualize it in Grafana.
127127
Find out which Scaleway products are integrated into Cockpit in our [capabilities and limits documentation page](/cockpit/reference-content/cockpit-limitations/#product-integration-into-cockpit).
128128

129129
<Message type="important">
130-
Sending metrics and logs using an external path is a billable feature. Any data that you push yourself is considered as "custom" and is billed, even if you collect that data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) for more information.
130+
Sending metrics and logs using an external path is a billable feature. Any data that you push yourself is considered as "custom" and is billed, even if you collect that data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/managed-services/#cockpit) for more information.
131131
</Message>
132132

pages/cockpit/how-to/create-token.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,5 @@ This page shows you how to create [tokens](/cockpit/concepts/#cockpit-tokens), t
3838

3939
<Message type="important">
4040
- Having the default configuration on your agents might lead to more of your resources' metrics being sent, a high consumption, and a high bill at the end of the month.
41-
- Sending metrics and logs for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing page](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) for more information.
41+
- Sending metrics and logs for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing page](https://www.scaleway.com/en/pricing/managed-services/#cockpit) for more information.
4242
</Message>

pages/cockpit/how-to/send-logs-from-k8s-to-cockpit.mdx

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: How to send logs from your Kubernetes cluster to your Cockpit
33
description: Learn how to send your pod logs to your Cockpit using Scaleway's comprehensive guide. This tutorial covers sending Kubernetes pods logs to Scaleway's Cockpit for centralized monitoring and analysis using Grafana, ensuring efficient monitoring and log analysis in your infrastructure.
44
tags: kubernetes cockpit logs observability monitoring cluster
55
dates:
6-
validation: 2025-01-20
6+
validation: 2025-07-31
77
posted: 2025-01-20
88
---
99
import Requirements from '@macros/iam/requirements.mdx'
@@ -19,13 +19,13 @@ We will use the [k8s-monitoring](https://artifacthub.io/packages/helm/grafana/k8
1919

2020
- A Scaleway account logged into the [console](https://console.scaleway.com)
2121
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
22-
- [Created](/cockpit/how-to/create-external-data-sources/) a custom external data source of the [logs type](/cockpit/concepts/#data-types)
22+
- [Created](/cockpit/how-to/create-external-data-sources/) a [custom data source](/cockpit/concepts/#custom-data) of the [logs type](/cockpit/concepts/#data-types)
2323
- [Created](/cockpit/how-to/create-token/) a Cockpit token in the same region as the logs data source
2424
- A running Kubernetes cluster containing your deployed application
2525
- [Created](/iam/how-to/create-api-keys/) an API key and retrieved your API secret key
2626

2727
<Message type="important">
28-
- Sending logs for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) page for more information.
28+
- Sending logs for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/managed-services/#cockpit) page for more information.
2929
</Message>
3030

3131
## Configure the Helm chart
@@ -84,17 +84,18 @@ alloy-singleton:
8484
Once you have configured your `values.yml` file, you can use Helm to deploy the log-forwarding configuration to your Kubernetes cluster. Before installing the Helm chart, ensure that your `kubectl` tool is properly connected to your Kubernetes cluster. `kubectl` is the command-line tool for interacting with Kubernetes clusters.
8585

8686
1. [Connect](/kubernetes/how-to/connect-cluster-kubectl/) `kubectl` to your Kubernetes cluster
87-
2. Run the command below to install the `k8s-monitoring` Helm chart:
87+
2. Run the commands below to install the `k8s-monitoring` Helm chart. Make sure that you replace `/your-path/to/values.yml` with the correct path where your `values.yml` file is stored. Make sure that you also replace `name-of-your-choice-for-your-log-ingester` with a clear name (ex. `alloy-logs-ingester`).
8888
```
8989
helm repo add grafana https://grafana.github.io/helm-charts
9090
helm repo update
9191
helm install -f /your-path/to/values.yml name-of-your-choice-for-your-log-ingester grafana/k8s-monitoring --version 2.0.21
9292
```
93-
The `-f` flag specifies the path to your `values.yml` file, which contains the configuration for the Helm chart. Make sure that you replace `/your-path/to/values.yml` with the correct path where your `values.yml` file is stored. Make sure that you also replace `name-of-your-choice-for-your-log-ingester` with a clear name (ex. `alloy-logs-ingester`). In our configuration, we are using `alloy-lm-ingester`.
94-
Helm installs the `k8s-monitoring` chart, which includes the Alloy DaemonSet configured to collect logs from your Kubernetes cluster.
95-
The DaemonSet ensures that a pod is running on each node in your cluster, which collects logs and forwards them to the specified Loki endpoint in your Cockpit.
96-
97-
3. Optionally, check the status of the release to ensure it was installed:
93+
<Message type="iam">
94+
The `-f` flag specifies the path to your `values.yml` file, which contains the configuration for the Helm chart. <br /><br />
95+
Helm installs the `k8s-monitoring` chart, which includes the Alloy DaemonSet configured to collect logs from your Kubernetes cluster. <br /><br />
96+
The DaemonSet ensures that a pod is running on each node in your cluster, which collects logs and forwards them to the specified Loki endpoint in your Cockpit.
97+
</Message>
98+
3. Optionally, run the following command to check the status of the release and ensure it was installed:
9899

99100
```
100101
helm list

pages/cockpit/how-to/send-metrics-from-k8s-to-cockpit.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: How to send metrics from your Kubernetes cluster to your Cockpit
33
description: Learn how to send your pod metrics to your Cockpit using Scaleway's comprehensive guide. This tutorial covers sending Kubernetes pods metrics to Scaleway's Cockpit for centralized monitoring and analysis using Grafana, ensuring efficient monitoring and metrics analysis in your infrastructure.
44
tags: kubernetes cockpit metrics observability monitoring cluster
55
dates:
6-
validation: 2025-01-20
6+
validation: 2025-07-31
77
posted: 2025-01-20
88
---
99
import Requirements from '@macros/iam/requirements.mdx'
@@ -26,7 +26,7 @@ We will use the [k8s-monitoring](https://artifacthub.io/packages/helm/grafana/k8
2626
- [Created](/iam/how-to/create-api-keys/) an API key and retrieved your API secret key
2727

2828
<Message type="important">
29-
- Sending metrics for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) page for more information.
29+
- Sending metrics for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/managed-services/#cockpit) page for more information.
3030
</Message>
3131

3232

@@ -70,7 +70,7 @@ alloy-singleton:
7070
7171
## Add annotations for auto-discovery
7272
73-
Annotations in Kubernetes provide a way to attach metadata to your resources. For `k8s-monitoring`, these annotations signal which pods should be scraped for metrics, and what port to use. For the sake of this documentation, we are adding annotations to specify we want `k8s-monitoring` to scrape the pods from our deployment. Make sure that you replace `$METRICS_PORT` with the port where your application exposes Prometheus metrics.
73+
Annotations in Kubernetes provide a way to attach metadata to your resources. For `k8s-monitoring`, these annotations signal which pods should be scraped for metrics, and what port to use. In this documentation we are adding annotations to specify we want `k8s-monitoring` to scrape the pods from our deployment. Make sure that you replace `$METRICS_PORT` with the port where your application exposes Prometheus metrics.
7474

7575
### Kubernetes deployment template
7676

@@ -144,23 +144,23 @@ resource "kubernetes_deployment_v1" "your_application_deployment" {
144144
Once you have configured your `values.yml` file, you can use Helm to deploy the metric-forwarding configuration to your Kubernetes cluster. Before installing the Helm chart, ensure that your `kubectl` tool is properly connected to your Kubernetes cluster. `kubectl` is the command-line tool for interacting with Kubernetes clusters.
145145

146146
1. [Connect](/kubernetes/how-to/connect-cluster-kubectl/) `kubectl` to your Kubernetes cluster
147-
2. Run the command below to install the `k8s-monitoring` Helm chart:
147+
2. Run the command below to install the `k8s-monitoring` Helm chart. Make sure that you replace `/your-path/to/values.yml` with the correct path where your `values.yml` file is stored. Make sure that you also replace `name-of-your-choice-for-your-metric-ingester` with a clear name (ex. `alloy-metrics-ingester`).
148148
```
149149
helm repo add grafana https://grafana.github.io/helm-charts
150150
helm repo update
151151
helm install -f /your-path/to/values.yml name-of-your-choice-for-your-metric-ingester grafana/k8s-monitoring --version 2.0.21
152152
```
153-
The `-f` flag specifies the path to your `values.yml` file, which contains the configuration for the Helm chart. Make sure that you replace `/your-path/to/values.yml` with the correct path where your `values.yml` file is stored. Make sure that you also replace `name-of-your-choice-for-your-metric-ingester` with a clear name (ex. `alloy-metrics-ingester`). In our configuration, we are using `alloy-lm-ingester`.
154-
Helm installs the `k8s-monitoring` chart, which includes the Alloy DaemonSet configured to collect metrics from your Kubernetes cluster.
155-
The DaemonSet ensures that a pod is running on each node in your cluster, which collects metrics and forwards them to the specified Prometheus endpoint in your Cockpit.
156-
153+
<Message type="iam">
154+
The `-f` flag specifies the path to your `values.yml` file, which contains the configuration for the Helm chart. <br /><br />
155+
Helm installs the `k8s-monitoring` chart, which includes the Alloy DaemonSet configured to collect metrics from your Kubernetes cluster. <br /><br />
156+
The DaemonSet ensures that a pod is running on each node in your cluster, which collects metrics and forwards them to the specified Prometheus endpoint in your Cockpit.
157+
</Message>
157158
3. Optionally, check the status of the release to ensure it was installed:
158159

159160
```
160161
helm list
161162
```
162163

163-
164164
## Explore your metrics in Cockpit
165165

166166
Now that your metrics are exported to your Cockpit, you can access and query them.

pages/cockpit/how-to/send-metrics-logs-to-cockpit.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ You can push logs with any Loki compatible agent such as the [Promtail](https://
2525

2626
<Message type="important">
2727
- Having the default configuration on your agents might lead to more of your resources' metrics being sent, a high consumption, and a high bill at the end of the month.
28-
- Sending metrics and logs for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) for more information.
28+
- Sending metrics and logs for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/managed-services/#cockpit) for more information.
2929
</Message>
3030

3131
## Send metrics and logs to your Cockpit

pages/cockpit/how-to/send-metrics-with-grafana-alloy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ For the sake of this documentation, we are using Grafana Alloy on macOS. Refer t
3131
<Message type="important">
3232
- Having the default configuration on your agents might lead to more of your resources' metrics being sent, a high consumption and a high bill at the end of the month.
3333

34-
- Sending metrics and logs for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) for more information.
34+
- Sending metrics and logs for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/managed-services/#cockpit) for more information.
3535
</Message>
3636

3737
## Configuring Grafana Alloy

pages/cockpit/quickstart.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ In this documentation, we show you how to retrieve your Grafana credentials to a
2424

2525
<Message type="important">
2626
- Having the default configuration on your agents might lead to more of your resources' metrics being sent, a high consumption, and a high bill at the end of the month.
27-
- Sending metrics and logs for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) for more information.
27+
- Sending metrics and logs for Scaleway resources or personal data using an external path is a billable feature. In addition, any data that you push yourself is billed, even if you send data from Scaleway products. Refer to the [product pricing](https://www.scaleway.com/en/pricing/managed-services/#cockpit) for more information.
2828
</Message>
2929

3030
## How to retrieve your Grafana credentials
@@ -57,8 +57,8 @@ In this documentation, we show you how to retrieve your Grafana credentials to a
5757
</Message>
5858
7. Click **Create token** to confirm. A pop-up displays with your secret key. Make sure that you save the secret key before closing the pop-up.
5959

60-
<Message type="">
61-
**Going further** <br /><br />
60+
<Message type="iam">
61+
**Going further** <br /><br />
6262

6363
If you have not set up an agent yet, check out our [documentation](/cockpit/how-to/send-metrics-with-grafana-alloy/) to find out how to configure Grafana Alloy, push your metrics, and visualize them in Grafana.
6464
You must have created resources to monitor to push your data to Cockpit.

pages/cockpit/reference-content/cockpit-limitations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The following table provides information about [Mimir](/cockpit/concepts/#mimir)
6262

6363
The following table provides details about the products that are integrated into Cockpit. This means that you can have metrics and/or logs and/or alerts in your Cockpit for the products mentioned below.
6464

65-
**Sending metrics and logs using an external path is a billable feature**. As such, any additional data that you may push yourself will be billed, even if you send data from Scaleway products that are **integrated into Cockpit**. Refer to the [product pricing](https://www.scaleway.com/en/pricing/?tags=available,managedservices-observability-cockpit) for more information.
65+
**Sending metrics and logs using an external path is a billable feature**. As such, any additional data that you may push yourself will be billed, even if you send data from Scaleway products that are **integrated into Cockpit**. Refer to the [product pricing](https://www.scaleway.com/en/pricing/managed-services/#cockpit) for more information.
6666

6767
| **Product Name** | **Metrics** | **Logs** | **Alerts** |
6868
|----------------------------|-----------------|-----------------|-----------------|

pages/domains-and-dns/how-to/manage-nameservers-internal-domain.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: How to manage name servers for an internal domain
33
description: Learn how to effectively manage name servers for your internal domains. This guide covers editing name server information, adding and removing name servers, and validating configurations through the intuitive Domains and DNS dashboard.
44
tags: nameserver internal-domain domain dns
55
dates:
6-
validation: 2025-01-21
6+
validation: 2025-07-31
77
posted: 2022-10-31
88
---
99
import Requirements from '@macros/iam/requirements.mdx'
@@ -26,20 +26,20 @@ For example, if you own `mydomain.com` and want to use `ns0.mydomain.com` and `n
2626

2727
1. Click **Domains and DNS** in the **Domains & Web Hosting** section of the [Scaleway console](https://console.scaleway.com) side menu. The Domains and DNS dashboard displays.
2828
2. Click the domain name you want to configure. The **Overview** tab for your domain displays.
29-
3. Click **Edit** in the **Name servers** section.
29+
3. Scroll to the **Name servers** section and click **Edit**.
3030
4. Edit the name server information. For each name server, you can provide:
3131
* A name server
3232
* An IPv6 address
3333
* An IPv4 address
3434
<Message type="tip">
35-
IP addresses are only required if you want to create **glue records**. A glue record provides the IP address of a name server so that DNS can resolve the domain name if the domain uses name servers hosted under that same domain name.
35+
IP addresses are only required if you want to create **glue records**. A glue record provides the IP address of a name server to allow the DNS to resolve the domain if it uses name servers hosted under that same domain.
3636
</Message>
3737
5. Optionally, click **Add name server** to add more name servers and enter your server's information.
3838
<Message type="tip">
39-
We recommend you configure a minimum of two and a maximum of seven DNS servers for each domain name.
39+
We recommend you configure a minimum of two and a maximum of seven DNS servers for each domain.
4040
</Message>
4141
6. Click the <Icon name="delete" /> icon to delete a name server.
4242
7. Click the <Icon name="validate" /> icon to validate your configuration.
43-
8. Click the <Icon name="cancel" /> icon to cancel all the changes you have made.
43+
8. Click the <Icon name="cancel" /> icon to cancel all changes.
4444

4545

0 commit comments

Comments
 (0)