README
¶
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.
User Guide
Follow the user guide for how to install and use the bbctl tool.
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
Automated usage over interactive usage
bbctl is primarily intended to be piped to/from other tools and shell scripts. Interactive use is a future possibility.
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
Upstream Release Notes
There is no upstream for this chart.
Learn More
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
| Key | Type | Default | Description |
|---|---|---|---|
| bigbang | object | {"addons":{"authservice":{"enabled":false,"values":{"selector":{"key":"protect","value":"keycloak"}}}},"domain":"bigbang.dev","istio":{"enabled":false,"hardened":{"enabled":false}},"monitoring":{"enabled":false},"networkPolicies":{"controlPlaneCidr":"0.0.0.0/0","controlPlaneNode":null,"enabled":false},"openshift":false} |
Passdown values from Big Bang |
| image.repository | string | "registry1.dso.mil/ironbank/big-bang/bbctl" |
|
| image.pullPolicy | string | "Always" |
|
| image.tag | string | "0.7.5" |
|
| yqImage.repository | string | "registry1.dso.mil/ironbank/opensource/yq/yq" |
|
| yqImage.pullPolicy | string | "Always" |
|
| yqImage.tag | string | "4.44.3" |
|
| registryCredentials.registry | string | "registry1.dso.mil" |
|
| registryCredentials.username | string | "" |
|
| registryCredentials.password | string | "" |
|
| registryCredentials.email | string | "" |
|
| imagePullSecrets[0].name | string | "private-registry" |
|
| nameOverride | string | "" |
|
| fullnameOverride | string | "" |
|
| serviceAccount.annotations | object | {} |
|
| serviceAccount.name | string | "" |
|
| podAnnotations | object | {} |
|
| podSecurityContext | object | {} |
|
| securityContext.capabilities.drop[0] | string | "ALL" |
|
| securityContext.readOnlyRootFilesystem | bool | true |
|
| securityContext.runAsNonRoot | bool | true |
|
| securityContext.runAsUser | int | 1000 |
|
| securityContext.runAsGroup | int | 1000 |
|
| resources | object | {} |
|
| nodeSelector | object | {} |
|
| tolerations | list | [] |
|
| affinity | object | {} |
|
| credentialsFile.credentials[0].uri | string | "registry1.dso.mil" |
|
| credentialsFile.credentials[0].username | string | "" |
|
| credentialsFile.credentials[0].password | string | "" |
|
| credentialsFile.credentials[1].uri | string | "repo1.dso.mil" |
|
| credentialsFile.credentials[1].username | string | "" |
|
| credentialsFile.credentials[1].password | string | "" |
|
| baseConfig.bbctl-log-add-source | bool | true |
|
| baseConfig.bbctl-log-format | string | "json" |
|
| baseConfig.bbctl-log-level | string | "warn" |
|
| baseConfig.bbctl-log-output | string | "stderr" |
|
| baseConfig.big-bang-repo | string | "https://repo1.dso.mil/big-bang/bigbang/-/blob/master/" |
|
| baseConfig.output-config.format | string | "json" |
|
| baseConfig.util-credential-helper.big-bang-credential-helper-credentials-file-path | string | "/home/bigbang/.bbctl/credentials.yaml" |
|
| baseConfig.util-credential-helper.big-bang-credential-helper | string | "credentials-file" |
|
| baseLabels | object | {} |
|
| bigbangUpdater.enabled | bool | true |
|
| bigbangUpdater.schedule | string | "0 * * * *" |
|
| bigbangUpdater.bigbangReleaseName | string | "bigbang" |
|
| bigbangUpdater.bigbangReleaseNamespace | string | "bigbang" |
|
| bigbangUpdater.labels | object | {} |
|
| bigbangUpdater.config | object | {} |
|
| bigbangUpdater.podAnnotations | object | {} |
|
| bigbangUpdater.serviceAccount.create | bool | true |
|
| bigbangUpdater.serviceAccount.annotations | object | {} |
|
| bigbangUpdater.serviceAccount.name | string | "" |
|
| bigbangStatus.enabled | bool | true |
|
| bigbangStatus.schedule | string | "0 * * * *" |
|
| bigbangStatus.bigbangReleaseName | string | "bigbang" |
|
| bigbangStatus.bigbangReleaseNamespace | string | "bigbang" |
|
| bigbangStatus.labels | object | {} |
|
| bigbangStatus.config | object | {} |
|
| bigbangStatus.podAnnotations | object | {} |
|
| bigbangStatus.serviceAccount.create | bool | true |
|
| bigbangStatus.serviceAccount.annotations | object | {} |
|
| bigbangStatus.serviceAccount.name | string | "" |
|
| bigbangViolations.enabled | bool | true |
|
| bigbangViolations.schedule | string | "0 * * * *" |
|
| bigbangViolations.bigbangReleaseName | string | "bigbang" |
|
| bigbangViolations.bigbangReleaseNamespace | string | "bigbang" |
|
| bigbangViolations.labels | object | {} |
|
| bigbangViolations.config | object | {} |
|
| bigbangViolations.podAnnotations | object | {} |
|
| bigbangViolations.serviceAccount.create | bool | true |
|
| bigbangViolations.serviceAccount.annotations | object | {} |
|
| bigbangViolations.serviceAccount.name | string | "" |
|
| bigbangPreflight.enabled | bool | true |
|
| bigbangPreflight.schedule | string | "0 * * * *" |
|
| bigbangPreflight.bigbangReleaseName | string | "bigbang" |
|
| bigbangPreflight.bigbangReleaseNamespace | string | "bigbang" |
|
| bigbangPreflight.labels | object | {} |
|
| bigbangPreflight.config | object | {} |
|
| bigbangPreflight.podAnnotations | object | {} |
|
| bigbangPreflight.serviceAccount.create | bool | true |
|
| bigbangPreflight.serviceAccount.annotations | object | {} |
|
| bigbangPreflight.serviceAccount.name | string | "" |
|
| bigbangPolicy.enabled | bool | true |
|
| bigbangPolicy.policyEnforcer | string | "kyverno" |
|
| bigbangPolicy.schedule | string | "0 * * * *" |
|
| bigbangPolicy.bigbangReleaseName | string | "bigbang" |
|
| bigbangPolicy.bigbangReleaseNamespace | string | "bigbang" |
|
| bigbangPolicy.labels | object | {} |
|
| bigbangPolicy.config | object | {} |
|
| bigbangPolicy.podAnnotations | object | {} |
|
| bigbangPolicy.serviceAccount.create | bool | true |
|
| bigbangPolicy.serviceAccount.annotations | object | {} |
|
| bigbangPolicy.serviceAccount.name | string | "" |
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.
Documentation
¶
There is no documentation for this package.
Source Files
¶
- main.go
Directories
Click to show internal directories.
Click to hide internal directories.