Giter Club home page Giter Club logo

luis-sousa-pinto / krossboard-kubernetes-operator Goto Github PK

View Code? Open in Web Editor NEW

This project forked from 2-alchemists/krossboard-kubernetes-operator

0.0 0.0 0.0 462 KB

Kubernetes Operator to handle cross-site, cross-distribution & multi-clusters Kubernetes usage tracking, analytics and accounting (vanilla Kubernetes, OpenShift, EKS, AKS, GKE, and more).

Home Page: https://krossboard.app

License: GNU Affero General Public License v3.0

Shell 6.33% Go 70.31% Makefile 21.74% Dockerfile 1.62%

krossboard-kubernetes-operator's Introduction

license

What is Krossboard Kubernetes Operator

Krossboard is a multi-cluster and cross-distribution Kubernetes usage accounting and analytics software.

Learn more about Krossboard Features | Online Live Demo (no registration required).

Krossboard Kubernetes Operator provides custom resources (CR) along with an operator to deploy and manage instances of Krossboard as Kubernetes pods.

The Krossboard CR 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.

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

Create a Krossboard CR

Once the operator deployed, a custom resource named Krossboard is created. This CR is used to define each instance of Krossboard.

See krossboard.yaml for an example of Krossboard instance

apiVersion: krossboard.krossboard.app/v1alpha1
kind: Krossboard
metadata:
  name: krossboard
spec:
  koaImage: rchakode/kube-opex-analytics:22.12.0
  krossboardDataProcessorImage: krossboard/krossboard-data-processor:1.3.0
  krossboardUIImage: krossboard/krossboard-ui:1.2.0-49b2666
  krossboardPersistentVolumeClaim: krossboard-data-pvc
  krossboardSecretName: krossboard-secrets

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.

kubectl -n krossboard \
    create secret --type=Opaque generic krossboard-secrets \
    --from-file=kubeconfig=/path/to/kubeconfig

Start the Krossboard Instance

The below command deploys an instance of Krossboard based on the latest version.

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

krossboard-kubernetes-operator's People

Contributors

ccamel avatar rchakode avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.