Skip to content

Commit 7ceabd7

Browse files
authored
docs(review): neda suggestions
1 parent 60b5973 commit 7ceabd7

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

observability/cockpit/how-to/send-log-from-k8s-to-cockpit.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ alloy-singleton:
7676
enabled: true
7777
```
7878
79-
<Message type="info">
79+
<Message type="note">
8080
The template above is for sending logs to your Cockpit. You can also configure it to send metrics to Cockpit using this Helm chart.
8181
Refer to our dedicated doucumentation to [send metrics from your cluster to Cockpit](/observability/cockpit/how-to/send-metrics-froms-k8s-to-cockpit).
8282
</Message>
@@ -88,9 +88,9 @@ Once you have configured your `values.yml` file, you can use Helm to deploy the
8888
1. [Connect](/containers/kubernetes/how-to/connect-cluster-kubectl/) `kubectl` to your Kubernetes cluster
8989
2. Run the command below to install the `k8s-monitoring` Helm chart:
9090
```
91-
helm install -f /your-path/to/values.yml your-log-ingester k8s-monitoring --version 1.6.16
91+
helm install -f /your-path/to/values.yml name-of-your-choice-for-your-log-ingester k8s-monitoring --version 1.6.16
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 `your-log-ingester` with the log ingester of your choice. In our configuration we are using `alloy-lm-ingester`.
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`.
9494

9595
Helm installs the `k8s-monitoring` chart, which includes the Alloy DaemonSet configured to collect logs from your Kubernetes cluster.
9696
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.
@@ -119,8 +119,8 @@ You can also use Terraform to manage and deploy Helm charts, providing you with
119119
```
120120
2. Create a `maint.tf` file and paste the following template to create a Helm release resource. Make sure that you replace `/your-path/to/values.yml` with the actual path to your values file.
121121
```
122-
resource "helm_release" "log-ingester" {
123-
name = "your-log-ingester"
122+
resource "helm_release" "alloy" {
123+
name = "name-of-your-log-ingester"
124124
repository = "https://grafana.github.io/helm-charts"
125125
chart = "k8s-monitoring"
126126
version = "2.0.2"

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,14 @@ alloy-singleton:
6565
enabled: true
6666
```
6767
68-
<Message type="info">
68+
<Message type="note">
6969
The template above is for sending metrics to your Cockpit. You can also configure it to send logs to Cockpit using this Helm chart.
7070
Refer to our dedicated doucumentation to [send logs from your cluster to Cockpit](/observability/cockpit/how-to/send-logs-from-k8s-to-cockpit)
7171
</Message>
7272
7373
## Add annotations for auto-discovery
7474
75-
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 your deployment. Make sure that you replace $METRICS_PORT with the port where your application exposes Prometheus metrics.
75+
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 your deployment. Make sure that you replace `$METRICS_PORT` with the port where your application exposes Prometheus metrics.
7676

7777
### Kubernetes deployment template
7878

@@ -125,8 +125,8 @@ resource "kubernetes_deployment_v1" "your_application_deployment" {
125125
```
126126
2. Create a `maint.tf` file and paste the following template to create a Helm release resource. Make sure that you replace `/your-path/to/values.yml` with the actual path to your values file.
127127
```
128-
resource "helm_release" "metrics-ingester" {
129-
name = "my-metrics-ingester"
128+
resource "helm_release" "alloy" {
129+
name = "name-of-your-metrics-ingester"
130130
repository = "https://grafana.github.io/helm-charts"
131131
chart = "k8s-monitoring"
132132
version = "2.0.2"
@@ -148,9 +148,9 @@ Once you have configured your `values.yml` file, you can use Helm to deploy the
148148
1. [Connect](/containers/kubernetes/how-to/connect-cluster-kubectl/) `kubectl` to your Kubernetes cluster
149149
2. Run the command below to install the `k8s-monitoring` Helm chart:
150150
```
151-
helm install -f /your-path/to/values.yml your-metrics-ingester k8s-monitoring --version 1.6.16
151+
helm install -f /your-path/to/values.yml name-of-your-choice-for-your-metric-ingester k8s-monitoring --version 1.6.16
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 `your-metrics-ingester` with the metric ingester of your choice. In our configuration we are using `alloy-lm-ingester`.
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`.
154154
155155
Helm installs the `k8s-monitoring` chart, which includes the Alloy DaemonSet configured to collect metrics from your Kubernetes cluster.
156156
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.

0 commit comments

Comments
 (0)