Skip to content

Commit 50a6bac

Browse files
committed
Add Barbican docs
1 parent b36cb7e commit 50a6bac

File tree

2 files changed

+72
-0
lines changed

2 files changed

+72
-0
lines changed

doc/source/configuration/vault.rst

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,3 +206,69 @@ Enable the required TLS variables in kayobe and kolla
206206
.. code-block::
207207
208208
kayobe overcloud service deploy
209+
210+
Barbican integration
211+
====================
212+
213+
Enable Barbican in kayobe
214+
-------------------------
215+
216+
Set the following in kayobe-config/etc/kayobe/kolla.yml or if environments are being used etc/kayobe/environments/$KAYOBE_ENVIRONMENT/kolla.yml
217+
218+
.. code-block::
219+
220+
kolla_enable_barbican: yes
221+
222+
Generate secrets_barbican_approle_secret_id
223+
-------------------------------------------
224+
225+
1. Run ``uuidgen`` to generate secret id
226+
2. Insert into secrets.yml or if environments are being used etc/kayobe/environments/$KAYOBE_ENVIRONMENT/secrets.yml
227+
228+
.. code-block::
229+
230+
secrets_barbican_approle_secret_id: "YOUR-SECRET-GOES-HERE"
231+
232+
Create required configuration in Vault
233+
--------------------------------------
234+
235+
Run vault-deploy-barbican.yml custom playbook
236+
237+
.. code-block::
238+
239+
kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/vault-deploy-barbican.yml
240+
241+
Add secrets_barbican_approle_id to secrets
242+
------------------------------------------
243+
244+
Insert into secrets.yml or if environments are being used etc/kayobe/environments/$KAYOBE_ENVIRONMENT/secrets.yml
245+
246+
.. code-block::
247+
248+
secrets_barbican_approle_id: "YOUR-APPROLE-ID-GOES-HERE"
249+
250+
Configure Barbican
251+
------------------
252+
253+
Put required configuration in kayobe-config/etc/kayobe/kolla/config/barbican.conf or if environments are being used etc/kayobe/environments/$KAYOBE_ENVIRONMENT/kolla/config/barbican.conf
254+
255+
.. code-block::
256+
257+
[secretstore]
258+
namespace=barbican.secretstore.plugin
259+
enable_multiple_secret_stores=false
260+
enabled_secretstore_plugins=vault_plugin
261+
262+
[vault_plugin]
263+
vault_url = https://{{ internal_net_vip_address }}:8200
264+
use_ssl = True
265+
approle_role_id = {{ secrets_barbican_approle_role_id }}
266+
approle_secret_id = {{ secrets_barbican_approle_secret_id }}
267+
kv_mountpoint = barbican
268+
269+
Deploy Barbican
270+
---------------
271+
272+
.. code-block::
273+
274+
kayobe overcloud service deploy -kt barbican

etc/kayobe/ansible/vault-deploy-barbican.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77
vault_api_addr: "https://{{ kolla_internal_fqdn }}:8200"
88
vault_ca_cert: "{{ '/etc/pki/tls/certs/ca-bundle.crt' if ansible_facts.os_family == 'RedHat' else '/usr/local/share/ca-certificates/OS-TLS-ROOT.crt' }}"
99
tasks:
10+
- name: Assert that secrets_barbican_approle_secret_id is defined
11+
assert:
12+
that:
13+
- secrets_barbican_approle_secret_id is defined
14+
fail_msg: "Please define secrets_barbican_approle_secret_id in your secrets.yml"
15+
1016
- name: Include Vault keys
1117
include_vars:
1218
file: "{{ kayobe_env_config_path }}/vault/overcloud-vault-keys.json"

0 commit comments

Comments
 (0)