jx-secret

README

jx-secret

jx-secret is a small command line tool working with Kubernetes External Secrets.

Getting Started

Download the jx-secret binary for your operating system and add it to your $PATH.

There will be an app you can install soon too...

Mappings

When using the jx-secret convert command to generate ExternalSecret CRDs you may wish to use a custom mapping of Secret names and data keys to key/properties in Vault.

To do this just create a .jx/secret/mapping/secret-mapping.yaml file in your directory tree when running the command.

You can then customise the key and/or property values that are used in the generated ExternalSecret CRDs

For more details see the Mapping Configuration Reference

Schema

To improve the UX around editing Secrets via jx secret edit or populating initial or generated secrets on first install via jx secret populate we use a Schema definition (similar to JSON Schema) which allows you to provide better validation and configuration for default values and the generator to be used.

For details of the schema configuration see Schema

Reference Guides

Commands

See the jx-secret command reference

Configuration

The configuration file formats and schema references are here:

• ExternalSecret
• SecretMapping
• Schema