You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by ex...@apache.org on 2022/10/14 14:55:52 UTC

[nifi] branch main updated: NIFI-10633 Adding references to Key/Value Version 1 secrets engine in HashiCorp Vault documentation

This is an automated email from the ASF dual-hosted git repository.

exceptionfactory pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git


The following commit(s) were added to refs/heads/main by this push:
     new 283669ced3 NIFI-10633 Adding references to Key/Value Version 1 secrets engine in HashiCorp Vault documentation
283669ced3 is described below

commit 283669ced3e28669d3882b621c0d872dd726f642
Author: Joe Gresock <jg...@gmail.com>
AuthorDate: Wed Oct 12 15:42:58 2022 -0400

    NIFI-10633 Adding references to Key/Value Version 1 secrets engine in HashiCorp Vault documentation
    
    This closes #6520
    
    Signed-off-by: David Handermann <ex...@apache.org>
---
 .../vault/hashicorp/HashiCorpVaultCommunicationService.java    | 10 +++++-----
 .../nifi/vault/hashicorp/HashiCorpVaultParameterProvider.java  |  4 ++--
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/nifi-commons/nifi-hashicorp-vault-api/src/main/java/org/apache/nifi/vault/hashicorp/HashiCorpVaultCommunicationService.java b/nifi-commons/nifi-hashicorp-vault-api/src/main/java/org/apache/nifi/vault/hashicorp/HashiCorpVaultCommunicationService.java
index 3d06270f7b..adbb4764b0 100644
--- a/nifi-commons/nifi-hashicorp-vault-api/src/main/java/org/apache/nifi/vault/hashicorp/HashiCorpVaultCommunicationService.java
+++ b/nifi-commons/nifi-hashicorp-vault-api/src/main/java/org/apache/nifi/vault/hashicorp/HashiCorpVaultCommunicationService.java
@@ -51,7 +51,7 @@ public interface HashiCorpVaultCommunicationService {
     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>
      * @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);
 
     /**
-     * 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>
      * @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);
 
     /**
-     * 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>
      * @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);
 
     /**
-     * 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>
      * @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);
 
     /**
-     * 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
      * @return The list of secret names
      */
diff --git a/nifi-nar-bundles/nifi-hashicorp-vault-bundle/nifi-hashicorp-vault-parameter-provider/src/main/java/org/apache/nifi/vault/hashicorp/HashiCorpVaultParameterProvider.java b/nifi-nar-bundles/nifi-hashicorp-vault-bundle/nifi-hashicorp-vault-parameter-provider/src/main/java/org/apache/nifi/vault/hashicorp/HashiCorpVaultParameterProvider.java
index 154d0c6133..a073f07b6f 100644
--- a/nifi-nar-bundles/nifi-hashicorp-vault-bundle/nifi-hashicorp-vault-parameter-provider/src/main/java/org/apache/nifi/vault/hashicorp/HashiCorpVaultParameterProvider.java
+++ b/nifi-nar-bundles/nifi-hashicorp-vault-bundle/nifi-hashicorp-vault-parameter-provider/src/main/java/org/apache/nifi/vault/hashicorp/HashiCorpVaultParameterProvider.java
@@ -38,7 +38,7 @@ import java.util.List;
 import java.util.Map;
 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.")
 @Tags({"hashicorp", "vault", "secret"})
 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()
             .name("kv-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)
             .required(true)
             .defaultValue("kv")