Installation prerequisites
Review and complete the following prerequisites before installing Chronosphere Telemetry Pipeline.
Operating system requirements
Telemetry Pipeline installations have specific operating system requirements. Review this page for your specific installation type to ensure compatibility.
Telemetry Pipeline deploys a local K3s (opens in a new tab) cluster as part of the installation, which must be supported on the target node. Refer to the K3s requirements (opens in a new tab) in the K3 documentation for the most up-to-date information.
Linux installation health checks
For Linux-based installations, Telemetry Pipeline performs the following health checks:
- Checks for
curl
- Checks for
systemctl
- Ensures the system meets the basic requirements
- Checks that Federal Information Processing Standards (FIPS) mode isn't enabled
- Checks that a firewall isn't enabled
- Tests connectivity to https://cloud-api.calyptia.com (opens in a new tab)
- Tests connectivity to https://ghcr.io/calyptia/core (opens in a new tab)
- Checks SELinux status
If the checks find an issue, an error message outputs to the console. See Troubleshoot Telemetry Pipeline installations on Linux servers for additional help.
Networking and firewall requirements
Telemetry Pipeline is deployed by container images hosted on GitHub container registry.
If your organization uses outbound firewall rules, you might need to allow the following ports and URLs.
All of the listed URLs use the TCP protocol and port 443.
API endpoint
The main API endpoint for Telemetry Pipeline, which is used for configuration.
cloud-api.calyptia.com
Web interface URL
URL for the Telemetry Pipeline web interface.
core.calyptia.com
Helm charts
Used for the Helm charts for installing and managing Telemetry Pipeline.
helm.calyptia.com
Installation script
Used for the install-core.sh
scripts for VMs or bare metal packages.
core-packages.calyptia.com
Download links
Ensures Telemetry Pipeline download links are accessible to the enterprise.
ghcr.io/calyptia
Registry tokens
Contains the tokens required from the GitHub container registry.
ghcr.io/token?scope=repository:calyptia/core:pull&service=ghcr.io ghcr.io/token?scope=repository:calyptia/core/calyptia-fluent-bit:pull&service=ghcr.io
Manifest and container images
Contains the manifest and container images required from the GitHub container registry.
http://ghcr.io/v2/calyptia/core/manifests/latest
Image layers
Contains the image layers when applying latest updates.
pkg-containers.githubusercontent.com/objects.githubusercontent.com
Authenticate with Chronosphere
You must create an API token to authenticate with Chronosphere. You include the value of this API token when installing Core Operator using either Pipeline CLI or Helm, and when installing Core Instance with the Pipeline CLI.
If you install Core Instance with the Telemetry Pipeline web interface, an API token is generated automatically for you.
To generate an API token:
-
Sign in to the Telemetry Pipeline web interface (opens in a new tab).
-
In the navigation menu select Settings.
-
In the Generate API key section, enter a name for your new API key, and then click Generate.
-
Run the following command in Pipeline CLI:
calyptia config set_token KEY
Replace
KEY
with the value of the API key you generated in the previous step.