diff options
| author | Joel Hans <joel@netdata.cloud> | 2020-12-07 14:48:52 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-07 14:48:52 -0700 |
| commit | a80af1b120af6504c1b42f4c80882c5efc461a8d (patch) | |
| tree | 88cff6f61c0e28a50e11e967c344298bfb10b713 /docs/configure | |
| parent | 6d91cedecd5ee3f58e5fe8af48ea5eac33abb967 (diff) | |
Improve core documentation to align with recent Netdata Cloud releases (#10318)
* Change overview doc with group by node
* Add hash to link
* Update core documentation with latest from Cloud
* Fix link
* Fixes for Amy
* Fixes for Odysseas
Diffstat (limited to 'docs/configure')
| -rw-r--r-- | docs/configure/invite-collaborate.md | 58 | ||||
| -rw-r--r-- | docs/configure/nodes.md | 7 | ||||
| -rw-r--r-- | docs/configure/secure-nodes.md | 4 | ||||
| -rw-r--r-- | docs/configure/spaces-war-rooms.md | 87 |
4 files changed, 5 insertions, 151 deletions
diff --git a/docs/configure/invite-collaborate.md b/docs/configure/invite-collaborate.md deleted file mode 100644 index 0949066c76..0000000000 --- a/docs/configure/invite-collaborate.md +++ /dev/null @@ -1,58 +0,0 @@ -<!-- -title: "Invite your team and collaborate" -description: "Invite your SRE, DevOPs, or ITOps teams to Netdata Cloud to give everyone insights into your infrastructure from a single pane of glass." -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configure/invite-collaborate.md ---> - -# Invite your team and collaborate - -Netdata is designed to make an infrastructure's real-time metrics available and actionable to all organization members. -By inviting others, you can better synchronize with your team or colleagues to understand your infrastructure's -heartbeat. When something goes wrong, you'll be ready to collaboratively troubleshoot complex performance problems from -a single pane of glass. - -## Invite new members - -Invite new users by clicking on your Space's name in the top navigation, and then **Invite more users**, to open the -invitation pane. Admins manage user permissions and have control over who can access specific Spaces and War Rooms. - - - -Enter their email address and name. They can change this name once they accept your invitation. - -Choose which War Rooms you want to add this user to, then click the plus **+** button to add the invitation to the -**New invitations to be sent** queue. Repeat the process with everyone you want to invite to your Space. - -When you're ready to send the new invitations you created, hit the **Send** button. Netdata Cloud sends these -invitations and moves them to the **Invitations awaiting response** category. - -Your team will receive their email invitations momentarily with a prompt to sign in to join your Space. - -## Collaboration with Netdata Cloud - -Netdata Cloud gives teams a single interface to view real-time metrics across their entire infrastructure. Having all -the metrics, alarm statuses, dashboards, and people in one place is a powerful asset for any infrastructure monitoring -team. - -Assets like dashboards and bookmarks are shared between members of a War Room. As soon as one member creates a -dashboard, for example, other members of the same War Room can see it in the War Room's dropdown and supplement it with -additional charts/text. - -Let's say you get an alert from your nodes about an excess of 500-type errors in your Nginx logs. Your team can hop on a -Slack call to begin working together. While one engineer handles creating a new dashboard with a half-dozen relevant -Nginx log metrics, another can dive into the real-time node dashboard and investigate correlated charts in granular -detail. - -## What's next? - -If your team members have trouble signing in, direct them to the [Netdata Cloud sign in -doc](https://learn.netdata.cloud/docs/cloud/manage/sign-in). Or, find answers to other common questions about Netdata -Cloud in our [FAQ](https://learn.netdata.cloud/docs/cloud/faq-glossary). - -Next, we recommend you learn the [basics of node configuration](/docs/configure/nodes.md). While the Netdata Agent is -proudly zero-configuration in most cases, you should understand how to tweak its settings to give you the best Netdata, -for example, to [increase metrics retention](/docs/store/change-metrics-storage.md) and [improve -security](/docs/configure/secure-nodes.md). - -[](<>) diff --git a/docs/configure/nodes.md b/docs/configure/nodes.md index 761350b161..89aa760a69 100644 --- a/docs/configure/nodes.md +++ b/docs/configure/nodes.md @@ -1,13 +1,14 @@ <!-- -title: "Configure your nodes" +title: "Configure the Netdata Agent" description: "Netdata is zero-configuration for most users, but complex infrastructures may require you to tweak some of the Agent's granular settings." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configure/nodes.md --> -# Configure your nodes +# Configure the Netdata Agent Netdata's zero-configuration collection, storage, and visualization features work for many users, infrastructures, and -use cases, but there are some situations where you might want to configure your nodes. +use cases, but there are some situations where you might want to configure the Netdata Agent running on your node(s), +which can be a physical or virtual machine (VM), container, cloud deployment, or edge/IoT device. For example, you might want to increase metrics retention, configure a collector based on your infrastructure's unique setup, or secure the local dashboard by restricting it to only connections from `localhost`. diff --git a/docs/configure/secure-nodes.md b/docs/configure/secure-nodes.md index 1dce5d11e4..e58102401d 100644 --- a/docs/configure/secure-nodes.md +++ b/docs/configure/secure-nodes.md @@ -1,8 +1,6 @@ <!-- title: "Secure your nodes" -description: "Your data and systems are safe with Netdata, but - -we recommend a few easy ways to improve the security of your infrastructure." +description: "Your data and systems are safe with Netdata, but we recommend a few easy ways to improve the security of your infrastructure." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configure/secure-nodes.md --> diff --git a/docs/configure/spaces-war-rooms.md b/docs/configure/spaces-war-rooms.md deleted file mode 100644 index 6b45aab6f0..0000000000 --- a/docs/configure/spaces-war-rooms.md +++ /dev/null @@ -1,87 +0,0 @@ -<!-- -title: "Set up Spaces and War Rooms" -description: "Netdata Cloud allows people and teams of all sizes to organize their infrastructure and collaborate on anomalies or incidents." -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configure/spaces-war-rooms.md ---> - -# Set up Spaces and War Rooms - -Spaces and War Rooms help you organize your real-time infrastructure monitoring experience in Netdata Cloud. You already -created a Space and War Room when you first signed in to Cloud, assuming you weren't invited to an existing Space by -someone else. - -In either case, you can always create new Spaces and War Rooms based on your changing needs or a scaled-up -infrastructure. Let's talk through some strategies for building the most intuitive Cloud experience for your team. - -> This guide assumes you've already [signed in](https://app.netdata.cloud) to Netdata Cloud and finished creating your -> account. If you're not interested in Netdata Cloud's features, you can skip ahead to [node configuration -> basics](/docs/configure/nodes.md). - -## Spaces - -Spaces are high-level containers to help you organize your team members and the nodes they can view in each War Room. -You already have at least one Space in your Netdata Cloud account. - -To create a new Space, click the **+** icon, enter its name, and click **Save**. Netdata Cloud distinguishes between -Spaces with abbreviated versions of their name. Click on any of the icons to switch between them. - - - -The organization you choose will likely be based on two factors: - -1. The fact that any node can be claimed to a single Space. -2. The size of your team and the complexity of the infrastructure you monitor. - -A single Space puts all your metrics in one easily-accessible place, while multiple Spaces creates logical division -between different users and different pieces of a large infrastructure. - -For example, a large organization might have one SRE team for the user-facing SaaS application, and a second IT team for -managing employees' hardware. Since these teams don't monitor the same nodes, they can work in separate Spaces and then -further organize their nodes into War Rooms. - -You can also use multiple Spaces for different aspects of your monitoring "life," such as your work infrastructure -versus your homelab. - -## War Rooms - -War Rooms are granular containers for organizing nodes, viewing key metrics in real-time, and monitoring the health and -alarm status of many nodes. - -War Rooms organize the [at-a-glance Node view](/docs/visualize/view-all-nodes.md) and any [new -dashboards](/docs/visualize/create-dashboards.md) you build. - -We recommend a few strategies for organizing your War Rooms. - -**Service, purpose, location, etc.**: You can group War Rooms by a service (think Nginx, MySQL, Pulsar, and so on), -their purpose (webserver, database, application), their physical location, whether they're baremetal or a Docker -container, the PaaS/cloud provider it runs on, and much more. This allows you to see entire slices of your -infrastructure by moving from one War Room to another. - -**End-to-end apps/services**: If you have a user-facing SaaS product, or an internal service that said product relies -on, you may want to monitor that entire stack in a single War Room. This might include Kubernetes clusters, Docker -containers, proxies, databases, web servers, brokers, and more. End-to-end War Rooms are valuable tools for ensuring the -health and performance of your organization's essential services. - -**Incident response**: You can also create new War Rooms as one of the first steps in your incident response process. -For example, you have a user-facing web app that relies on Apache Pulsar for a message queue, and one of your nodes -using the [Pulsar collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/pulsar) begins -reporting a suspiciously low messages rate. You can create a War Room called `$year-$month-$day-pulsar-rate`, add all -your Pulsar nodes in addition to nodes they connect to, and begin diagnosing the root cause in a War Room optimized for -getting to resolution as fast as possible. - -For example, here is a War Room based on the node's provider and physical location (**us-east-1**). - - - -## What's next? - -Once you've figured out an organizational structure that works for your infrastructure, it's time to [invite your -team](/docs/configure/invite-collaborate.md). You can invite any number of colleagues to help you collectively -troubleshoot the most complex of infrastructure-wide performance issues. - -If you don't have a team or aren't ready to invite them, you can skip ahead to learn the [basics of node -configuration](/docs/configure/nodes.md). - -[](<>) |