b362797e9 · cryptotaxi247/netdata-1

@@ -35,22 +35,19 @@ the Netdata dashboard using an ingress controller.

35

36 ## Install the Netdata Helm chart

37

38 -Download the [Netdata Helm chart](https://github.com/netdata/helmchart) on the administative system where you have the

39 -`helm` binary installed.

38 +We recommend you install the Helm chart using our Helm repository. In the `helm install` command, replace `netdata` with

39 +the release name of your choice.

40

41 ```bash

42 -git clone https://github.com/netdata/helmchart.git netdata-helmchart

42 +helm repo add netdata https://netdata.github.io/helmchart/

43 +helm install netdata netdata/netdata

44 ```

45

45 -> You may not need to configure the Helm chart to get a functioning service on your cluster, but you should read the

46 -> sections on [configuring the Helm chart](#configure-the-netdata-helm-chart) and [configuring service

47 -> discovery](#configure-service-discovery) for details.

46 +> You can also install the Netdata Helm chart by cloning the

47 +> [repository](https://artifacthub.io/packages/helm/netdata/netdata#install-by-cloning-the-repository) and manually

48 +> running Helm against the included chart.

49

49 -Install the Helm chart to your cluster with `helm install`:

50 -

51 -```bash

52 -helm install netdata ./netdata-helmchart

53 -```

50 +### Post-installation

51

52 Run `kubectl get services` and `kubectl get pods` to confirm that your cluster now runs a `netdata` service, one

53 `parent` pod, and three `child` pods.

@@ -65,16 +62,18 @@ Read up on the various configuration options in the [Helm chart

62 documentation](https://github.com/netdata/helmchart#configuration) to see if you need to change any of the options based

63 on your cluster's setup.

64

68 -To change a setting, use the `--set` or `--values` arguments along with `helm install`:

65 +To change a setting, use the `--set` or `--values` arguments with `helm install`, for the initial deployment, or `helm upgrade` to upgrade an existing deployment.

66

67 ```bash

71 -helm install --set a.b.c=xyz netdata ./netdata-helmchart

68 +helm install --set a.b.c=xyz netdata netdata/netdata

69 +helm upgrade --set a.b.c=xyz netdata netdata/netdata

70 ```

71

74 -For example, to change the size of the persistent metrics volume, you would run the following:

72 +For example, to change the size of the persistent metrics volume on the parent node:

73

74 ```bash

77 -helm install --set parent.database.volumesize=4Gi ./netdata-helmchart

75 +helm install --set parent.database.volumesize=4Gi netdata netdata/netdata

76 +helm upgrade --set parent.database.volumesize=4Gi netdata netdata/netdata

77 ```

78

79 ### Configure service discovery

@@ -89,27 +88,27 @@ discovery currently supports [popular

88 applications](https://github.com/netdata/helmchart#service-discovery-and-supported-services), plus any endpoints covered

89 by our [generic Prometheus collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/prometheus).

90

92 -If you haven't changed listening ports or other defaults, service discovery should find your pods, create the proper

93 -configurations based on the service that pod runs, and begin monitoring them immediately after depolyment.

91 +If you haven't changed listening ports, image names, or other defaults, service discovery should find your pods, create

92 +the proper configurations based on the service that pod runs, and begin monitoring them immediately after depolyment.

93

95 -However, if you have changed some of these defaults, you'll need to copy the `netdata-helmchart/sdconfig/child.yml`

96 -file, edit it, and pass the changed file to `helm install`/`helm upgrade`.

94 +However, if you have changed some of these defaults, you need to copy a file from the Netdata Helm chart repository,

95 +make your edits, and pass the changed file to `helm install`/`helm upgrade`.

96

98 -First, copy the file to a new location outside the `netdata-helmchart` directory. The destination can be anywhere you

99 -like, but the following examples assume it resides next to the `netdata-helmchart` directory.

97 +First, copy the file to your administrative system.

98

99 ```bash

102 -cp netdata-helmchart/sdconfig/child.yml .

100 +curl https://raw.githubusercontent.com/netdata/helmchart/master/charts/netdata/sdconfig/child.yml -o child.yml

101 ```

102

103 Edit the new `child.yml` file according to your needs. See the [Helm chart

106 -configuration](https://github.com/netdata/helmchart#configuration) and the file itself for details. You can then run

107 -`helm install`/`helm upgrade` with the `--set-file` argument to use your configured `child.yml` file instead of the

108 -default, changing the path if you copied it elsewhere.

104 +configuration](https://github.com/netdata/helmchart#configuration) and the file itself for details.

105 +

106 +You can then run `helm install`/`helm upgrade` with the `--set-file` argument to use your configured `child.yml` file

107 +instead of the default, changing the path if you copied it elsewhere.

108

109 ```bash

111 -helm install --set-file sd.child.configmap.from.value=./child.yml netdata ./netdata-helmchart

112 -helm upgrade --set-file sd.child.configmap.from.value=./child.yml netdata ./netdata-helmchart

110 +helm install --set-file sd.child.configmap.from.value=./child.yml netdata netdata/netdata

111 +helm upgrade --set-file sd.child.configmap.from.value=./child.yml netdata netdata/netdata

112 ```

113

114 Your configured service discovery is now pushed to your cluster.

@@ -154,7 +153,7 @@ Ensure persistence is enabled on the parent pod by running the following `helm u

153 helm upgrade \

154 --set parent.database.persistence=true \

155 --set parent.alarms.persistence=true \

157 - netdata ./netdata-helmchart

156 + netdata netdata/netdata

157 ```

158

159 Next, find your claiming script in Netdata Cloud by clicking on your Space's dropdown, then **Manage your Space**. Click

@@ -175,7 +174,7 @@ helm upgrade \

174 --set parent.claiming.enabled=true \

175 --set parent.claiming.token="TOKEN" \

176 --set parent.claiming.rooms="ROOM1,ROOM2" \

178 - netdata ./netdata-helmchart

177 + netdata netdata/netdata

178 ```

179

180 The cluster terminates the old parent pod and creates a new one with the proper claiming configuration. You can see your

@@ -188,11 +187,11 @@ Cloud](https://user-images.githubusercontent.com/1153921/94497340-c1f49880-01ab-

187

188 ## Update/reinstall the Netdata Helm chart

189

191 -If you update the Helm chart's configuration, run `helm upgrade` to redeploy your Netdata service, replacing `netdata`

192 -with the name of the release if you changed it upon installtion:

190 +If you update the Helm chart's configuration, run `helm upgrade` to redeploy your Netdata service, replacing `netdata`

191 +with the name of the release, if you changed it upon installtion:

192

193 ```bash

195 -helm upgrade netdata ./netdata-helmchart

194 +helm upgrade netdata netdata/netdata

195 ```

196

197 ## What's next?

Update k8s docs with new Helm repo (#10172)