Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2-alchemists/krossboard-kubernetes-operator
Kubernetes Operator to handle cross-site, cross-distribution & multi-Kubernetes usage tracking, analytics and accounting (vanilla Kubernetes, OpenShift, EKS, AKS, GKE and other distros).
https://github.com/2-alchemists/krossboard-kubernetes-operator
analytics-tracking kubernetes kubernetes-operator resource-usage-tracking usage-based-billing
Last synced: 3 months ago
JSON representation
Kubernetes Operator to handle cross-site, cross-distribution & multi-Kubernetes usage tracking, analytics and accounting (vanilla Kubernetes, OpenShift, EKS, AKS, GKE and other distros).
- Host: GitHub
- URL: https://github.com/2-alchemists/krossboard-kubernetes-operator
- Owner: 2-alchemists
- License: agpl-3.0
- Created: 2022-05-16T08:58:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-04T07:35:18.000Z (7 months ago)
- Last Synced: 2024-06-08T01:34:48.653Z (5 months ago)
- Topics: analytics-tracking, kubernetes, kubernetes-operator, resource-usage-tracking, usage-based-billing
- Language: Go
- Homepage: https://krossboard.app
- Size: 466 KB
- Stars: 60
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ccamel - 2-alchemists/krossboard-kubernetes-operator - Kubernetes Operator to handle cross-site, cross-distribution & multi-Kubernetes usage tracking, analytics and accounting (vanilla Kubernetes, OpenShift, EKS, AKS, GKE and other distros). (Go)
README
[](https://github.com/2-alchemists/krossboard-kubernetes-operator/actions/workflows/lint.yml)
---
- [What is Krossboard Kubernetes Operator](#what-is-krossboard-kubernetes-operator)
- [Deploy Krossboard Kubernetes Operator](#deploy-krossboard-kubernetes-operator)
- [Deploy a Krossboard Instance](#deploy-a-krossboard-instance)
- [Create a Krossboard CR](#create-a-krossboard-cr)
- [Create a KUBECONFIG secret for target Kubernetes](#create-a-kubeconfig-secret-for-target-kubernetes)
- [Start the Krossboard Instance](#start-the-krossboard-instance)
- [Day2 Operations](#day2-operations)
# What is Krossboard Kubernetes Operator
[Krossboard](https://www.krossboard.app/) is a multi-cluster and cross-distribution Kubernetes usage accounting and analytics software.
> Learn more about [Krossboard Features](./docs/what-is-krossboard.md)
Krossboard Kubernetes Operator provides custom resources (CR) along with an operator to deploy and manage instances of Krossboard as Kubernetes pods.
The [Krossboard CR](https://raw.githubusercontent.com/2-alchemists/krossboard-kubernetes-operator/main/config/releases/latest/krossboard/krossboard-kubernetes-operator.yaml) defines a Krossboard instance as a Kind, as well as parameters to bootstrap that instance: krossboard-api, krossboard-ui, krossboard-consolidator, krossboard-kubeconfig-handler, kube-opex-analytics instances.
Each instance of Krossboard enables to track the usage of a set of Kubernetes clusters listed in a KUBECONFIG secret.
The next steps describe how to deploy the operator and a Krossboard instance.
# Deploy Krossboard Kubernetes Operator
The following command deploy the latest version of Krossboard Operator.
```bash
kubectl apply -f https://raw.githubusercontent.com/2-alchemists/krossboard-kubernetes-operator/main/config/releases/latest/krossboard/krossboard-kubernetes-operator.yaml
```
The installation is achieved in a namespace named `krossboard`.
# Deploy a Krossboard Instance
Once the operator deployed, a custom resource named `Krossboard` is created. This CR is used to define each instance of Krossboard.
See [krossboard.yaml](https://github.com/2-alchemists/krossboard-kubernetes-operator/blob/main/config/releases/latest/krossboard/krossboard.yaml) for an example to a Krossboard instance along with its persistent volume claim.
```yaml
---
apiVersion: krossboard.krossboard.app/v1alpha1
kind: Krossboard
metadata:
name: krossboard
namespace: krossboard
spec:
koaImage: rchakode/kube-opex-analytics:24.03.3
krossboardDataProcessorImage: krossboard/krossboard-data-processor:1.3.0
krossboardUIImage: krossboard/krossboard-ui:1.2.2-d49718c
krossboardPersistentVolumeClaim: krossboard-data-pvc
krossboardSecretName: krossboard-secrets
---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: krossboard-data-pvc
namespace: krossboard
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
# storageClassName: uncomment-and-set-if-not-using-default
```
Each instance of Krossboard allows to track the usage of a set of Kubernetes clusters listed in a KUBECONFIG secret.
* The secret name is set by the parameter `krossboardSecretName` (default is `krossboard-secrets`).
* The secret key is `kubeconfig`.
## Create a KUBECONFIG secret for target Kubernetes
Given a KUBECONFIG resource (`/path/to/kubeconfig` in the below command), you can create a secret for Krossboard Operator as follows.
```bash
kubectl -n krossboard \
create secret --type=Opaque generic krossboard-secrets \
--from-file=kubeconfig=/path/to/kubeconfig
```
> * Learn how to [Create a KUBECONFIG resource with minimal permissions for Krossboard](./docs/create-kubeconfig-with-minimal-permissions.md).
> * Learn how to [Create a secret from several KUBECONFIG resources](./docs/create-kubeconfig-secret.md)
## Start the Krossboard Instance
The below command deploys an instance of Krossboard based on the latest version.
```bash
kubectl -n krossboard apply -f https://raw.githubusercontent.com/2-alchemists/krossboard-kubernetes-operator/main/config/releases/latest/krossboard/krossboard-deployment.yaml
```
Once started, the instance enables access to two Kubernetes services:
* `krossboard-ui.krossboard.svc` enabling access to Krossboard UI.
* `krossboard-api.krossboard.svc` enabling access to Krossboard REST API.
# Day2 Operations
* https://krossboard.app/
* [Krossboard Enterprise Support](https://krossboard.app/#pricing)