Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-10633 Adding references to Key/Value Version 1 secrets engine in HashiCorp Vault documentation 

This closes #6520

Signed-off-by: David Handermann <exceptionfactory@apache.org>
This commit is contained in:
Joe Gresock 2022-10-12 15:42:58 -04:00 committed by exceptionfactory
parent 72cc2f671c
commit 283669ced3
No known key found for this signature in database
GPG Key ID: 29B6A52D2AAE8DBA
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
nifi-commons/nifi-hashicorp-vault-api/src/main/java/org/apache/nifi/vault/hashicorp/HashiCorpVaultCommunicationService.java
View File

@ -51,7 +51,7 @@ public interface HashiCorpVaultCommunicationService {
byte[] decrypt(String transitPath, String cipherText); byte[] decrypt(String transitPath, String cipherText);
/** /**
* Writes a single secret value using Vault's Key/Value Secrets Engine. * Writes a single secret value using Vault's Key/Value Version 1 Secrets Engine.
* *
* @see <a href="https://www.vaultproject.io/api-docs/secret/kv">https://www.vaultproject.io/api-docs/secret/kv</a> * @see <a href="https://www.vaultproject.io/api-docs/secret/kv">https://www.vaultproject.io/api-docs/secret/kv</a>
* @param keyValuePath The Vault path to use for the configured Key/Value Secrets Engine * @param keyValuePath The Vault path to use for the configured Key/Value Secrets Engine
@ -61,7 +61,7 @@ public interface HashiCorpVaultCommunicationService {
void writeKeyValueSecret(String keyValuePath, String secretKey, String value); void writeKeyValueSecret(String keyValuePath, String secretKey, String value);
/** /**
* Reads a single secret value from Vault's Key/Value Secrets Engine. * Reads a single secret value from Vault's Key/Value Version 1 Secrets Engine.
* *
* @see <a href="https://www.vaultproject.io/api-docs/secret/kv">https://www.vaultproject.io/api-docs/secret/kv</a> * @see <a href="https://www.vaultproject.io/api-docs/secret/kv">https://www.vaultproject.io/api-docs/secret/kv</a>
* @param keyValuePath The Vault path to use for the configured Key/Value Secrets Engine * @param keyValuePath The Vault path to use for the configured Key/Value Secrets Engine
@ -71,7 +71,7 @@ public interface HashiCorpVaultCommunicationService {
Optional<String> readKeyValueSecret(String keyValuePath, String secretKey); Optional<String> readKeyValueSecret(String keyValuePath, String secretKey);
/** /**
* Writes a secret with multiple key/value pairs using Vault's Key/Value Secrets Engine. * Writes a secret with multiple key/value pairs using Vault's Key/Value Version 1 Secrets Engine.
* *
* @see <a href="https://www.vaultproject.io/api-docs/secret/kv">https://www.vaultproject.io/api-docs/secret/kv</a> * @see <a href="https://www.vaultproject.io/api-docs/secret/kv">https://www.vaultproject.io/api-docs/secret/kv</a>
* @param keyValuePath The Vault path to use for the configured Key/Value Secrets Engine * @param keyValuePath The Vault path to use for the configured Key/Value Secrets Engine
@ -80,7 +80,7 @@ public interface HashiCorpVaultCommunicationService {
void writeKeyValueSecretMap(String keyValuePath, String secretKey, Map<String, String> keyValues); void writeKeyValueSecretMap(String keyValuePath, String secretKey, Map<String, String> keyValues);
/** /**
* Reads a secret with multiple key/value pairs from Vault's Key/Value Secrets Engine. * Reads a secret with multiple key/value pairs from Vault's Key/Value Version 1 Secrets Engine.
* *
* @see <a href="https://www.vaultproject.io/api-docs/secret/kv">https://www.vaultproject.io/api-docs/secret/kv</a> * @see <a href="https://www.vaultproject.io/api-docs/secret/kv">https://www.vaultproject.io/api-docs/secret/kv</a>
* @param keyValuePath The Vault path to use for the configured Key/Value Secrets Engine * @param keyValuePath The Vault path to use for the configured Key/Value Secrets Engine
@ -90,7 +90,7 @@ public interface HashiCorpVaultCommunicationService {
Map<String, String> readKeyValueSecretMap(String keyValuePath, String secretKey); Map<String, String> readKeyValueSecretMap(String keyValuePath, String secretKey);
/** /**
* Lists the secrets at the given Key/Value Secrets Engine path. * Lists the secrets at the given Key/Value Version 1 Secrets Engine path.
* @param keyValuePath The Vault path to list * @param keyValuePath The Vault path to list
* @return The list of secret names * @return The list of secret names
*/ */

4
nifi-nar-bundles/nifi-hashicorp-vault-bundle/nifi-hashicorp-vault-parameter-provider/src/main/java/org/apache/nifi/vault/hashicorp/HashiCorpVaultParameterProvider.java
View File

@ -38,7 +38,7 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.stream.Collectors; import java.util.stream.Collectors;
@CapabilityDescription("Provides parameters from HashiCorp Vault Key/Value Secrets. Each Secret represents a parameter group, " + @CapabilityDescription("Provides parameters from HashiCorp Vault Key/Value Version 1 Secrets. Each Secret represents a parameter group, " +
"which will map to a Parameter Context. The keys and values in the Secret map to Parameters.") "which will map to a Parameter Context. The keys and values in the Secret map to Parameters.")
@Tags({"hashicorp", "vault", "secret"}) @Tags({"hashicorp", "vault", "secret"})
public class HashiCorpVaultParameterProvider extends AbstractParameterProvider implements ParameterProvider, VerifiableParameterProvider { public class HashiCorpVaultParameterProvider extends AbstractParameterProvider implements ParameterProvider, VerifiableParameterProvider {
@ -54,7 +54,7 @@ public class HashiCorpVaultParameterProvider extends AbstractParameterProvider i
public static final PropertyDescriptor KV_PATH = new PropertyDescriptor.Builder() public static final PropertyDescriptor KV_PATH = new PropertyDescriptor.Builder()
.name("kv-path") .name("kv-path")
.displayName("Key/Value Path") .displayName("Key/Value Path")
.description("The HashiCorp Vault path to the Key/Value Secrets Engine") .description("The HashiCorp Vault path to the Key/Value Version 1 Secrets Engine")
.addValidator(StandardValidators.NON_EMPTY_VALIDATOR) .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
.required(true) .required(true)
.defaultValue("kv") .defaultValue("kv")