From 22042b4a1f1a941bed2fe7624b3734c603331fa2 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Wed, 20 May 2020 08:58:45 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- reference/html/index.html | 114 +------------------------ reference/html/spring-cloud-vault.html | 114 +------------------------ 2 files changed, 6 insertions(+), 222 deletions(-) diff --git a/reference/html/index.html b/reference/html/index.html index dbaa20bd..7d7cf703 100644 --- a/reference/html/index.html +++ b/reference/html/index.html @@ -143,7 +143,6 @@ $(globalSwitch);
  • Secret Backends @@ -1686,120 +1685,13 @@ PCF authentication requires BouncyCastle (bcpkix-jdk15on) to be on the classpath

    Secret Backends

    -

    Generic Backend

    -
    - - - - - -
    - - -This backend is deprecated in favor of the Key-Value backend and will be removed with the next major version. -
    -
    -
    -

    Spring Cloud Vault supports at the basic level the key-value secret backend. -The key-value secret backend allows storage of arbitrary values as key-value store. -A single context can store one or many key-value tuples. -Contexts can be organized hierarchically. -Spring Cloud Vault allows using the Application name and a default context name (application) in combination with active profiles.

    -
    -
    -
    -
    /secret/{application}/{profile}
-/secret/{application}
-/secret/{default-context}/{profile}
-/secret/{default-context}
    -
    -
    -
    -

    The application name is determined by the properties:

    -
    -
    -
      -
    • -

      spring.cloud.vault.generic.application-name

      -
      • -
    • -

      spring.cloud.vault.application-name

      -
      • -
    • -

      spring.application.name

      -
      • -
    -
    -
    -

    Secrets can be obtained from other contexts within the key-value backend by adding their paths to the application name, separated by commas. -For example, given the application name usefulapp,mysql1,projectx/aws, each of these folders will be used:

    -
    -
    -
      -
    • -

      /secret/usefulapp

      -
      • -
    • -

      /secret/mysql1

      -
      • -
    • -

      /secret/projectx/aws

      -
      • -
    -
    -
    -

    Spring Cloud Vault adds all active profiles to the list of possible context paths. -No active profiles will skip accessing contexts with a profile name.

    -
    -
    -

    Properties are exposed like they are stored (i.e. without additional prefixes).

    -
    -
    -
    -
    -
    -
    spring.cloud.vault:
-    generic:
-        enabled: true
-        backend: secret
-        profile-separator: '/'
-        default-context: application
-        application-name: my-app
    -
    -
    -
    -
    -
    -
      -
    • -

      enabled setting this value to false disables the secret backend config usage

      -
      • -
    • -

      backend sets the path of the secret mount to use

      -
      • -
    • -

      default-context sets the context name used by all applications

      -
      • -
    • -

      application-name overrides the application name for use in the key-value backend

      -
      • -
    • -

      profile-separator separates the profile name from the context in property sources with profiles

      -
      • -
    -
    -
    -

    See also: Vault Documentation: Using the KV Secrets Engine - Version 1 (generic secret backend)

    -
    -
    -

    Key-Value Backend

    -

    Spring Cloud Vault supports the Key-Value secret backend. +

    Spring Cloud Vault supports both Key-Value secret backends, the versioned (v2) and unversioned (v1). The key-value backend allows storage of arbitrary values as key-value store. A single context can store one or many key-value tuples. Contexts can be organized hierarchically. -Spring Cloud Vault determines itself whether a secret is using versioning. +Spring Cloud Vault determines itself whether a secret is using versioning and maps the path to its appropriate URL. Spring Cloud Vault allows using the Application name and a default context name (application) in combination with active profiles.

    diff --git a/reference/html/spring-cloud-vault.html b/reference/html/spring-cloud-vault.html index dbaa20bd..7d7cf703 100644 --- a/reference/html/spring-cloud-vault.html +++ b/reference/html/spring-cloud-vault.html @@ -143,7 +143,6 @@ $(globalSwitch);
  • Secret Backends @@ -1686,120 +1685,13 @@ PCF authentication requires BouncyCastle (bcpkix-jdk15on) to be on the classpath

    Secret Backends

    -

    Generic Backend

    -
    - - - - - -
    - - -This backend is deprecated in favor of the Key-Value backend and will be removed with the next major version. -
    -
    -
    -

    Spring Cloud Vault supports at the basic level the key-value secret backend. -The key-value secret backend allows storage of arbitrary values as key-value store. -A single context can store one or many key-value tuples. -Contexts can be organized hierarchically. -Spring Cloud Vault allows using the Application name and a default context name (application) in combination with active profiles.

    -
    -
    -
    -
    /secret/{application}/{profile}
-/secret/{application}
-/secret/{default-context}/{profile}
-/secret/{default-context}
    -
    -
    -
    -

    The application name is determined by the properties:

    -
    -
    -
      -
    • -

      spring.cloud.vault.generic.application-name

      -
      • -
    • -

      spring.cloud.vault.application-name

      -
      • -
    • -

      spring.application.name

      -
      • -
    -
    -
    -

    Secrets can be obtained from other contexts within the key-value backend by adding their paths to the application name, separated by commas. -For example, given the application name usefulapp,mysql1,projectx/aws, each of these folders will be used:

    -
    -
    -
      -
    • -

      /secret/usefulapp

      -
      • -
    • -

      /secret/mysql1

      -
      • -
    • -

      /secret/projectx/aws

      -
      • -
    -
    -
    -

    Spring Cloud Vault adds all active profiles to the list of possible context paths. -No active profiles will skip accessing contexts with a profile name.

    -
    -
    -

    Properties are exposed like they are stored (i.e. without additional prefixes).

    -
    -
    -
    -
    -
    -
    spring.cloud.vault:
-    generic:
-        enabled: true
-        backend: secret
-        profile-separator: '/'
-        default-context: application
-        application-name: my-app
    -
    -
    -
    -
    -
    -
      -
    • -

      enabled setting this value to false disables the secret backend config usage

      -
      • -
    • -

      backend sets the path of the secret mount to use

      -
      • -
    • -

      default-context sets the context name used by all applications

      -
      • -
    • -

      application-name overrides the application name for use in the key-value backend

      -
      • -
    • -

      profile-separator separates the profile name from the context in property sources with profiles

      -
      • -
    -
    -
    -

    See also: Vault Documentation: Using the KV Secrets Engine - Version 1 (generic secret backend)

    -
    -
    -

    Key-Value Backend

    -

    Spring Cloud Vault supports the Key-Value secret backend. +

    Spring Cloud Vault supports both Key-Value secret backends, the versioned (v2) and unversioned (v1). The key-value backend allows storage of arbitrary values as key-value store. A single context can store one or many key-value tuples. Contexts can be organized hierarchically. -Spring Cloud Vault determines itself whether a secret is using versioning. +Spring Cloud Vault determines itself whether a secret is using versioning and maps the path to its appropriate URL. Spring Cloud Vault allows using the Application name and a default context name (application) in combination with active profiles.