{"id":13566572,"url":"https://github.com/2-alchemists/krossboard","last_synced_at":"2025-04-04T00:31:11.622Z","repository":{"id":104891163,"uuid":"492756953","full_name":"2-alchemists/krossboard","owner":"2-alchemists","description":"Krossboard is a Kubernetes Operator designed to provide comprehensive usage tracking, analytics, and accounting across diverse Kubernetes environments. It supports cross-site and cross-distribution management (e.g., vanilla Kubernetes, OpenShift, EKS, AKS, GKE, and other distributions)","archived":false,"fork":false,"pushed_at":"2025-03-18T22:16:48.000Z","size":491,"stargazers_count":62,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-03T18:41:15.494Z","etag":null,"topics":["analytics-tracking","kubernetes","kubernetes-operator","resource-usage-tracking","usage-based-billing"],"latest_commit_sha":null,"homepage":"https://krossboard.app","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/2-alchemists.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-16T08:58:06.000Z","updated_at":"2025-03-19T07:32:53.000Z","dependencies_parsed_at":"2024-01-14T03:45:38.723Z","dependency_job_id":"80fa7a0d-3108-4c9b-8f73-84115149d769","html_url":"https://github.com/2-alchemists/krossboard","commit_stats":null,"previous_names":["2-alchemists/krossboard"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2-alchemists%2Fkrossboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2-alchemists%2Fkrossboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2-alchemists%2Fkrossboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2-alchemists%2Fkrossboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/2-alchemists","download_url":"https://codeload.github.com/2-alchemists/krossboard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247103306,"owners_count":20884023,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics-tracking","kubernetes","kubernetes-operator","resource-usage-tracking","usage-based-billing"],"created_at":"2024-08-01T13:02:12.267Z","updated_at":"2025-04-04T00:31:11.616Z","avatar_url":"https://github.com/2-alchemists.png","language":"Go","funding_links":[],"categories":["Shell","Go"],"sub_categories":[],"readme":"[![lint](https://img.shields.io/github/actions/workflow/status/2-alchemists/krossboard-kubernetes-operator/lint.yml?label=Lint\u0026style=for-the-badge\u0026logo=github)](https://github.com/2-alchemists/krossboard-kubernetes-operator/actions/workflows/lint.yml)\n![license](https://img.shields.io/github/license/2-alchemists/krossboard-kubernetes-operator.svg?label=License\u0026style=for-the-badge)\n\n---\n\n\u003c!-- vscode-markdown-tkubectl --\u003e\n- [What is Krossboard](#what-is-krossboard)\n- [Deploy Krossboard](#deploy-krossboard)\n- [Create a Krossboard Instance](#deploy-a-krossboard-instance)\n  - [Create a Krossboard CR](#create-a-krossboard-cr)\n  - [Create a KUBECONFIG secret for target Kubernetes](#create-a-kubeconfig-secret-for-target-kubernetes)\n  - [Start the Krossboard Instance](#start-the-krossboard-instance)\n- [Day2 Operations](#day2-operations)\n\n\u003c!-- vscode-markdown-toc-config\n\tnumbering=false\n\tautoSave=true\n\t/vscode-markdown-toc-config --\u003e\n\u003c!-- /vscode-markdown-tkubectl --\u003e\n\n# What is Krossboard\n\nKrossboard is a Kubernetes Operator designed to provide comprehensive usage tracking, analytics, and accounting across diverse Kubernetes environments. It supports cross-site deployments (e.g., geographically dispersed clusters) and cross-distribution management (e.g., vanilla Kubernetes, OpenShift, EKS, AKS, GKE, and other distributions).\n\nKrossboard enables enterprises to gain insights into resource consumption, perform cost analysis, and centralize monitoring across multiple Kubernetes clusters. For example, it helps manage resource usage across multiple cloud providers and provides detailed cost analysis for hybrid deployments. Check out the documentation for more details.\n\n![](krossboard-architecture-overview.png)\n\n\nOnce the Operator installed, the [Krossboard CR](https://raw.githubusercontent.com/2-alchemists/krossboard-kubernetes-operator/main/config/releases/latest/krossboard/krossboard-kubernetes-operator.yaml) allows to define 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.\n\nEach instance of Krossboard enables to track the usage of a set of Kubernetes clusters listed in a KUBECONFIG secret.\n\nThe next steps describe how to deploy the operator and a Krossboard instance.\n\n\u003e Learn more about [Krossboard Features](./docs/what-is-krossboard.md)\n\n# \u003ca name='DeployKrossboardOperator'\u003e\u003c/a\u003eDeploy Krossboard\nThe following command deploy the latest version of Krossboard Operator.\n\n```bash\nkubectl apply -f https://raw.githubusercontent.com/2-alchemists/krossboard-kubernetes-operator/main/config/releases/latest/krossboard/krossboard-kubernetes-operator.yaml\n```\n\nThe installation is achieved in a namespace named `krossboard`.\n\n# \u003ca name='DeployaKrossboardInstance'\u003e\u003c/a\u003eDeploy a Krossboard Instance\n\n## \u003ca name='CreateaKrossboardCR'\u003e\u003c/a\u003eCreate a Krossboard CR\n\nOnce the operator deployed, a custom resource named `Krossboard` is created. This CR is used to define each instance of Krossboard.\n\nSee [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.\n\n```yaml\n---\napiVersion: krossboard.krossboard.app/v1alpha1\nkind: Krossboard\nmetadata:\n  name: krossboard\n  namespace: krossboard\nspec:\n  koaImage: rchakode/kube-opex-analytics:25.03.1\n  krossboardDataProcessorImage: krossboard/krossboard-data-processor:1.3.0\n  krossboardUIImage: krossboard/krossboard-ui:1.2.2-d49718c\n  krossboardPersistentVolumeClaim: krossboard-data-pvc\n  krossboardSecretName: krossboard-secrets\n---\napiVersion: v1\nkind: PersistentVolumeClaim\nmetadata:\n  name: krossboard-data-pvc\n  namespace: krossboard\nspec:\n  accessModes:\n    - ReadWriteOnce\n  resources:\n    requests:\n      storage: 1Gi\n#  storageClassName: uncomment-and-set-if-not-using-default\n```\n\nEach instance of Krossboard allows to track the usage of a set of Kubernetes clusters listed in a KUBECONFIG secret. \n\n* The secret name is set by the parameter `krossboardSecretName` (default is `krossboard-secrets`).\n* The secret key is `kubeconfig`. \n\n## \u003ca name='CreateaKUBECONFIGsecretfortargetKubernetes'\u003e\u003c/a\u003eCreate a KUBECONFIG secret for target Kubernetes\nGiven a KUBECONFIG resource (`/path/to/kubeconfig` in the below command), you can create a secret for Krossboard Operator as follows. \n\n```bash\nkubectl -n krossboard \\\n    create secret --type=Opaque generic krossboard-secrets \\\n    --from-file=kubeconfig=/path/to/kubeconfig\n```\n\n\u003e * Learn how to [Create a KUBECONFIG resource with minimal permissions for Krossboard](./docs/create-kubeconfig-with-minimal-permissions.md).\n\u003e * Learn how to [Create a secret from several KUBECONFIG resources](./docs/create-kubeconfig-secret.md)\n\n\n## \u003ca name='StarttheKrossboardInstance'\u003e\u003c/a\u003eStart the Krossboard Instance\nThe below command deploys an instance of Krossboard based on the latest version.\n\n```bash\nkubectl -n krossboard apply -f https://raw.githubusercontent.com/2-alchemists/krossboard-kubernetes-operator/main/config/releases/latest/krossboard/krossboard-deployment.yaml\n```\n\nOnce started, the instance enables access to two Kubernetes services:\n\n* `krossboard-ui.krossboard.svc` enabling access to Krossboard UI.\n* `krossboard-api.krossboard.svc` enabling access to Krossboard REST API.\n\n# Day2 Operations\n\n* https://krossboard.app/\n* [Krossboard Enterprise Support](https://krossboard.app/#pricing) \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2-alchemists%2Fkrossboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F2-alchemists%2Fkrossboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2-alchemists%2Fkrossboard/lists"}