mirror of
https://github.com/netdata/netdata.git
synced 2025-04-10 16:17:36 +00:00
Capitalize the word "cloud" (#19043)
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
This commit is contained in:
Fotis Voutsas
GitHub
parent
2d115f8bb2
commit
d8daa5527a
13 changed files with 33 additions and 39 deletions
docs
netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy
netdata-cloud
security-and-privacy-design
packaging/installer/methods
src
|
|
@ -12,7 +12,7 @@ The software is known for its low impact on memory resources, high scalability,
|
|||
|
||||
- Nginx is used and useful in cases when you want to access different instances of Netdata from a single server.
|
||||
|
||||
- Password-protect access to Netdata, until distributed authentication is implemented via the Netdata cloud Sign In mechanism.
|
||||
- Password-protect access to Netdata, until distributed authentication is implemented via the Netdata Cloud Sign In mechanism.
|
||||
|
||||
- A proxy was necessary to encrypt the communication to Netdata, until v1.16.0, which provided TLS (HTTPS) support.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,9 +2,7 @@
|
|||
|
||||
## Overview
|
||||
|
||||
Every single user can get access to the Netdata resource programmatically. It is done through the API Token which
|
||||
can be also called as Bearer Token. This token is used for authentication and authorization, it can be issued
|
||||
in the Netdata UI under the user Settings:
|
||||
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:
|
||||
|
||||
<img width="316" alt="image" src="https://github.com/netdata/netdata/assets/14999928/b0846076-afae-47ab-92df-c24967305ab9"/>
|
||||
|
||||
|
|
@ -23,11 +21,11 @@ The API Tokens are not going to expire and can be limited to a few scopes:
|
|||
this token is used for the [Netdata Grafana plugin](https://github.com/netdata/netdata-grafana-datasource-plugin/blob/master/README.md)
|
||||
to access Netdata charts
|
||||
|
||||
Currently, the Netdata Cloud is not exposing stable API.
|
||||
Currently, Netdata Cloud is not exposing the stable API.
|
||||
|
||||
## Example usage
|
||||
|
||||
* get the cloud space list
|
||||
* get the Netdata Cloud space list
|
||||
|
||||
```console
|
||||
curl -H 'Accept: application/json' -H "Authorization: Bearer <token>" https://app.netdata.cloud/api/v2/spaces
|
||||
|
|
|
|||
|
|
@ -123,7 +123,7 @@ Responsible for user registration & authentication. Manages user account informa
|
|||
|
||||
### cloud-agent-data-ctrl-service
|
||||
|
||||
Forwards request from the cloud to the relevant agents.
|
||||
Forwards request from the Cloud to the relevant agents.
|
||||
The requests include:
|
||||
|
||||
- Fetching chart metadata from the agent
|
||||
|
|
@ -136,7 +136,7 @@ Forwards MQTT messages emitted by the agent related to the agent entities to the
|
|||
|
||||
### cloud-agent-mqtt-output-service
|
||||
|
||||
Forwards Pulsar messages emitted in the cloud related to the agent entities to the MQTT broker. From there, the messages reach the relevant agent.
|
||||
Forwards Pulsar messages emitted in the Cloud related to the agent entities to the MQTT broker. From there, the messages reach the relevant agent.
|
||||
|
||||
### cloud-alarm-config-mqtt-input-service
|
||||
|
||||
|
|
@ -148,28 +148,28 @@ Forwards MQTT messages emitted by the agent related to the alarm-log entities to
|
|||
|
||||
### cloud-alarm-mqtt-output-service
|
||||
|
||||
Forwards Pulsar messages emitted in the cloud related to the alarm entities to the MQTT broker. From there, the messages reach the relevant agent.
|
||||
Forwards Pulsar messages emitted in the Cloud related to the alarm entities to the MQTT broker. From there, the messages reach the relevant agent.
|
||||
|
||||
### cloud-alarm-processor-service
|
||||
|
||||
Persists latest alert statuses received from the agent in the cloud.
|
||||
Persists latest alert statuses received from the agent in the Cloud.
|
||||
Aggregates alert statuses from relevant node instances.
|
||||
Exposes API endpoints to fetch alert data for visualization on the cloud.
|
||||
Exposes API endpoints to fetch alert data for visualization on the Cloud.
|
||||
Determines if notifications need to be sent when alert statuses change and emits relevant messages to Pulsar.
|
||||
Exposes API endpoints to store and return notification-silencing data.
|
||||
|
||||
### cloud-alarm-streaming-service
|
||||
|
||||
Responsible for starting the alert stream between the agent and the cloud.
|
||||
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.
|
||||
Responsible for starting the alert stream between the agent and the Cloud.
|
||||
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.
|
||||
|
||||
### cloud-charts-mqtt-input-service
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### cloud-charts-mqtt-output-service
|
||||
|
||||
Forwards Pulsar messages emitted in the cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant agent.
|
||||
Forwards Pulsar messages emitted in the Cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant agent.
|
||||
|
||||
### cloud-charts-service
|
||||
|
||||
|
|
@ -183,7 +183,7 @@ Exposes API endpoints to fetch and store custom dashboard data.
|
|||
|
||||
### cloud-environment-service
|
||||
|
||||
Serves as the first contact point between the agent and the cloud.
|
||||
Serves as the first contact point between the agent and the Cloud.
|
||||
Returns authentication and MQTT endpoints to connecting agents.
|
||||
|
||||
### cloud-feed-service
|
||||
|
|
@ -193,7 +193,7 @@ Exposes API endpoints to fetch feed events from Elasticsearch.
|
|||
|
||||
### cloud-frontend
|
||||
|
||||
Contains the on-prem cloud website. Serves static content.
|
||||
Contains the on-prem Cloud website. Serves static content.
|
||||
|
||||
### cloud-iam-user-service
|
||||
|
||||
|
|
@ -213,7 +213,7 @@ Forwards MQTT messages emitted by the agent related to the node entities to the
|
|||
|
||||
### cloud-node-mqtt-output-service
|
||||
|
||||
Forwards Pulsar messages emitted in the cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant agent.
|
||||
Forwards Pulsar messages emitted in the Cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant agent.
|
||||
|
||||
### cloud-notifications-dispatcher-service
|
||||
|
||||
|
|
@ -223,5 +223,5 @@ Handles incoming notification messages and uses the relevant channels(email, sla
|
|||
### cloud-spaceroom-service
|
||||
|
||||
Exposes API endpoints to fetch and store relations between agents, nodes, spaces, users, and rooms.
|
||||
Acts as a provider of authorization for other cloud endpoints.
|
||||
Exposes API endpoints to authenticate agents connecting to the cloud.
|
||||
Acts as a provider of authorization for other Cloud endpoints.
|
||||
Exposes API endpoints to authenticate agents connecting to the Cloud.
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ laws, including GDPR and CCPA.
|
|||
|
||||
Netdata ensures user privacy rights as mandated by the GDPR and CCPA. This includes the right to access, correct, and
|
||||
delete personal data. These functions are all available online via the Netdata Cloud User Interface (UI). In case a user
|
||||
wants to remove all personal information (email and activities), they can delete their cloud account by logging
|
||||
wants to remove all personal information (email and activities), they can delete their Netdata Cloud account by logging
|
||||
into <https://app.netdata.cloud> and accessing their profile, at the bottom left of the screen.
|
||||
|
||||
### Regular Review and Updates
|
||||
|
|
|
|||
|
|
@ -41,10 +41,7 @@ Netdata Cloud does not store user credentials.
|
|||
|
||||
## Security Features and Response
|
||||
|
||||
Netdata Cloud offers a variety of security features, including infrastructure-level dashboards, centralized alerts
|
||||
notifications, auditing logs, and role-based access to different segments of the infrastructure. The cloud service
|
||||
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.
|
||||
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.
|
||||
|
||||
In the event of potential security vulnerabilities or incidents, Netdata Cloud follows the same process as the Netdata
|
||||
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.
|
|||
|
||||
## Deleting Personal Data
|
||||
|
||||
Users who wish to remove all personal data (including email and activities) can delete their cloud account by logging
|
||||
into Netdata Cloud and accessing their profile.
|
||||
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.
|
||||
|
||||
## User Privacy and Data Protection
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ Please respond in the affirmative for any relevant prompts during the installati
|
|||
|
||||
The simplest method is to use the single line [kickstart script](/packaging/installer/methods/kickstart.md)
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
```sh
|
||||
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
|
||||
|
|
|
|||
|
|
@ -114,11 +114,11 @@ By default, the kickstart script will provide a Netdata agent installation that
|
|||
- `--claim-token`
|
||||
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.
|
||||
- `--claim-url`
|
||||
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.
|
||||
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.
|
||||
- `--claim-rooms`
|
||||
Specify a comma-separated list of tokens for each Room this node should appear in.
|
||||
- `--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. See [connecting through a proxy](/src/claim/README.md#automatically-via-a-provisioning-system-or-the-command-line) for details.
|
||||
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.
|
||||
- `--claim-only`
|
||||
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.
|
||||
|
||||
|
|
|
|||
|
|
@ -37,9 +37,9 @@ area](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netda
|
|||
- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
|
||||
after the install.
|
||||
- `--claim-rooms`: Specify a comma-separated list of tokens for each Room this node should appear in.
|
||||
- `--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.
|
||||
- `--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.
|
||||
See [connecting through a proxy](/src/claim/README.md#automatically-via-a-provisioning-system-or-the-command-line) for details.
|
||||
- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`.
|
||||
- `--claim-url`: Specify a URL to use when connecting to the Cloud. Defaults to `https://app.netdata.cloud`.
|
||||
|
||||
For example:
|
||||
|
||||
|
|
|
|||
|
|
@ -210,7 +210,7 @@ cd netdata
|
|||
Unlike the [`kickstart.sh`](/packaging/installer/methods/kickstart.md), the `netdata-installer.sh` script does
|
||||
not allow you to automatically [connect](/src/claim/README.md) your node to Netdata Cloud immediately after installation.
|
||||
|
||||
See the [connect to cloud](/src/claim/README.md) doc for details on connecting a node with a manual installation of Netdata.
|
||||
See the [connect to Netdata Cloud](/src/claim/README.md) doc for details on connecting a node with a manual installation of Netdata.
|
||||
|
||||
### 'nonrepresentable section on output' errors
|
||||
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ are using a source tarball published by the Netdata project, then these are incl
|
|||
of the Git repository, you may need to explicitly fetch and update the submodules using `git submodule update
|
||||
--init --recursive`.
|
||||
|
||||
### Netdata cloud
|
||||
### Netdata Cloud
|
||||
|
||||
## Building Netdata
|
||||
|
||||
|
|
|
|||
|
|
@ -247,7 +247,7 @@ The structure of the logs are as follows:
|
|||
- Channel `Netdata/Collector`: general messages about Netdata external plugins
|
||||
- Channel `Netdata/Health`: alert transitions and general messages generated by Netdata's health engine
|
||||
- Channel `Netdata/Access`: all accesses to Netdata APIs
|
||||
- Channel `Netdata/Aclk`: for cloud connectivity tracing (disabled by default)
|
||||
- Channel `Netdata/Aclk`: for Cloud connectivity tracing (disabled by default)
|
||||
|
||||
Retention can be configured per Channel via the Event Viewer. Netdata does not set a default, so the system default is used.
|
||||
|
||||
|
|
@ -272,7 +272,7 @@ For WEL, Netdata logs as follows:
|
|||
- Publisher `NetdataCollector`: general messages about Netdata external plugins
|
||||
- Publisher `NetdataHealth`: alert transitions and general messages generated by Netdata's health engine
|
||||
- Publisher `NetdataAccess`: all accesses to Netdata APIs
|
||||
- Publisher `NetdataAclk`: for cloud connectivity tracing (disabled by default)
|
||||
- Publisher `NetdataAclk`: for Cloud connectivity tracing (disabled by default)
|
||||
|
||||
Publishers must have unique names system-wide, so we had to prefix them with `Netdata`.
|
||||
|
||||
|
|
|
|||
|
|
@ -451,7 +451,7 @@ The `source` is an integer field that can have the following values:
|
|||
- `1`: The value was set automatically.
|
||||
- `2`: The value was set manually.
|
||||
- `4`: This is a K8 label.
|
||||
- `8`: This is a label defined using `netdata` agent cloud link.
|
||||
- `8`: This is a label defined using `netdata` Agent-Cloud link.
|
||||
|
||||
#### CLABEL_COMMIT
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ The complete documentation of the Netdata agent's REST API is documented in the
|
|||
|
||||
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)**.
|
||||
|
||||
## Netdata cloud API
|
||||
## Netdata Cloud API
|
||||
|
||||
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),
|
||||
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),
|
||||
but has not yet been expanded for wider use. We intend to provide a properly documented API in the future.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue