vouch4cluster

README

vouch4cluster 🎟☁️

vouch4cluster is a tool for running voucher against all of the images running in a cluster or deployment.

Installing

Install using:

$ go get -u github.com/Shopify/vouch4cluster

Using vouch4cluster

Configuration

vouch4cluster is configured using either json, yaml, or toml. By default, vouch4cluster loads from ~/.vouch4cluster.{json,yaml,toml}, but you can also specify the configuration to read from with the --config flag.

Below are the configuration options for vouch4cluster:

Group	Key	Description
voucher	hostname	The address of the Voucher instance to connect to.
voucher	username	The username to connect as.
voucher	password	The password to authenticate with.

For example, a json encoded version of this configuration may look like this:

{
   "voucher": {
       "hostname": "https://<voucher address>",
       "username": "<username>", 
       "password": "<password>"
   }
}

vouch4cluster supports the following flags:

Flag	Short Flag	Description
--config		The path to a configuration file that should be used.
--voucher		The address of the Voucher instance to connect to.
--username		The username to connect as.
--password		The password to authenticate with.

Attest all images in the current Kubernetes context

To attest all images in the current Kubernetes context, use:

$ vouch4cluster kube

This will query kubernetes for all of the active images, and then run each image through voucher. By default, this uses $HOME/.kube/config.

vouch4cluster supports the following flags, in addition to the global flags described in Configuration:

Flag	Short Flag	Description
--kubeconfig	-k	The path to the Kubernetes configuration that should be used.

Attest all images from a file

If you have a list of images that need to be attested, you can put them in a file, newline separated, and pass that file to vouch4cluster. By default, vouch4cluster will read from standard input.

$ vouch4cluster reader < input

This will iterate through each line in the file, and run each image through voucher.

Contributing

Please take a look at the Contributing document if you're interested in contributing code back to vouch4cluster!