Skip to content

docs: Add dedicated netdata-claim.sh reference page#5

Open
kanelatechnical wants to merge 252 commits intomasterfrom
docs/add-netdata-claim-sh-reference
Open

docs: Add dedicated netdata-claim.sh reference page#5
kanelatechnical wants to merge 252 commits intomasterfrom
docs/add-netdata-claim-sh-reference

Conversation

@kanelatechnical
Copy link
Owner

Summary

Created a new documentation page for the netdata-claim.sh script to help first-time users who log in to Netdata Cloud.

Changes

  • Added docs/netdata-cloud/claim-agent.md - a dedicated reference page for the netdata-claim.sh script

What's Included

The new page provides:

  • Complete CLI options reference (all options verified against src/claim/netdata-claim.sh.in)
  • Environment variables documentation (verified against source code)
  • Exit codes with explanations (from kickstart.sh claim function at lines 1330-1345)
  • Docker and Kubernetes deployment examples
  • Verification steps using netdatacli aclk-state
  • Troubleshooting guide with common error messages

Technical Accuracy

All content has been verified against the source code:

  • CLI options match netdata-claim.sh.in lines 66-88
  • Environment variables match lines 33-36 of the claim script
  • Exit codes match kickstart.sh lines 1330-1345
  • Proxy configuration patterns match existing documentation

Related Documentation

Preview

The new page will be available at: docs/netdata-cloud/claim-agent.md

netdatabot and others added 30 commits October 8, 2025 13:25
…netdata#21118)

* Make native package dependencies consistent between DEB/RPM packages.

* Fix typo.

* Further fixes.
* Use the correct component name for the IBM plugin libs.

The mismatch was preventing the files from being included in the
package.

* Fix IBM libs file list for RPM packages.
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…etdata#21137)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…c/go (netdata#21134)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…o 28.5.1+incompatible in /src/go (netdata#21135)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
….0 in /src/go (netdata#21138)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Exclude Windows from temporary spawn server initialization and cleanup

* Additional checks to isolate windows deadlock issue

* Switch to sleep_usec

* Cast revents to unsigned int for log clarity in log forwarder
* Add Fedora 43 to CI and package builds.

* Fix up user/group deps for Fedora RPMs.
fix(status-file): prevent deadlock on Windows by commenting out non-async-safe code
…tdata#21131)

We can’t rely on CMAKE_INSTALL_PREFIX at build time because it may be
different at install time from what was specified at build time.

Instead, set the RUNPATH relative to the binary itself. This is done
using the `$ORIGIN` keyword in the RUNPATH to reference the directory
the plugin is located in and then using `..` to reference parent
directories.
* Fix AS400 CPU metrics scaling and docs

* fixed bug in odbc union parsing that resulted in wrong columns selected from as400 results

* added defensive checks in odbc C code to ensure there is no misuse

* updated auto-generated files

* documented cardinality management

* removed debugging code

* more fixes

* more fixes

* remove negative multipliers
Limit cgroup discovery to a maximum number of entries and log a warning if exceeded
kanelatechnical and others added 30 commits November 21, 2025 22:12
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Addressing Ralph's comments
Addressing Ralph's comments
Adressing ralph's comments
Addressing Ralph's comments
Addressing cubic's comment
…via-config-files.md

Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Chapters added with proper subdirectory structure:
- 4: controlling-alerts-noise (5 files)
- 5: receiving-notifications (5 files)
- 6: alert-examples (6 files)
- 7: troubleshooting-alerts (6 files)
- 8: advanced-techniques (6 files)
- 9: apis-alerts-events (6 files)
- 10: cloud-alert-features (5 files)
- 11: built-in-alerts.md
- 12: best-practices.md
- 13: architecture.md

Update map.csv with new entries.
…practices)

- Add numbered subsections (11.1.x, 11.2.x, 12.1.x, etc.)
- Add :::note boxes for important context
- Add tables for state transitions and comparison data
- Add Related Sections with internal doc links
- Match styling pattern from earlier chapters
- Add numbered subsections (11.1.1, 11.2.1, etc.)
- Add :::note boxes with collector requirements
- Add Related Sections with internal doc links
- Match styling pattern from earlier chapters
- Add numbered subsections (11.3.1, 11.3.2, etc.)
- Add :::note box with collector requirements
- Add Related Sections with internal doc links
- Match styling pattern from other built-in-alerts files
Created a new documentation page for the netdata-claim.sh script to help
first-time users who log in to Netdata Cloud.

The page includes:
- Complete CLI options reference (verified against src/claim/netdata-claim.sh.in)
- Environment variables documentation (verified against source code)
- Exit codes with explanations (from kickstart.sh claim function)
- Docker/Kubernetes deployment examples
- Verification steps
- Troubleshooting guide

The page links to the main Connect Agent guide and other related documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.