bbctl

bbctl as a helm chart for partial automated management of Big Bang.

Introduction

bbctl is a command line interface (CLI) tool to simplify development, deployment, auditing, and maintaining the deployment of Big Bang a kubernetes cluster.

This repository is for the bbctl chart. For bbctl application, development please refer to: https://repo1.dso.mil/big-bang/apps/developer-tools/bbctl.

Developer Documentation

Help Contribute! See the developer documentation. The CLI tool is developed in Go language and uses the cobra library to implement commands.

bbctl Usage and Design Priorities

Multiple execution contexts

bbctl will be running as a cronjob in cluster, possibly as web server in cluster, potentially in pipelines, and on developer machines.

External and internal users

bbctl is currently used both inside and outside the Big Bang team as a fully open source project.

Upstream References

• https://repo1.dso.mil/big-bang/product/packages/bbctl
• https://repo1.dso.mil/big-bang/product/packages/bbctl

Upstream Release Notes

There is no upstream for this chart. Application development for bbctl is done in this repository: https://repo1.dso.mil/big-bang/apps/developer-tools/bbctl.

Learn More

• Application Overview
• Other Documentation

Pre-Requisites

• Kubernetes Cluster deployed
• Kubernetes config installed in ~/.kube/config
• Helm installed

Install Helm

https://helm.sh/docs/intro/install/

Deployment

• Clone down the repository
• cd into directory

helm install bbctl chart/

Values

Please see the values docs.

Contributing

Please see the contributing guide if you are interested in contributing.

---

This file is programatically generated using helm-docs and some BigBang-specific templates. The gluon repository has instructions for regenerating package READMEs.