https://github.com/cipherboy/devbao

Development environment for starting OpenBao (Vault) instances
https://github.com/cipherboy/devbao

Last synced: about 2 months ago
JSON representation

Development environment for starting OpenBao (Vault) instances

• Host: GitHub
• URL: https://github.com/cipherboy/devbao
• Owner: openbao
• License: mpl-2.0
• Created: 2024-02-10T14:30:32.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T01:54:48.000Z (2 months ago)
• Last Synced: 2024-11-08T15:30:41.734Z (about 2 months ago)
• Language: Go
• Size: 195 KB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `devbao`

`devbao` is a CLI utility to start [OpenBao](https://github.com/openbao/openbao)

and HashiCorp Vault instances for **development purposes**.

This allows you to skip many common steps such as creating configuration,

initializing the instance, managing root tokens through the use of CLI flags

and a common configuration directory.

Missing an option? Open a pull request!

## Building

To build and run:

```$

$ make bin

$ ./bin/devbao

```

Because `devbao` is a static Go binary, it should be relocatable anywhere on

`$PATH`.

Data is presently stored in `$HOME/.local/share/devbao`.

## CLI interface

Refer to `devbao help` for more information about commands currently

implemented.

With Bash, a node could be created and connected with:

```$

# This starts a production (persistent) single node, initializing (to save the

# root token and unseal keys), unsealing (to make it usable), and provisioning

# a root and intermediate PKI mount (the `pki` profile).

$ devbao node start --force --unseal --initialize --profiles pki

# This loads the environment details to contact this instance into the shell

# session so that future `bao` commands will work.

$ . <(devbao node env prod)

$ bao secrets list

```

HA cluster can similarly be created with the `devbao cluster start `

command.

## TUI interface

`devbao` features a basic TUI available under the `devbao tui` command.

## Contributing

Interested in contributing? Consider opening an issue to discuss the feature

before opening a PR.

See the [contributing guidelines](https://github.com/openbao/openbao/tree/main/CONTRIBUTING.md)

in the OpenBao project as they apply here as well.