Skip to content

Commit

Permalink
Typos found while cleaning documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kang-makes committed Oct 25, 2021
1 parent 81c64e0 commit 4fba55c
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@ helm upgrade --install <mark>newrelic</mark> newrelic/nri-bundle \
```

Please notice and adjust the following flags:
- `global.licenseKey=<var>YOUR_NEW_RELIC_LICENSE_KEY</var>`: Must be set to a valid License Key for your account.
- `global.cluster=<var>K8S_CLUSTER_NAME</var>`: Is used to identify the cluster in the New Relic UI, so should be a descriptive value not used by any other Kubernetes cluster configured in your New Relic account.
- `ksm.enabled=<mark>true</mark>`: Setting this to `true` will automatically install Kube State Metrics (KSM) for you, which is required for our integration to run. You can set this to false if KSM is already present in your cluster, even if it is on a different namespace.
- `newrelic-infrastructure.privileged=<mark>true</mark>`: Can be set to `false` to install a trimmed down version of our integration that does not require extra privileges, such as `hostPath` mounts or running containers as root.
- `global.licenseKey=YOUR_NEW_RELIC_LICENSE_KEY`: Must be set to a valid License Key for your account.
- `global.cluster=K8S_CLUSTER_NAME`: Is used to identify the cluster in the New Relic UI, so should be a descriptive value not used by any other Kubernetes cluster configured in your New Relic account.
- `ksm.enabled=true`: Setting this to `true` will automatically install Kube State Metrics (KSM) for you, which is required for our integration to run. You can set this to false if KSM is already present in your cluster, even if it is on a different namespace.
- `newrelic-infrastructure.privileged=true`: Can be set to `false` to install a trimmed down version of our integration that does not require extra privileges, such as `hostPath` mounts or running containers as root.
- Please note that this will disable detailed process collection from the host.
- For performance reasons, our logging solution still requires `hostPath` mounts, regardless of the value of this flag. If this is not allowedin your cluster, you will need to disable the logging solution by specifying `logging.enabled=false`.
- `prometheus.enabled=true`: Will deploy our Prometheus OpenMetrics integration, which automatically collects data from prometheus endpoints present in the cluster.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -150,10 +150,10 @@ In order to update an installation that was deployed using Helm command provided
### Upgrading using the automated installer and plain manifests

<Callout variant="tip">
We encourage you to deploy our integration using Helm, as it provides a cleaner upgrade path comapred to using manifests directly.
We encourage you to deploy our integration using Helm, as it provides a cleaner upgrade path compared to using manifests directly.
</Callout>

If custom manifests have been used instead of Helm, we encourage you to first remove the old installation using `kubectl delete -f <mark>previous-manifest-file.yml</mark>`, and then proceed through the guided installer again. This will generate an updated set of manifests that can be deployed using `kubectl apply -f <mark>manifest-file.yml</mark>`.
If custom manifests have been used instead of Helm, we encourage you to first remove the old installation using `kubectl delete -f previous-manifest-file.yml`, and then proceed through the guided installer again. This will generate an updated set of manifests that can be deployed using `kubectl apply -f manifest-file.yml`.

We do not recommend applying a new version of the manifest file without removing the previous one first, since it might leave some leftover components in your cluster.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,18 +75,18 @@ To link Openshift and Kubernetes you must enable mutating admission webhooks, wh

```
admissionConfig:
pluginConfig:
MutatingAdmissionWebhook:
configuration:
apiVersion: apiserver.config.k8s.io/v1alpha1
kubeConfigFile: /dev/null
kind: WebhookAdmission
ValidatingAdmissionWebhook:
configuration:
apiVersion: apiserver.config.k8s.io/v1alpha1
kubeConfigFile: /dev/null
kind: WebhookAdmission
location: ""
pluginConfig:
MutatingAdmissionWebhook:
configuration:
apiVersion: apiserver.config.k8s.io/v1alpha1
kubeConfigFile: /dev/null
kind: WebhookAdmission
ValidatingAdmissionWebhook:
configuration:
apiVersion: apiserver.config.k8s.io/v1alpha1
kubeConfigFile: /dev/null
kind: WebhookAdmission
location: ""
```

<Callout variant="important">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,7 @@ You have completed the [installation procedure](/docs/kubernetes-monitoring-inte
```

If everything is correct you should get some output like:
</Collapser>

<dd>
```
NAME READY STATUS RESTARTS AGE
newrelic-infra-whvzt 1/1 Running 0 6d20h
Expand All @@ -75,7 +73,7 @@ You have completed the [installation procedure](/docs/kubernetes-monitoring-inte
```
kubectl get daemonsets -l app=newrelic-infra --all-namespaces
```
</dd>
</Collapser>

<Collapser
id="indicators"
Expand Down Expand Up @@ -136,11 +134,9 @@ You have completed the [installation procedure](/docs/kubernetes-monitoring-inte
```
Skipping job creation for component etcd: etcd requires TLS configuration, none given
```
</Collapser>

<dd>
If any error occurs while querying the metrics of any component it will be logged after the `Running job` message.
</dd>
</Collapser>

<Collapser
id="cannot-list-pods-for-cluster"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Containerized private minion (CPM) maintenance and monitoring '
title: 'Containerized private minion (CPM) maintenance and monitoring'
tags:
- Synthetics
- Synthetic monitoring
Expand Down

0 comments on commit 4fba55c

Please sign in to comment.