@@ -3,17 +3,6 @@ _StackStorm pack integration with HashiCorp Vault_
33
44* Author:
* steve.neuharth <
[email protected] >
55
6- ## Maintainers
7- Active pack maintainers with review & write repository access and expertise with vault:
8- * Jacob Floyd (
[ @cognifloyd ] ( https://github.com/cognifloyd ) )
< [email protected] > Copart
9- * Carlos ([ @nzlosh ] ( https://github.com/nzlosh ) )
10-
11- ### Contributors
12- 13- 14- 15-
16-
176## Configuration
187
198The following options are required to be configured for the pack to work correctly.
@@ -39,35 +28,6 @@ The following options are required to be configured for the pack to work correct
3928
4029The pack provides the following actions:
4130
42- ### delete
43- _ Delete value from Vault server_
44- | Parameter | Type | Required | Secret | Description |
45- | ---| ---| ---| ---| ---|
46- | ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
47- | ` path ` | string | True | default | _ Path to delete from Vault_ |
48-
49-
50- ### generate_secret
51- _ Generate a secret and write it to vault._
52- | Parameter | Type | Required | Secret | Description |
53- | ---| ---| ---| ---| ---|
54- | ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
55- | ` mount_point ` | string | False | default | _ Vault moint point in the URL_ |
56- | ` path ` | string | True | default | _ Path to the secrets_ |
57- | ` key_name ` | string | True | default | _ Name of the key to write the secret._ |
58- | ` update_tactic ` | string | False | default | _ The logic to use when writing secret to Vault. See readme for details._ |
59- | ` string_set ` | string | default | default | _ Unavailable_ |
60- | ` secret_length ` | integer | default | default | _ The number of characters to use in the secret._ |
61-
62-
63- ### read
64- _ Read value from Vault server_
65- | Parameter | Type | Required | Secret | Description |
66- | ---| ---| ---| ---| ---|
67- | ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
68- | ` path ` | string | True | default | _ Key to read from Vault_ |
69-
70-
7131### create_token
7232_ Create a new Token_
7333| Parameter | Type | Required | Secret | Description |
@@ -92,13 +52,33 @@ _Create a new Token_
9252| ` mount_point ` | string | False | default | _ The 'path' the method/backend was mounted on._ |
9353
9454
95- ### write
96- _ Write a key/ value to Vault _
55+ ### delete
56+ _ Delete value from Vault server _
9757| Parameter | Type | Required | Secret | Description |
9858| ---| ---| ---| ---| ---|
9959| ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
100- | ` path ` | string | True | default | _ Path to the Vault secrets_ |
101- | ` values ` | string | True | default | _ Keys and values to write in Vault ({"key":"value", "key2": "value2"}_ |
60+ | ` path ` | string | True | default | _ Path to delete from Vault_ |
61+
62+
63+ ### delete_policy
64+ _ Delete policy from Vault server_
65+ | Parameter | Type | Required | Secret | Description |
66+ | ---| ---| ---| ---| ---|
67+ | ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
68+ | ` name ` | string | True | default | _ Policy to delete from Vault_ |
69+
70+
71+ ### generate_secret
72+ _ Generate a secret and write it to vault._
73+ | Parameter | Type | Required | Secret | Description |
74+ | ---| ---| ---| ---| ---|
75+ | ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
76+ | ` mount_point ` | string | False | default | _ Vault moint point in the URL_ |
77+ | ` path ` | string | True | default | _ Path to the secrets_ |
78+ | ` key_name ` | string | True | default | _ Name of the key to write the secret._ |
79+ | ` update_tactic ` | string | False | default | _ The logic to use when writing secret to Vault. See readme for details._ |
80+ | ` string_set ` | string | default | default | _ Unavailable_ |
81+ | ` secret_length ` | integer | default | default | _ The number of characters to use in the secret._ |
10282
10383
10484### get_policy
@@ -109,12 +89,26 @@ _Read policy from Vault server_
10989| ` name ` | string | True | default | _ Policy to read from Vault_ |
11090
11191
112- ### delete_policy
113- _ Delete policy from Vault server_
92+ ### is_initialized
93+ _ Read initialization status from Vault server_
11494| Parameter | Type | Required | Secret | Description |
11595| ---| ---| ---| ---| ---|
11696| ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
117- | ` name ` | string | True | default | _ Policy to delete from Vault_ |
97+
98+
99+ ### list_policies
100+ _ List Policies from Vault server_
101+ | Parameter | Type | Required | Secret | Description |
102+ | ---| ---| ---| ---| ---|
103+ | ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
104+
105+
106+ ### read
107+ _ Read value from Vault server_
108+ | Parameter | Type | Required | Secret | Description |
109+ | ---| ---| ---| ---| ---|
110+ | ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
111+ | ` path ` | string | True | default | _ Key to read from Vault_ |
118112
119113
120114### read_kv
@@ -128,6 +122,15 @@ _Read a kv value from Vault server_
128122| ` version ` | string | True | default | _ The version of the kv * data* _ |
129123
130124
125+ ### revoke_token
126+ _ Revoke a token and all its child tokens._
127+ | Parameter | Type | Required | Secret | Description |
128+ | ---| ---| ---| ---| ---|
129+ | ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
130+ | ` token ` | string | True | default | _ Token to revoke._ |
131+ | ` mount_point ` | string | False | default | _ The 'path' the method/backend was mounted on._ |
132+
133+
131134### set_policy
132135_ Create a new Vault policy_
133136| Parameter | Type | Required | Secret | Description |
@@ -137,11 +140,13 @@ _Create a new Vault policy_
137140| ` rules ` | string | True | default | _ Policy rules_ |
138141
139142
140- ### list_policies
141- _ List Policies from Vault server _
143+ ### write
144+ _ Write a key/value to Vault _
142145| Parameter | Type | Required | Secret | Description |
143146| ---| ---| ---| ---| ---|
144147| ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
148+ | ` path ` | string | True | default | _ Path to the Vault secrets_ |
149+ | ` values ` | string | True | default | _ Keys and values to write in Vault ({"key":"value", "key2": "value2"}_ |
145150
146151
147152### write_secret
@@ -157,22 +162,6 @@ _Write a secret to Vault._
157162| ` update_tactic ` | string | False | default | _ The logic to use when writing secret to Vault. See readme for details._ |
158163
159164
160- ### revoke_token
161- _ Revoke a token and all its child tokens._
162- | Parameter | Type | Required | Secret | Description |
163- | ---| ---| ---| ---| ---|
164- | ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
165- | ` token ` | string | True | default | _ Token to revoke._ |
166- | ` mount_point ` | string | False | default | _ The 'path' the method/backend was mounted on._ |
167-
168-
169- ### is_initialized
170- _ Read initialization status from Vault server_
171- | Parameter | Type | Required | Secret | Description |
172- | ---| ---| ---| ---| ---|
173- | ` profile_name ` | string | False | default | _ The profile to use to run this action._ |
174-
175-
176165
177166
178167
@@ -235,4 +224,9 @@ method that should be used.
235224 - radius
236225 - userpass
237226
227+ ## Maintainers
228+ Active pack maintainers with review & write repository access and expertise with vault:
229+ * Jacob Floyd (
[ @cognifloyd ] ( https://github.com/cognifloyd ) )
< [email protected] > Copart
230+ * Carlos ([ @nzlosh ] ( https://github.com/nzlosh ) )
231+
238232<sub >Documentation generated using [ pack2md] ( https://github.com/nzlosh/pack2md ) </sub >
0 commit comments