arcodange-org/vault-action
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: promote non-key syntax sections

Browse Source
This commit is contained in:
Richard Simpson
2020-03-11 14:12:53 -05:00
parent 198a7ed7d2
commit cb2908ac94
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -13,12 +13,12 @@ By default, this action pulls from [Version 2](https://www.vaultproject.io/docs
- [Set Output Variable Name](#set-output-variable-name) - [Set Output Variable Name](#set-output-variable-name)
- [Multiple Secrets](#multiple-secrets) - [Multiple Secrets](#multiple-secrets)
- [Using K/V version 1](#using-kv-version-1) - [Using K/V version 1](#using-kv-version-1)
- [Custom K/V Engine Path](#custom-kv-engine-path) - [Custom K/V Engine Path](#custom-kv-engine-path)
- [Other Secret Engines](#other-secret-engines) - [Other Secret Engines](#other-secret-engines)
- [Adding Extra Headers](#adding-extra-headers) - [Adding Extra Headers](#adding-extra-headers)
- [Vault Enterprise Features](#vault-enterprise-features) - [Vault Enterprise Features](#vault-enterprise-features)
- [Namespace](#namespace) - [Namespace](#namespace)
- [Masking](#masking) - [Mashing - Secrets in Logs](#mashing---secrets-in-logs)
<!-- /TOC --> <!-- /TOC -->
@@ -149,7 +149,7 @@ with:
kv-version: 1 kv-version: 1
``` ```
### Custom K/V Engine Path ## Custom K/V Engine Path
When you enable the K/V Engine, by default it's placed at the path `secret`, so a secret named `ci` will be accessed from `secret/ci`. However, [if you enabled the secrets engine using a custom `path`](https://www.vaultproject.io/docs/commands/secrets/enable/#inlinecode--path-4), you When you enable the K/V Engine, by default it's placed at the path `secret`, so a secret named `ci` will be accessed from `secret/ci`. However, [if you enabled the secrets engine using a custom `path`](https://www.vaultproject.io/docs/commands/secrets/enable/#inlinecode--path-4), you
can pass it as follows: can pass it as follows:
@@ -162,7 +162,7 @@ with:
This way, the `ci` secret in the example above will be retrieved from `my-secrets/ci`. This way, the `ci` secret in the example above will be retrieved from `my-secrets/ci`.
### Other Secret Engines ## Other Secret Engines
While this action primarily supports the K/V engine, it is possible to request secrets from other engines in Vault. While this action primarily supports the K/V engine, it is possible to request secrets from other engines in Vault.
@@ -220,7 +220,7 @@ would work fine.
NOTE: The `Secret Key` is pulled from the `data` property of the response. NOTE: The `Secret Key` is pulled from the `data` property of the response.
### Adding Extra Headers ## Adding Extra Headers
If you ever need to add extra headers to the vault request, say if you need to authenticate with a firewall, all you need to do is set `extraHeaders`: If you ever need to add extra headers to the vault request, say if you need to authenticate with a firewall, all you need to do is set `extraHeaders`:
@@ -258,6 +258,6 @@ steps:
ci npm_token ci npm_token
``` ```
## Masking ## Mashing - Secrets in Logs
This action uses Github Action's built in masking, so all variables will automatically be masked if printed to the console or to logs. This action uses Github Action's built in masking, so all variables will automatically be masked (aka hidden) if printed to the console or to logs.