Commit 32918507 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: centralized service images

parent 1f53b791

README.md

+5 −5
Original line number Diff line number Diff line
@@ -44,7 +44,7 @@ GET /api​/secrets​/{secret_path} 


##### Parameters



| Name                             | description                            |

| Name                             | Description                            |

| -------------------------------- | -------------------------------------- |

| `secret_path` (_path parameter_) | this is your secret location in the Vault server |

| `field` (_query parameter_)      | parameter to access a single basic field from the secret JSON payload |
@@ -88,7 +88,7 @@ When using version 2, you don't need to embed your secret payload into a `data` 


##### Parameters



| Name                             | description                            |

| Name                             | Description                            |

| -------------------------------- | -------------------------------------- |

| `secret_path` (_path parameter_) | this is your secret location in the Vault server |
@@ -121,7 +121,7 @@ DELETE /api​/secrets​/{secret_path} 


##### Parameters



| Name                             | description                            |

| Name                             | Description                            |

| -------------------------------- | -------------------------------------- |

| `secret_path` (_path parameter_) | this is your secret location in the Vault server |
@@ -137,7 +137,7 @@ curl -X DELETE http://localhost:8080/api/secret/b7ecb6ebabc231/my-backend/review 


The tool requires the following environment variables to be set (as GitLab CI secret variables):



| Name              | description                            | default value     |

| Name              | Description                            | Default value     |

| ----------------- | -------------------------------------- | ----------------- |

| `VAULT_BASE_URL`  | The Vault server base API url, including the API version prefix (ex: `https://vault.secrets.acme.host/v1`) | _none_ |

| `VAULT_NAMESPACE` | The Vault [Namespace](https://www.vaultproject.io/api-docs#namespaces) to retrieve secrets into | _none_ |
@@ -184,7 +184,7 @@ deploy-job: 
  services:

    # add Vault Secrets Provider as a service

    # requires that VAULT_ROLE_ID and VAULT_SECRET_ID are declared as secret variables

    - name: $CI_REGISTRY/to-be-continuous/tools/vault-secrets-provider:master

    - name: registry.gitlab.com/to-be-continuous/tools/vault-secrets-provider:master

      alias: vault-secrets-provider

  before_script:

    # retrieve some token from Vault server