Skip to content

Commit 55f9d1c

Browse files
authored
Add note (#207)
1 parent c1800db commit 55f9d1c

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/quickstart/ech/k8s.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ logs collection and application monitoring.
1919
1. **Add the OpenTelemetry repository to Helm**
2020

2121
```bash
22-
helm repo add open-telemetry 'https://open-telemetry.github.io/opentelemetry-helm-charts' --force-update
22+
helm repo add open-telemetry "https://open-telemetry.github.io/opentelemetry-helm-charts" --force-update
2323
```
2424

2525
2. **Setup Credentials**
2626

2727
Retrieve the `Elasticsearch Endpoint` and the `Elastic API Key` for your Elastic Cloud deployment by [following these instructions](./#retrieving-connection-details-for-your-elastic-cloud-deployment).
2828

29-
Replace both, `<ELASTICSEARCH_ENDPOINT>` and `<ELASTIC_API_KEY>` in the below command to create a namespace and a secret with your credentials.
29+
Replace both, `<ELASTICSEARCH_ENDPOINT>` and `<ELASTIC_API_KEY>` in the following command to create a namespace and a secret with your credentials.
3030

3131
```bash
3232
kubectl create namespace opentelemetry-operator-system
@@ -36,6 +36,9 @@ logs collection and application monitoring.
3636
--from-literal=elastic_api_key='<ELASTIC_API_KEY>'
3737
```
3838

39+
{: .note}
40+
> On Windows PowerShell, replace backslashes (`\`) with backticks (`` ` ``) for line continuation and single quotes (`'`) with double quotes (`"`).
41+
3942
3. **Install Operator**
4043
4144
Install the OpenTelemetry Operator using the kube-stack Helm chart with the pre-configured `values.yaml` file.
@@ -49,12 +52,12 @@ logs collection and application monitoring.
4952
5053
4. **Auto-instrument Applications**
5154
52-
Add a language-specific annotation to your namespace by replacing `<LANGUAGE>` with one of the supported values (`nodejs`, `java`, `python`, `dotnet` or `go`) in the below command.
55+
Add a language-specific annotation to your namespace by replacing `<LANGUAGE>` with one of the supported values: `nodejs`, `java`, `python`, `dotnet` or `go`:
5356
5457
```bash
5558
kubectl annotate namespace YOUR_NAMESPACE instrumentation.opentelemetry.io/inject-<LANGUAGE>="opentelemetry-operator-system/elastic-instrumentation"
5659
```
5760
5861
Restart your deployment to ensure the annotations and auto-instrumentations are applied.
5962
60-
For languages where auto-instrumentation is not available, you will need to manually instrument your application. See the [Setup section in the corresponding SDK](../../edot-sdks).
63+
For languages where auto-instrumentation is not available, you need to manually instrument your application. See the [Setup section in the corresponding SDK](../../edot-sdks).

0 commit comments

Comments
 (0)