binnacle is an opinionated automation tool used to interact with Kubernetes' Helm. By offering a single file to manage one or many charts, you can easily control all aspects of your Helm managed applications.
binnacle is similar in nature to Helmfile with a slightly different approach to managing Helm Charts.
A binary for various operating systems is available through Github Releases. Download the appropriate archive, and extract into a directory within your PATH.
For the full list of options:
binnacle --helpTo see the version of binnacle you can use the following:
binnacle --versionConfiguration files can be written in YAML, TOML or JSON.
---
# charts takes a list of chart configurations
charts:
# This is the name of the chart
- name: concourse
# This is the namespace into which the chart is launched
namespace: apps
# This is the name for the release of this chart
release: apps-concourse
# This is the name of the repository within which the helm chart is located
repo: stable
# This determines if the release is created or removed. Default: present Options: absent, present
state: present
# Any data under values are passed to Helm to configure the given chart
values:
image: concourse/concourse
imageTag: "3.10.0"
# This is the version of the Helm chart. If this is omitted, the latest is used.
version: 1.3.1
# repositories takes a list of repository configurations
repositories:
# This is the name of the repository
- name: stable
# This is the URL of the repository
url: https://kubernetes-charts.storage.googleapis.com
# This determines if the repository is created or removed. Default: present Options: absent, present
state: presentThe standard workflow when using binnacle is to use the template command to verify the desired configuration files are generated, use the sync command to create/update the existing release configuration within Helm, and status to get the status of a release.
Using the configuration available at test-data/demo.yml you can run the template command:
$ binnacle template -c ./test-data/demo.yml
Loading config file: ./test-data/demo.yml
---
# Source: concourse/templates/namespace.yaml
---
apiVersion: v1
kind: Namespace
metadata:
annotations:
"helm.sh/resource-policy": keep
name: apps-concourse-main
labels:
...By reviewing the output you are able to verify that you have specificied all of the necessary configuration aspects of the chart. Once you are happy with how the chart is configured you can sync the charts to Helm:
$ binnacle sync -c ./test-data/demo.yml
Loading config file: ./test-data/demo.yml
"stable" has been added to your repositories
Release "apps-concourse" does not exist. Installing it now.
NAME: apps-concourse
LAST DEPLOYED: Fri Apr 27 14:24:19 2018
NAMESPACE: apps
STATUS: DEPLOYED
RESOURCES:
==> v1beta1/StatefulSet
NAME DESIRED CURRENT AGE
apps-concourse-worker 2 0 1s
==> v1/Pod(related)
NAME READY STATUS RESTARTS AGE
apps-concourse-postgresql-5f964dd587-6ng8f 0/1 Pending 0 1s
apps-concourse-web-5dd649b7f6-7v78w 0/1 ContainerCreating 0 1s
==> v1/Namespace
NAME STATUS AGE
apps-concourse-main Active 1s
==> v1/Secret
NAME TYPE DATA AGE
apps-concourse-postgresql Opaque 1 1s
apps-concourse-concourse Opaque 7 1s
==> v1/PersistentVolumeClaim
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
apps-concourse-postgresql Pending 1s
==> v1beta1/ClusterRole
NAME AGE
apps-concourse-web 1s
==> v1/Service
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
apps-concourse-postgresql ClusterIP 10.233.89.90 <none> 5432/TCP 1s
apps-concourse-web ClusterIP 10.233.57.192 <none> 8080/TCP,2222/TCP 1s
apps-concourse-worker ClusterIP None <none> <none> 1s
==> v1/ServiceAccount
NAME SECRETS AGE
apps-concourse-web 1 1s
apps-concourse-worker 1 1s
==> v1beta1/Role
NAME AGE
apps-concourse-worker 1s
==> v1beta1/RoleBinding
NAME AGE
apps-concourse-web-main 1s
apps-concourse-worker 1s
==> v1beta1/Deployment
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
apps-concourse-postgresql 1 1 1 0 1s
apps-concourse-web 1 1 1 0 1s
==> v1beta1/PodDisruptionBudget
NAME MIN AVAILABLE MAX UNAVAILABLE ALLOWED DISRUPTIONS AGE
apps-concourse-worker 1 N/A 0 1s
NOTES:
* Concourse can be accessed:
* Within your cluster, at the following DNS name at port 8080:
apps-concourse-web.apps.svc.cluster.local
* From outside the cluster, run these commands in the same shell:
export POD_NAME=$(kubectl get pods --namespace apps -l "app=apps-concourse-web" -o jsonpath="{.items[0].metadata.name}")
echo "Visit http://127.0.0.1:8080 to use Concourse"
kubectl port-forward --namespace apps $POD_NAME 8080:8080
* Login with the following credentials
Username: concourse
Password: concourse
* If this is your first time using Concourse, follow the tutorial at https://concourse-ci.org/hello-world.html
*******************
******WARNING******
*******************
You are using the "naive" baggage claim driver, which is also the default value for this chart. This is the default for compatibility reasons, but is very space inefficient, and should be changed to either "btrfs" (recommended) or "overlay" depending on that filesystem's support in the Linux kernel your cluster is using. Please see https://github.com/concourse/concourse/issues/1230 and https://github.com/concourse/concourse/issues/1966 for background.From the output you can see that the release did not exist "apps-concourse" so Helm created it. To get updates on the status of the deployment you can use the status command:
$ binnacle status -c ./test-data/demo.yml
Loading config file: ./test-data/demo.yml
LAST DEPLOYED: Fri Apr 27 14:24:19 2018
NAMESPACE: apps
STATUS: DEPLOYED
RESOURCES:
==> v1/Pod(related)
NAME READY STATUS RESTARTS AGE
apps-concourse-postgresql-5f964dd587-6ng8f 0/1 Pending 0 1m
apps-concourse-web-5dd649b7f6-7v78w 0/1 Running 0 1m
==> v1/Namespace
NAME STATUS AGE
apps-concourse-main Active 1m
==> v1/Secret
NAME TYPE DATA AGE
apps-concourse-postgresql Opaque 1 1m
apps-concourse-concourse Opaque 7 1m
==> v1beta1/Role
NAME AGE
apps-concourse-worker 1m
==> v1/Service
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
apps-concourse-postgresql ClusterIP 10.233.89.90 <none> 5432/TCP 1m
apps-concourse-web ClusterIP 10.233.57.192 <none> 8080/TCP,2222/TCP 1m
apps-concourse-worker ClusterIP None <none> <none> 1m
==> v1beta1/PodDisruptionBudget
NAME MIN AVAILABLE MAX UNAVAILABLE ALLOWED DISRUPTIONS AGE
apps-concourse-worker 1 N/A 0 1m
==> v1beta1/StatefulSet
NAME DESIRED CURRENT AGE
apps-concourse-worker 2 2 1m
==> v1/PersistentVolumeClaim
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE
apps-concourse-postgresql Pending 1m
==> v1/ServiceAccount
NAME SECRETS AGE
apps-concourse-web 1 1m
apps-concourse-worker 1 1m
==> v1beta1/ClusterRole
NAME AGE
apps-concourse-web 1m
==> v1beta1/RoleBinding
NAME AGE
apps-concourse-web-main 1m
apps-concourse-worker 1m
==> v1beta1/Deployment
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
apps-concourse-postgresql 1 1 1 0 1m
apps-concourse-web 1 1 1 0 1m
NOTES:
* Concourse can be accessed:
* Within your cluster, at the following DNS name at port 8080:
apps-concourse-web.apps.svc.cluster.local
* From outside the cluster, run these commands in the same shell:
export POD_NAME=$(kubectl get pods --namespace apps -l "app=apps-concourse-web" -o jsonpath="{.items[0].metadata.name}")
echo "Visit http://127.0.0.1:8080 to use Concourse"
kubectl port-forward --namespace apps $POD_NAME 8080:8080
* Login with the following credentials
Username: concourse
Password: concourse
* If this is your first time using Concourse, follow the tutorial at https://concourse-ci.org/hello-world.html
*******************
******WARNING******
*******************
You are using the "naive" baggage claim driver, which is also the default value for this chart. This is the default for compatibility reasons, but is very space inefficient, and should be changed to either "btrfs" (recommended) or "overlay" depending on that filesystem's support in the Linux kernel your cluster is using. Please see https://github.com/concourse/concourse/issues/1230 and https://github.com/concourse/concourse/issues/1966 for background.If you want to remove a release, you can change the state from present to absent and run the sync command:
$ binnacle sync -c ./test-data/demo.yml
Loading config file: ./test-data/demo.yml
"stable" has been added to your repositories
These resources were kept due to the resource policy:
[Namespace] apps-concourse-main
release "apps-concourse" deletedPrerequisites:
- go 1.17
First, check out the repository:
git clone https://github.com/Traackr/binnacle.git
cd binnacle
To compile a version of binnacle for your local machine you can run:
make build
This will generate a binary within the ./bin directory of the project.
To run the unit tests:
make test