https://github.com/datum-cloud/telemetry-services-operator
Kubernetes Operator for managing Datum Cloud Telemetry Services
https://github.com/datum-cloud/telemetry-services-operator
Last synced: about 2 months ago
JSON representation
Kubernetes Operator for managing Datum Cloud Telemetry Services
- Host: GitHub
- URL: https://github.com/datum-cloud/telemetry-services-operator
- Owner: datum-cloud
- License: agpl-3.0
- Created: 2025-03-10T20:59:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-22T20:15:51.000Z (2 months ago)
- Last Synced: 2026-04-22T22:19:21.029Z (2 months ago)
- Language: Go
- Size: 334 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telemetry Services
The telemetry services operator is a Kubernetes operator designed to manage
telemetry-related configurations for projects on the Datum Cloud platform. It
provides a standardized way for users to configure and manage telemetry
exporters, ensuring seamless integration with third-party observability
platforms using OpenTelemetry.
## Getting Started
### Prerequisites
- go version v1.23.0+
- docker version 17.03+.
- kubectl version v1.11.3+.
- Access to a Kubernetes v1.11.3+ cluster.
### To Deploy on the cluster
**Build and push your image to the location specified by `IMG`:**
```sh
make docker-build docker-push IMG=/telemetry-services-operator:tag
```
**NOTE:** This image ought to be published in the personal registry you
specified. And it is required to have access to pull the image from the working
environment. Make sure you have the proper permission to the registry if the
above commands don’t work.
**Install the CRDs into the cluster:**
```sh
make install
```
**Deploy the Manager to the cluster with the image specified by `IMG`:**
```sh
make deploy IMG=/telemetry-services-operator:tag
```
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself
cluster-admin privileges or be logged in as admin.
**Create instances of your solution** You can apply the samples (examples) from
the config/sample:
```sh
kubectl apply -k config/samples/
```
>**NOTE**: Ensure that the samples has default values to test it out.
### To Uninstall
**Delete the instances (CRs) from the cluster:**
```sh
kubectl delete -k config/samples/
```
**Delete the APIs(CRDs) from the cluster:**
```sh
make uninstall
```
**UnDeploy the controller from the cluster:**
```sh
make undeploy
```
## Project Distribution
Following the options to release and provide this solution to the users.
### By providing a bundle with all YAML files
1. Build the installer for the image built and published in the registry:
```sh
make build-installer IMG=/telemetry-services-operator:tag
```
**NOTE:** The makefile target mentioned above generates an 'install.yaml' file
in the dist directory. This file contains all the resources built with
Kustomize, which are necessary to install this project without its dependencies.
2. Using the installer
Users can just run 'kubectl apply -f ' to install the
project, i.e.:
```sh
kubectl apply -f https://raw.githubusercontent.com//telemetry-services-operator//dist/install.yaml
```
### By providing a Helm Chart
1. Build the chart using the optional helm plugin
```sh
kubebuilder edit --plugins=helm/v1-alpha
```
2. See that a chart was generated under 'dist/chart', and users can obtain this
solution from there.
**NOTE:** If you change the project, you need to update the Helm Chart using the
same command above to sync the latest changes. Furthermore, if you create
webhooks, you need to use the above command with the '--force' flag and manually
ensure that any custom configuration previously added to
'dist/chart/values.yaml' or 'dist/chart/manager/manager.yaml' is manually
re-applied afterwards.
---
**NOTE:** Run `make help` for more information on all potential `make` targets
More information can be found via the [Kubebuilder
Documentation](https://book.kubebuilder.io/introduction.html)