Capitalize the word "cloud" (#19043)
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Fotis Voutsas committed
Nov 20, 2024 at 11:14 UTC
d8daa5527a37984476f69c674338e0f63920a595
13 files changed
+33
-39
docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md
+1
-1
@@ -12,7 +12,7 @@ The software is known for its low impact on memory resources, high scalability,
12
13
- Nginx is used and useful in cases when you want to access different instances of Netdata from a single server.
14
15
-- Password-protect access to Netdata, until distributed authentication is implemented via the Netdata cloud Sign In mechanism.
15
+- Password-protect access to Netdata, until distributed authentication is implemented via the Netdata Cloud Sign In mechanism.
16
17
- A proxy was necessary to encrypt the communication to Netdata, until v1.16.0, which provided TLS (HTTPS) support.
18
docs/netdata-cloud/authentication-and-authorization/api-tokens.md
+3
-5
@@ -2,9 +2,7 @@
2
3
## Overview
4
5
-Every single user can get access to the Netdata resource programmatically. It is done through the API Token which
6
-can be also called as Bearer Token. This token is used for authentication and authorization, it can be issued
7
-in the Netdata UI under the user Settings:
5
+Every single user can get access to the Netdata resource programmatically. It is done through the API Token, also called Bearer Token. This token is used for authentication and authorization, it can be issued in the Netdata UI under the user Settings:
6
7
<img width="316" alt="image" src="https://github.com/netdata/netdata/assets/14999928/b0846076-afae-47ab-92df-c24967305ab9"/>
8
@@ -23,11 +21,11 @@ The API Tokens are not going to expire and can be limited to a few scopes:
21
this token is used for the [Netdata Grafana plugin](https://github.com/netdata/netdata-grafana-datasource-plugin/blob/master/README.md)
22
to access Netdata charts
23
26
-Currently, the Netdata Cloud is not exposing stable API.
24
+Currently, Netdata Cloud is not exposing the stable API.
25
26
## Example usage
27
30
-* get the cloud space list
28
+* get the Netdata Cloud space list
29
30
```console
31
curl -H 'Accept: application/json' -H "Authorization: Bearer <token>" https://app.netdata.cloud/api/v2/spaces
docs/netdata-cloud/netdata-cloud-on-prem/installation.md
+14
-14
@@ -123,7 +123,7 @@ Responsible for user registration & authentication. Manages user account informa
123
124
### cloud-agent-data-ctrl-service
125
126
-Forwards request from the cloud to the relevant agents.
126
+Forwards request from the Cloud to the relevant agents.
127
The requests include:
128
129
- Fetching chart metadata from the agent
@@ -136,7 +136,7 @@ Forwards MQTT messages emitted by the agent related to the agent entities to the
136
137
### cloud-agent-mqtt-output-service
138
139
-Forwards Pulsar messages emitted in the cloud related to the agent entities to the MQTT broker. From there, the messages reach the relevant agent.
139
+Forwards Pulsar messages emitted in the Cloud related to the agent entities to the MQTT broker. From there, the messages reach the relevant agent.
140
141
### cloud-alarm-config-mqtt-input-service
142
@@ -148,28 +148,28 @@ Forwards MQTT messages emitted by the agent related to the alarm-log entities to
148
149
### cloud-alarm-mqtt-output-service
150
151
-Forwards Pulsar messages emitted in the cloud related to the alarm entities to the MQTT broker. From there, the messages reach the relevant agent.
151
+Forwards Pulsar messages emitted in the Cloud related to the alarm entities to the MQTT broker. From there, the messages reach the relevant agent.
152
153
### cloud-alarm-processor-service
154
155
-Persists latest alert statuses received from the agent in the cloud.
155
+Persists latest alert statuses received from the agent in the Cloud.
156
Aggregates alert statuses from relevant node instances.
157
-Exposes API endpoints to fetch alert data for visualization on the cloud.
157
+Exposes API endpoints to fetch alert data for visualization on the Cloud.
158
Determines if notifications need to be sent when alert statuses change and emits relevant messages to Pulsar.
159
Exposes API endpoints to store and return notification-silencing data.
160
161
### cloud-alarm-streaming-service
162
163
-Responsible for starting the alert stream between the agent and the cloud.
164
-Ensures that messages are processed in the correct order, and starts a reconciliation process between the cloud and the agent if out-of-order processing occurs.
163
+Responsible for starting the alert stream between the agent and the Cloud.
164
+Ensures that messages are processed in the correct order, and starts a reconciliation process between the Cloud and the Agent if out-of-order processing occurs.
165
166
### cloud-charts-mqtt-input-service
167
168
-Forwards MQTT messages emitted by the agent related to the chart entities to the internal Pulsar broker. These include the chart metadata that is used to display relevant charts on the cloud.
168
+Forwards MQTT messages emitted by the agent related to the chart entities to the internal Pulsar broker. These include the chart metadata that is used to display relevant charts on the Cloud.
169
170
### cloud-charts-mqtt-output-service
171
172
-Forwards Pulsar messages emitted in the cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant agent.
172
+Forwards Pulsar messages emitted in the Cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant agent.
173
174
### cloud-charts-service
175
@@ -183,7 +183,7 @@ Exposes API endpoints to fetch and store custom dashboard data.
183
184
### cloud-environment-service
185
186
-Serves as the first contact point between the agent and the cloud.
186
+Serves as the first contact point between the agent and the Cloud.
187
Returns authentication and MQTT endpoints to connecting agents.
188
189
### cloud-feed-service
@@ -193,7 +193,7 @@ Exposes API endpoints to fetch feed events from Elasticsearch.
193
194
### cloud-frontend
195
196
-Contains the on-prem cloud website. Serves static content.
196
+Contains the on-prem Cloud website. Serves static content.
197
198
### cloud-iam-user-service
199
@@ -213,7 +213,7 @@ Forwards MQTT messages emitted by the agent related to the node entities to the
213
214
### cloud-node-mqtt-output-service
215
216
-Forwards Pulsar messages emitted in the cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant agent.
216
+Forwards Pulsar messages emitted in the Cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant agent.
217
218
### cloud-notifications-dispatcher-service
219
@@ -223,5 +223,5 @@ Handles incoming notification messages and uses the relevant channels(email, sla
223
### cloud-spaceroom-service
224
225
Exposes API endpoints to fetch and store relations between agents, nodes, spaces, users, and rooms.
226
-Acts as a provider of authorization for other cloud endpoints.
227
-Exposes API endpoints to authenticate agents connecting to the cloud.
226
+Acts as a provider of authorization for other Cloud endpoints.
227
+Exposes API endpoints to authenticate agents connecting to the Cloud.
docs/security-and-privacy-design/README.md
+1
-1
@@ -100,7 +100,7 @@ laws, including GDPR and CCPA.
100
101
Netdata ensures user privacy rights as mandated by the GDPR and CCPA. This includes the right to access, correct, and
102
delete personal data. These functions are all available online via the Netdata Cloud User Interface (UI). In case a user
103
-wants to remove all personal information (email and activities), they can delete their cloud account by logging
103
+wants to remove all personal information (email and activities), they can delete their Netdata Cloud account by logging
104
into <https://app.netdata.cloud> and accessing their profile, at the bottom left of the screen.
105
106
### Regular Review and Updates
docs/security-and-privacy-design/netdata-cloud-security.md
+2
-6
@@ -41,10 +41,7 @@ Netdata Cloud does not store user credentials.
41
42
## Security Features and Response
43
44
-Netdata Cloud offers a variety of security features, including infrastructure-level dashboards, centralized alerts
45
-notifications, auditing logs, and role-based access to different segments of the infrastructure. The cloud service
46
-employs several protection mechanisms against DDoS attacks, such as rate-limiting and automated blacklisting. It also
47
-uses static code analyzers to prevent other types of attacks.
44
+Netdata Cloud offers a variety of security features, including infrastructure-level dashboards, centralized alert notifications, auditing logs, and role-based access to different segments of the infrastructure. It employs several protection mechanisms against DDoS attacks, such as rate-limiting and automated blacklisting. It also uses static code analyzers to prevent other types of attacks.
45
46
In the event of potential security vulnerabilities or incidents, Netdata Cloud follows the same process as the Netdata
47
agent. Every report is acknowledged and analyzed by the Netdata team within three working days, and the team keeps the
@@ -59,8 +56,7 @@ security tools, etc.) on a per contract basis.
56
57
## Deleting Personal Data
58
62
-Users who wish to remove all personal data (including email and activities) can delete their cloud account by logging
63
-into Netdata Cloud and accessing their profile.
59
+Users who wish to remove all personal data (including email and activities) can delete their account by logging into Netdata Cloud and accessing their profile.
60
61
## User Privacy and Data Protection
62
packaging/installer/methods/freebsd.md
+1
-1
@@ -21,7 +21,7 @@ Please respond in the affirmative for any relevant prompts during the installati
21
22
The simplest method is to use the single line [kickstart script](/packaging/installer/methods/kickstart.md)
23
24
-If you have a Netdata cloud account then clicking on the **Connect Nodes** button will generate the kickstart command you should use. Use the command from the "Linux" tab, it should look something like this:
24
+If you have a Netdata Cloud account, clicking on the **Connect Nodes** button will generate the kickstart command you should use. Use the command from the "Linux" tab, it should look something like this:
25
26
```sh
27
wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token <CLAIM_TOKEN> --claim-url https://app.netdata.cloud
packaging/installer/methods/kickstart.md
+2
-2
@@ -114,11 +114,11 @@ By default, the kickstart script will provide a Netdata agent installation that
114
- `--claim-token`
115
Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node after the installation. This will connect and claim the Netdata Agent to Netdata Cloud.
116
- `--claim-url`
117
- Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`. Use this option to change the Netdata Cloud URL to point to your Netdata Cloud installation.
117
+ Specify a URL to use when connecting to the Cloud. Defaults to `https://app.netdata.cloud`. Use this option to change the Netdata Cloud URL to point to your Netdata Cloud installation.
118
- `--claim-rooms`
119
Specify a comma-separated list of tokens for each Room this node should appear in.
120
- `--claim-proxy`
121
- Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy. See [connecting through a proxy](/src/claim/README.md#automatically-via-a-provisioning-system-or-the-command-line) for details.
121
+ Specify a proxy to use when connecting to the Cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy. See [connecting through a proxy](/src/claim/README.md#automatically-via-a-provisioning-system-or-the-command-line) for details.
122
- `--claim-only`
123
If there is an existing installation, only try to claim it without attempting to update it. If there is no existing installation, install and claim Netdata normally.
124
packaging/installer/methods/macos.md
+2
-2
@@ -37,9 +37,9 @@ area](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netda
37
- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
38
after the install.
39
- `--claim-rooms`: Specify a comma-separated list of tokens for each Room this node should appear in.
40
-- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy.
40
+- `--claim-proxy`: Specify a proxy to use when connecting to the Cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy.
41
See [connecting through a proxy](/src/claim/README.md#automatically-via-a-provisioning-system-or-the-command-line) for details.
42
-- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`.
42
+- `--claim-url`: Specify a URL to use when connecting to the Cloud. Defaults to `https://app.netdata.cloud`.
43
44
For example:
45
packaging/installer/methods/manual.md
+1
-1
@@ -210,7 +210,7 @@ cd netdata
210
Unlike the [`kickstart.sh`](/packaging/installer/methods/kickstart.md), the `netdata-installer.sh` script does
211
not allow you to automatically [connect](/src/claim/README.md) your node to Netdata Cloud immediately after installation.
212
213
-See the [connect to cloud](/src/claim/README.md) doc for details on connecting a node with a manual installation of Netdata.
213
+See the [connect to Netdata Cloud](/src/claim/README.md) doc for details on connecting a node with a manual installation of Netdata.
214
215
### 'nonrepresentable section on output' errors
216
packaging/installer/methods/source.md
+1
-1
@@ -45,7 +45,7 @@ are using a source tarball published by the Netdata project, then these are incl
45
of the Git repository, you may need to explicitly fetch and update the submodules using `git submodule update
46
--init --recursive`.
47
48
-### Netdata cloud
48
+### Netdata Cloud
49
50
## Building Netdata
51
src/libnetdata/log/README.md
+2
-2
@@ -247,7 +247,7 @@ The structure of the logs are as follows:
247
- Channel `Netdata/Collector`: general messages about Netdata external plugins
248
- Channel `Netdata/Health`: alert transitions and general messages generated by Netdata's health engine
249
- Channel `Netdata/Access`: all accesses to Netdata APIs
250
- - Channel `Netdata/Aclk`: for cloud connectivity tracing (disabled by default)
250
+ - Channel `Netdata/Aclk`: for Cloud connectivity tracing (disabled by default)
251
252
Retention can be configured per Channel via the Event Viewer. Netdata does not set a default, so the system default is used.
253
@@ -272,7 +272,7 @@ For WEL, Netdata logs as follows:
272
- Publisher `NetdataCollector`: general messages about Netdata external plugins
273
- Publisher `NetdataHealth`: alert transitions and general messages generated by Netdata's health engine
274
- Publisher `NetdataAccess`: all accesses to Netdata APIs
275
- - Publisher `NetdataAclk`: for cloud connectivity tracing (disabled by default)
275
+ - Publisher `NetdataAclk`: for Cloud connectivity tracing (disabled by default)
276
277
Publishers must have unique names system-wide, so we had to prefix them with `Netdata`.
278
src/plugins.d/README.md
+1
-1
@@ -451,7 +451,7 @@ The `source` is an integer field that can have the following values:
451
- `1`: The value was set automatically.
452
- `2`: The value was set manually.
453
- `4`: This is a K8 label.
454
-- `8`: This is a label defined using `netdata` agent cloud link.
454
+- `8`: This is a label defined using `netdata` Agent-Cloud link.
455
456
#### CLABEL_COMMIT
457
src/web/api/README.md
+2
-2
@@ -6,7 +6,7 @@ The complete documentation of the Netdata agent's REST API is documented in the
6
7
You can explore it using the **[Swagger UI](https://learn.netdata.cloud/api)**, or the **[Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml)**.
8
9
-## Netdata cloud API
9
+## Netdata Cloud API
10
11
-A very basic Netdata cloud REST API supports the [Grafana data source plugin](https://github.com/netdata/netdata-grafana-datasource-plugin/blob/master/README.md),
11
+A very basic Netdata Cloud REST API supports the [Grafana data source plugin](https://github.com/netdata/netdata-grafana-datasource-plugin/blob/master/README.md),
12
but has not yet been expanded for wider use. We intend to provide a properly documented API in the future.