gatekeeper

command module
v0.0.0-...-e905678 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 23, 2018 License: Apache-2.0 Imports: 1 Imported by: 0

README

GΛTEKEEPER


Gatekeeper is an open source system for interacting with secrets in AWS Secrets Manager; providing basic mechanisms for creation, and rotation of secrets.

To start using Gatekeeper

Download Gatekeeper - Linux, MacOS and Windows

Please download the proper package for your operating system and architecture. You can find the SHA256 checksums for Gatekeeper here and you can verify the checksums signature file which has been signed using AXOE's GPG key.

Overview

Gatekeeper is built on cobra and utilises a structure of commands, arguments & flags. It supports Fully POSIX-compliant flags (including short & long versions)

Requirements

Gatekeeper uses the AWS_PROFILE environment variable


Commands

ls - List secrets in a specific region:

gatekeeper ls --region eu-west-2

get - Get the value of a secret:

gatekeeper get --secret nameofsecret --region eu-west-2

add - Add a new secret:

gatekeeper add --name nameofsecret --region eu-west-2 --description "exampledescription" --value "{\"username\":\"foo\",\"password\":\"bar\"}"

update - Update a secret:

gatekeeper update --secret nameofsecret --region eu-west-2 --value "{\"username\":\"foo\",\"password\":\"foobar\"}"

del - Delete a secret:

gatekeeper del --secret nameofsecret --region eu-west-2

To start developing Gatekeeper

This repository hosts all information about building Gatekeeper from source, how to contribute code and documentation.

If you want to build Gatekeeper right away there are two options:

You have a working [Go environment].
$ go get -d github.com/axoe/gatekeeper
$ cd $GOPATH/src/github.com/axoe/gatekeeper
$ gatekeeper
You have a working [Docker environment].
Build:
$ git clone https://github.com/axoe/gatekeeper
$ cd gatekeeper
$ docker build -t gatekeeper .

Run Gatekeeper in Docker

By default the Docker image does not have an ENTRYPOINT set. Uncomment the last line on the Dockerfile to launch Gatekeeper when the container starts

Run:
$ docker run -it gatekeeper

Once you are inside the container you need to export your AWS ACCESS KEYS

/# export AWS_ACCESS_KEY_ID=AKIAXXXXXXXXXX
/# export AWS_SECRET_ACCESS_KEY=XxXxXxXXXX
/# gatekeeper ls --region eu-west-2

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL