Edge Orchestrator Observability Charts

Overview

Edge Orchestrator Observability Charts provide key Observability charts deployable on Edge Orchestrator:

• Edge Node Observability Stack along with Edge Node Observability Dashboards
• Orchestrator Observability Stack along with Orchestrator Observability Dashboards

Additionally, the charts utilize customized applications to handle multi-tenancy aspects:

• Grafana Proxy
• OpenTelemetry Collector

Read more about Edge Orchestrator Observability Charts in the Documentation.

Get Started

This repository consists of several projects located in the apps and charts directories. If these commands are run in the main repository directory, they will be executed for all projects. To run them for a specific project, execute the commands in the project's directory, e.g., charts/edgenode-dashboards.

To set up the development environment and work on this project, follow the steps below. All necessary tools will be installed using the install-tools target. Note that docker and asdf must be installed beforehand.

Develop

The code of this project is maintained and released in CI using the VERSION file. In addition, the chart is versioned with the same tag as the VERSION file.

This is mandatory to keep all chart versions and app versions coherent.

To bump the version, increment the version in the VERSION file and run the following command (to set version and appVersion in the Chart.yaml automatically):

make helm-build

Install Tools

To install all the necessary tools needed for development the project, run:

make install-tools

Build

To build the project, use the following command:

make build

Lint

To lint the code and ensure it adheres to the coding standards, run:

make lint

Test

To run the tests and verify the functionality of the project, use:

make test

Docker Build

To build the Docker image for the project, run:

make docker-build

Helm Build

To package the Helm chart for the project, use:

make helm-build

Docker Push

To push the Docker image to the registry, run:

make docker-push

Helm Push

To push the Helm chart to the repository, use:

make helm-push

Kind All

To load the Docker image into a local Kind cluster, run:

make kind-all

Contribute

To learn how to contribute to the project, see the Contributor's Guide.

Community and Support

To learn more about the project, its community, and governance, visit the Edge Orchestrator Community.

For support, start with Troubleshooting or Contact us.

License

Edge Orchestrator Observability Charts is licensed under Apache 2.0 License.

Last Updated Date: {March 28, 2025}