-
Notifications
You must be signed in to change notification settings - Fork 89
/
step.yaml
161 lines (161 loc) · 5.55 KB
/
step.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
kind: step-type
version: '1.0'
metadata:
name: vault
version: 0.0.7
title: Fetch secrets from Hashicorp Vault
isPublic: true
description: >-
Read secrets from Hashicorp Vault inside a Codefresh pipeline.
sources:
- >-
https://github.com/codefresh-io/steps/tree/master/incubating/vault
stage: incubating
maintainers:
- name: Brandon Phillips
categories:
- featured
official: false
tags: []
icon:
type: svg
url: https://cdn.jsdelivr.net/gh/codefresh-io/steps/incubating/vault/icon.svg
background: "#f4f4f4"
examples:
- description: Token Authentication
workflow:
Vault_to_Env:
title: Importing vault values
type: vault
arguments:
VAULT_ADDR: ${{VAULT_ADDR}}
VAULT_PATH: ${{VAULT_PATH}}
VAULT_AUTH_TOKEN: ${{VAULT_AUTH_TOKEN}}
- description: Client Certificate
workflow:
Vault_to_Env:
title: Importing vault values
type: vault
arguments:
VAULT_ADDR: ${{VAULT_ADDR}}
VAULT_PATH: ${{VAULT_PATH}}
VAULT_AUTH_TOKEN: ${{VAULT_AUTH_TOKEN}}
VAULT_CLIENT_CERT_BASE64: ${{VAULT_CLIENT_CERT_BASE64}}
VAULT_CLIENT_KEY_BASE64: ${{VAULT_CLIENT_KEY_BASE64}}
- description: Approle Authentication
workflow:
Vault_to_Env:
title: Importing vault values
type: vault
arguments:
VAULT_ADDR: ${{VAULT_ADDR}}
VAULT_PATH: ${{VAULT_PATH}}
VAULT_AUTH_METHOD: 'APPROLE'
APPROLE_ROLE_ID: ${{APPROLE_ROLE_ID}}
APPROLE_SECRET_ID: ${{APPROLE_SECRET_ID}}
- description: Retrieve Single Key
workflow:
Vault_to_Env:
title: Importing vault values
type: vault
arguments:
VAULT_ADDR: ${{VAULT_ADDR}}
VAULT_PATH: ${{VAULT_PATH}}
VAULT_AUTH_TOKEN: ${{VAULT_AUTH_TOKEN}}
VAULT_FIELD_NAME: 'some-key-name'
- description: Retrieve Multiple Paths
workflow:
Vault_to_Env:
title: Importing vault values
type: vault
arguments:
VAULT_ADDR: ${{VAULT_ADDR}}
VAULT_PATH: 'kv/firstpath;kv/secondpath'
VAULT_PATH_DELIMITER: ';'
VAULT_AUTH_TOKEN: ${{VAULT_AUTH_TOKEN}}
- description: Add Prefix to Variables
workflow:
Vault_to_Env:
title: Importing vault values
type: vault
arguments:
VAULT_ADDR: ${{VAULT_ADDR}}
VAULT_PATH: 'kv/firstpath;kv/secondpath'
VAULT_PATH_DELIMITER: ';'
VAULT_AUTH_TOKEN: ${{VAULT_AUTH_TOKEN}}
VAULT_VARIABLE_EXPORT_PREFIX: 'pre_'
spec:
arguments: |-
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"patterns": [],
"required": [
"VAULT_ADDR",
"VAULT_PATH"
],
"properties": {
"VAULT_ADDR": {
"type": "string",
"description": "Vault server URI. Example: https://vault.testdomain.io:8200 (required)"
},
"VAULT_PATH": {
"type": "string",
"description": "Path to secrets in vault. Example: secret/codefreshsecret (required)"
},
"VAULT_PATH_DELIMITER": {
"type": "string",
"description": "Path delimiter to break up multiple paths in the VAULT_PATH value"
},
"VAULT_AUTH_METHOD": {
"type": "string",
"description": "Vault authentication method. Valid options: APPROLE or TOKEN"
},
"VAULT_AUTH_TOKEN": {
"type": "string",
"description": "Vault authentication token (required)"
},
"APPROLE_ROLE_ID": {
"type": "string",
"description": "Vault AppRole Role ID. Required if auth method is APPROLE"
},
"APPROLE_SECRET_ID": {
"type": "string",
"description": "Vault AppRole Secret ID. Required if auth method is APPROLE"
},
"VAULT_CLIENT_CERT_BASE64": {
"type": "string",
"description": "Base64 encoded client cerificate"
},
"VAULT_CLIENT_KEY_BASE64": {
"type": "string",
"description": "Base64 encoded client key"
},
"VAULT_FIELD_NAME": {
"type": "string",
"description": "Set this field to export a single value with the specified key"
},
"VAULT_VARIABLE_EXPORT_PREFIX": {
"type": "string",
"description": "Add a string prefix to the exported variable names of groups or single values"
}
}
}
steps:
main:
name: vault
image: codefresh/vault
environment:
- 'VAULT_ADDR=${{VAULT_ADDR}}'
- 'VAULT_PATH=${{VAULT_PATH}}'
- 'VAULT_PATH_DELIMITER=${{VAULT_PATH_DELIMITER}}'
- 'VAULT_AUTH_TOKEN=${{VAULT_AUTH_TOKEN}}'
- 'VAULT_CLIENT_CERT_BASE64=${{VAULT_CLIENT_CERT_BASE64}}'
- 'VAULT_CLIENT_KEY_BASE64=${{VAULT_CLIENT_KEY_BASE64}}'
- 'VAULT_AUTH_METHOD=${{VAULT_AUTH_METHOD}}'
- 'APPROLE_ROLE_ID=${{APPROLE_ROLE_ID}}'
- 'APPROLE_SECRET_ID=${{APPROLE_SECRET_ID}}'
- 'VAULT_FIELD_NAME=${{VAULT_FIELD_NAME}}'
- 'VAULT_VARIABLE_EXPORT_PREFIX=${{VAULT_VARIABLE_EXPORT_PREFIX}}'