Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add Passbolt adapter usage #171

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/commands/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,3 +213,37 @@ kamal secrets fetch --adapter=gcp \
--account="[email protected]|[email protected],[email protected]" \
my-secret
```

## Passbolt

First, install and configure the [Passbolt CLI](https://github.com/passbolt/go-passbolt-cli).

Passbolt organizes secrets in folders (like `coolfolder`) and these folders can be nested (like `coolfolder/prod`, `coolfolder/stg`, etc). You can access secrets in these folders in two ways:

1. Using the `--from` option to specify the folder path `--from coolfolder`
2. Prefixing the secret names with the folder path `coolfolder/REGISTRY_PASSWORD`

Use the adapter `passbolt`:

```bash
# Fetch passwords from root (no folder)
kamal secrets fetch --adapter passbolt REGISTRY_PASSWORD DB_PASSWORD

# Fetch passwords from a folder using --from
kamal secrets fetch --adapter passbolt --from coolfolder REGISTRY_PASSWORD DB_PASSWORD

# Fetch passwords from a nested folder using --from
kamal secrets fetch --adapter passbolt --from coolfolder/subfolder REGISTRY_PASSWORD DB_PASSWORD

# Fetch passwords by prefixing the folder path to the secret name
kamal secrets fetch --adapter passbolt coolfolder/REGISTRY_PASSWORD coolfolder/DB_PASSWORD

# Fetch passwords from multiple folders
kamal secrets fetch --adapter passbolt coolfolder/REGISTRY_PASSWORD otherfolder/DB_PASSWORD

# Extract the secret values
kamal secrets extract REGISTRY_PASSWORD <SECRETS-FETCH-OUTPUT>
kamal secrets extract DB_PASSWORD <SECRETS-FETCH-OUTPUT>
```

The passbolt adapter does not use the `--account` option, if given it will be ignored.