Skip to content

Commit 38e87c2

Browse files
authored
Fix Vultr startup script JSON serialization issues (#14853)
* Fix Vultr startup script JSON serialization error The startup_script module was failing with "Object of type 'bytes' is not JSON serializable" because the lookup('template', ...) was returning bytes instead of a string. Added | string filter to explicitly convert the template result to a string, matching the pattern used by the DigitalOcean cloud provider. Also simplified from multiline block format to inline format for consistency with other cloud providers. Fixes the error: "Object of type 'bytes' is not JSON serializable by the 'tagless' profile." * Add string filters to template lookups in cloud-init base template Added | string filters to lookup() calls in the cloud-init base template to ensure consistent string handling across all cloud providers. The Vultr startup_script module requires all values to be JSON-serializable strings, and lookup() can return bytes in some contexts. This change ensures that both the SSH config template lookup and the SSH public key file lookup explicitly return strings. This is a defensive fix that improves compatibility with strict JSON serialization requirements in some Ansible modules, while remaining backward compatible with existing cloud providers. Related to: vultr.cloud.startup_script JSON serialization requirements * Use two-step fact assignment for Vultr startup script Changed to set the cloud-init script as a fact first, then reference that fact in the startup_script module. This follows the pattern used by the Linode provider and avoids JSON serialization issues with nested template lookups. This approach ensures the template is fully evaluated and stored as a string before being passed to the vultr.cloud.startup_script module, which then base64-encodes it for the API. Related to: JSON serialization with "tagless" profile in Ansible 2.19+
1 parent 5655bcd commit 38e87c2

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

files/cloud-init/base.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ users:
3030
shell: /bin/bash
3131
lock_passwd: true
3232
ssh_authorized_keys:
33-
- "{{ lookup('file', SSH_keys.public) }}"
33+
- "{{ lookup('file', SSH_keys.public) | string }}"
3434

3535
write_files:
3636
- path: /etc/ssh/sshd_config
3737
content: |
38-
{{ lookup('template', 'files/cloud-init/sshd_config') | indent(width=6, first=True) }}
38+
{{ lookup('template', 'files/cloud-init/sshd_config') | string | indent(width=6, first=True) }}
3939

4040
runcmd:
4141
- set -x

roles/cloud-vultr/tasks/main.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
import_tasks: prompts.yml
44

55
- block:
6+
- name: Set cloud-init script as fact
7+
set_fact:
8+
algo_cloud_init_script: "{{ lookup('template', 'files/cloud-init/base.yml') }}"
9+
610
- name: Creating a firewall group
711
vultr.cloud.firewall_group:
812
name: "{{ algo_server_name }}"
@@ -28,8 +32,7 @@
2832
- name: Upload the startup script
2933
vultr.cloud.startup_script:
3034
name: algo-startup
31-
script: |
32-
{{ lookup('template', 'files/cloud-init/base.yml') }}
35+
script: "{{ algo_cloud_init_script }}"
3336

3437
- name: Creating a server
3538
vultr.cloud.instance:

0 commit comments

Comments
 (0)