get-started.mdx 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. ---
  2. title: "Get started with Netdata Cloud"
  3. description: >-
  4. "Ready to get real-time visibility into your entire infrastructure? This guide will help you get started on
  5. Netdata Cloud."
  6. image: "/img/seo/cloud_get-started.png"
  7. custom_edit_url: "https://github.com/netdata/learn/blob/master/docs/cloud/get-started.mdx"
  8. ---
  9. import Link from '@docusaurus/Link'
  10. import Callout from '@site/src/components/Callout'
  11. Ready to get real-time visibility into your entire infrastructure with Netdata Cloud? This guide will walk you through
  12. the onboarding process, such as setting up your Space and War Room and connecting your first nodes.
  13. ## Before you start
  14. Before you get started with Netdata Cloud, you should have the open-source Netdata monitoring agent installed. See our
  15. [installation guide](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) for details.
  16. If you already have the Netdata agent running on your node(s), make sure to update it to v1.32 or higher. Read the
  17. [updating documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/UPDATE.md) for information
  18. on how to update based on the method you used to install Netdata on that node.
  19. ## Begin the onboarding process
  20. Get started by signing in to Netdata. Read
  21. the [sign in](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.mdx) doc for details on the
  22. authentication methods we use.
  23. <Link to="https://app.netdata.cloud" className="group">
  24. <button className="relative text-text bg-gray-200 px-4 py-2 rounded">
  25. <span className="z-10 relative font-semibold group-hover:text-gray-100">Sign in to Netdata</span>
  26. <div className="opacity-0 group-hover:opacity-100 transition absolute z-0 inset-0 bg-gradient-to-r from-green to-green-lighter rounded"></div>
  27. </button>
  28. </Link>
  29. Once signed in with your preferred method, a
  30. General [War Room](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md) and
  31. a [Space](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md)
  32. named for your login email are automatically created. You can configure more Spaces and War Rooms to help you you
  33. organize your team
  34. and the many systems that make up your infrastructure. For example, you can put product and infrastructure SRE teams in
  35. separate
  36. Spaces, and then use War Rooms to group nodes by their service (`nginx`), purpose (`webservers`), or physical
  37. location (`IAD`).
  38. Don't worry! You can always add more Spaces and War Rooms later if you decide to reorganize how you use Netdata Cloud.
  39. ## Connect your nodes
  40. From within the created War Rooms, Netdata Cloud prompts you
  41. to [connect](https://github.com/netdata/netdata/blob/master/claim/README.md) your nodes to Netdata Cloud. Non-admin
  42. users can users can select from existing nodes already connected to the space or select an admin from a provided list to
  43. connect node.
  44. You can connect any node running Netdata, whether it's a physical or virtual machine, a Docker container, IoT device,
  45. and more.
  46. The connection process securely connects any node to Netdata Cloud using
  47. the [Agent-Cloud link](https://github.com/netdata/netdata/blob/master/aclk/README.md). By
  48. connecting a node, you prove you have write and administrative access to that node. Connecting to Cloud also prevents
  49. any third party
  50. from connecting a node that you control. Keep in mind:
  51. - _You can only connect any given node in a single Space_. You can, however, add that connected node to multiple War
  52. Rooms
  53. within that one Space.
  54. - You must repeat the connection process on every node you want to add to Netdata Cloud.
  55. <Callout type="notice">
  56. **Netdata Cloud ensures your data privacy by not storing metrics data from your nodes**. See our statement on Netdata
  57. Cloud [data privacy](https://github.com/netdata/netdata/blob/master/aclk/README.md/#data-privacy) for details on the
  58. data that's streamed from your nodes and the
  59. [connecting to cloud](https://github.com/netdata/netdata/blob/master/claim/README.md) doc for details about why we
  60. implemented the connection process and the encryption methods we use to secure your data in transit.
  61. </Callout>
  62. To connect a node, select which War Rooms you want to add this node to with the dropdown, then copy the script given by
  63. Netdata Cloud into your node's terminal.
  64. Hit **Enter**. The script should return `Agent was successfully claimed.`. If the claiming script returns errors, or if
  65. you don't see the node in your Space after 60 seconds, see
  66. the [troubleshooting information](https://github.com/netdata/netdata/blob/master/claim/README.md#troubleshooting).
  67. Repeat this process with every node you want to add to Netdata Cloud during onboarding. You can also add more nodes once
  68. you've finished onboarding by clicking the **Connect Nodes** button in
  69. the [Space management area](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md/#manage-spaces).
  70. ### Alternatives and other operating systems
  71. **Docker**: You can execute the claiming script Netdata running as a Docker container, or attach the claiming script
  72. when creating the container for the first time, such as when you're spinning up ephemeral containers. See
  73. the [connect an agent running in Docker](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-an-agent-running-in-docker)
  74. documentation for details.
  75. **Without root privileges**: If you want to connect an agent without using root privileges, see our [connect
  76. documentation](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-an-agent-without-root-privileges).
  77. **With a proxy**: If your node uses a proxy to connect to the internet, you need to configure the node's proxy settings.
  78. See
  79. our [connect through a proxy](https://github.com/netdata/netdata/blob/master/claim/README.md#connect-through-a-proxy)
  80. doc for details.
  81. ## Add bookmarks to essential resources
  82. When an anomaly or outage strikes, your team needs to access other essential resources quickly. You can use Netdata
  83. Cloud's bookmarks to put these tools in one accessible place. Bookmarks are shared between all War Rooms in a Space, so
  84. any users in your Space will be able to see and use them.
  85. Bookmarks can link to both internal and external resources. You can bookmark your app's status page for quick updates
  86. during an outage, a messaging system on your organization's intranet, or other tools your team uses to respond to
  87. changes in your infrastructure.
  88. To add a new bookmark, click on the **Add bookmark** link. In the panel, name the bookmark, include its URL, and write a
  89. short description for your team's reference.
  90. ## What's next?
  91. You finish onboarding
  92. by [inviting members of your team](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md)
  93. to your Space. You
  94. can also invite them later. At this point, you're ready to use Cloud.
  95. Next, learn about the organization and interfaces
  96. behind [Spaces](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md)
  97. and [War
  98. Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md).
  99. If you're ready to explore, check out how to use
  100. the [Overview dashboard](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md), which is the
  101. default view for each new War Room you create.