-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Vault agent role for ansible #10
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d0a9a9b
feat: add role for vault agent
Zakurama 03641fb
feat: copying certificates to target directory
Zakurama d39ed1b
style: fix PR remarks
Zakurama d97e736
fix: write template output to correct directory
Zakurama 0b2102b
fix: fix PR remarks
Zakurama File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
vault_agent_working_directory: /root/vault_agent_certificates | ||
|
||
vault_agent_vault_version: 1.18.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
- name: Restart vault-agent-certificates | ||
ansible.builtin.systemd: | ||
name: vault-agent-certificates | ||
state: restarted |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
- name: Download Vault Hashicorp gpg key | ||
ansible.builtin.get_url: | ||
url: https://apt.releases.hashicorp.com/gpg | ||
dest: /usr/share/keyrings/hashicorp-archive-keyring.asc | ||
mode: "0644" | ||
owner: root | ||
checksum: sha256:cafb01beac341bf2a9ba89793e6dd2468110291adfbb6c62ed11a0cde6c09029 | ||
|
||
- name: Pin Vault package | ||
ansible.builtin.template: | ||
src: vault.pref.j2 | ||
dest: /etc/apt/preferences.d/vault.pref | ||
mode: '0644' | ||
owner: root | ||
group: root | ||
|
||
- name: Add Vault repository | ||
ansible.builtin.apt_repository: | ||
repo: "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.asc] https://apt.releases.hashicorp.com {{ ansible_distribution_release }} main" | ||
state: present | ||
|
||
- name: Intall Vault | ||
ansible.builtin.apt: | ||
update_cache: true | ||
name: | ||
- vault | ||
|
||
- name: Retrieve role_id and secret_id from Vault | ||
community.hashi_vault.vault_kv2_get: | ||
path: certificat-web-id | ||
register: certificat_secrets | ||
run_once: true | ||
delegate_to: localhost | ||
become: false | ||
|
||
- name: Create vault agent workdir | ||
ansible.builtin.file: | ||
path: "{{ vault_agent_working_directory }}" | ||
state: directory | ||
mode: '0755' | ||
owner: root | ||
group: root | ||
|
||
- name: Create role_id file | ||
vars: | ||
content: "{{ certificat_secrets.secret.role_id }}" | ||
ansible.builtin.template: | ||
src: content.j2 | ||
dest: "{{ vault_agent_working_directory }}/role_id" | ||
mode: '0600' | ||
owner: root | ||
group: root | ||
|
||
- name: Create secret_id file | ||
vars: | ||
content: "{{ certificat_secrets.secret.secret_id }}" | ||
ansible.builtin.template: | ||
src: content.j2 | ||
dest: "{{ vault_agent_working_directory }}/secret_id" | ||
mode: '0600' | ||
owner: root | ||
group: root | ||
|
||
- name: Copy agent-config.hcl | ||
ansible.builtin.template: | ||
src: agent-config.hcl.j2 | ||
dest: "{{ vault_agent_working_directory }}/agent-config.hcl" | ||
mode: '0644' | ||
owner: root | ||
group: root | ||
notify: Restart vault-agent-certificates | ||
|
||
- name: Copy retrieving_cert.tmpl | ||
ansible.builtin.template: | ||
src: retrieving_cert.tmpl.j2 | ||
dest: "{{ vault_agent_working_directory }}/retrieving_cert.tmpl" | ||
mode: '0644' | ||
owner: root | ||
group: root | ||
variable_start_string: '<<' | ||
variable_end_string: '>>' | ||
notify: Restart vault-agent-certificates | ||
|
||
- name: Copy vault-agent-certificates.service | ||
ansible.builtin.template: | ||
src: vault-agent-certificates.service.j2 | ||
dest: /etc/systemd/system/vault-agent-certificates.service | ||
mode: '0644' | ||
owner: root | ||
group: root | ||
|
||
- name: Create directory for certificates | ||
ansible.builtin.file: | ||
state: directory | ||
dest: "{{ vault_agent_certificate_directory }}" | ||
mode: '0755' | ||
owner: root | ||
group: root | ||
|
||
- name: Start vault-agent-certificates service | ||
ansible.builtin.systemd: | ||
name: vault-agent-certificates | ||
state: started | ||
enabled: true | ||
daemon_reload: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
vault { | ||
address = "https://vault.rezoleo.fr" | ||
retry { | ||
num_retries = 5 | ||
} | ||
} | ||
|
||
auto_auth { | ||
method { | ||
type = "approle" | ||
|
||
config = { | ||
// create a role in vault with a policy able to "read" the secret | ||
role_id_file_path = "role_id" // to change based on the path of the role_id file | ||
secret_id_file_path = "secret_id" // to change based on the path of the secret_id file | ||
remove_secret_id_file_after_reading = false | ||
} | ||
} | ||
|
||
sinks { | ||
sink { | ||
type = "file" | ||
|
||
config = { | ||
path = "sink-token" | ||
} | ||
} | ||
} | ||
} | ||
|
||
template { | ||
source = "retrieving_cert.tmpl" | ||
destination = "{{ vault_agent_certificate_directory }}/template_output" | ||
perms = "0600" | ||
|
||
exec { | ||
// command used to to reload the service after retrieving the certificate, in the form of ["binary", "arg1", "arg2", ...] | ||
command = {{ vault_agent_service_reload_command | tojson }} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{{content}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
{{with secret "secret/certificat-web"}} | ||
{{ index .Data.data "privkey.pem" | writeToFile "<<vault_agent_certificate_directory>>/privkey.pem" "" "" "0400" }} | ||
{{ index .Data.data "chain.pem" | writeToFile "<<vault_agent_certificate_directory>>/chain.pem" "" "" "0400" }} | ||
{{ index .Data.data "cert.pem" | writeToFile "<<vault_agent_certificate_directory>>/cert.pem" "" "" "0400" }} | ||
{{ index .Data.data "fullchain.pem" | writeToFile "<<vault_agent_certificate_directory>>/fullchain.pem" "" "" "0400" }} | ||
{{ index .Data.data "privkey.pem" }} | ||
{{ index .Data.data "chain.pem" }} | ||
{{ index .Data.data "cert.pem" }} | ||
{{ index .Data.data "fullchain.pem" }} | ||
{{end}} |
12 changes: 12 additions & 0 deletions
12
roles/vault_agent/templates/vault-agent-certificates.service.j2
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
[Unit] | ||
Description=Vault Agent - retrieve Let's Encrypt certificates from Vault | ||
After=network.target | ||
|
||
[Service] | ||
Type=notify | ||
WorkingDirectory={{ vault_agent_working_directory }} | ||
ExecStart=/usr/bin/vault agent -config=agent-config.hcl | ||
Restart=always | ||
|
||
[Install] | ||
WantedBy=multi-user.target |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Explanation: Ansible - Vault pinning | ||
Package: vault | ||
Pin: version {{ vault_agent_vault_version }}-* | ||
Pin-Priority: 1000 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe not for this PR as our needs are simple and Vault-Agent should be mostly compatible with any version of Vault server (https://developer.hashicorp.com/vault/docs/agent-and-proxy/agent/versions), but at some point we might want to pin a specific version of packages, especially Vault since it's a critical part of our infrastructure and we should check changelogs and ensure backups before upgrades.
The Ansible docs hint at
vault=1.18.2
for example, however this doesn't prevent someone on the server from runningapt update && apt upgrade
and installing a different version, as this does not pin it for apt itself.The surefire way to pin a version is to create a
/etc/apt/preferences.d/vault.pref
: