vade-cli 0.1.1

A command-line tool to deploy applications on Linux servers
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

{% include "shared/header.py.j2" %}
{% include "shared/create-tasks.py.j2" %}

{%- if vade.internal.app.paths.systemd_units %}
###
# Sanity checks
###

{%- for unit in vade.internal.app.paths.systemd_units %}
# This unit must not collide with a pre-existing, unmanaged unit file
# (an existing unit is considered unmanaged if it has no copy in the app's active deployment)
if host.get_fact(File, path="{{ unit.installed_path }}") and not host.get_fact(File, path="{{ unit.active_path }}"):
    raise DeployError(
        "Your application wants to install the systemd unit `{{ unit.name }}`, but "
        "`{{ unit.installed_path }}` already exists and is not managed by vade. "
        "If removing the existing unit is not possible, try using a different app name."
    )
{%- endfor %}
{%- endif %}

###
# Initialize deployment candidate
###

files.directory(
    name="Delete stale candidate deployment if it exists",
    path="{{ vade.internal.app.paths.deployment_candidate }}",
    present=False,
)

files.directory(
    name="Create candidate deployment directory",
    path="{{ vade.internal.app.paths.deployment_candidate }}",
    user="{{ vade.app.username }}",
    group="{{ vade.app.username }}",
    mode="755",
)

{% if vade.internal.app.paths.artifacts_local is defined %}
files.rsync(
    name="Sync local artifacts to candidate deployment",
    src="{{ vade.internal.app.paths.artifacts_local }}/",
    dest="{{ vade.internal.app.paths.artifacts_candidate }}",
    flags=["-a", "--delete", "--link-dest={{ vade.app.paths.artifacts }}"],
    _sudo=True,
    _sudo_user="{{ vade.app.username }}",
)
{% endif %}

{% for unit in vade.internal.app.paths.systemd_units %}
files.put(
    name="Upload systemd unit to candidate deployment",
    src="{{ unit.local_path }}",
    dest="{{ unit.candidate_path }}",
    user="{{ vade.app.username }}",
    group="{{ vade.app.username }}",
    mode="644",
)
{% endfor %}

{% if vade.internal.app.paths.caddyfile_local is defined %}
files.put(
    name="Upload Caddyfile to candidate deployment",
    src="{{ vade.internal.app.paths.caddyfile_local }}",
    dest="{{ vade.internal.app.paths.caddyfile_candidate }}",
    user="{{ vade.app.username }}",
    group="{{ vade.app.username }}",
    mode="644",
)
{% endif %}

###
# Assign ports and bake them into the candidate's files (if necessary)
###
if not host.get_fact(Which, command="python3"):
    raise DeployError(
        "vade needs `python3` on the target host to assign ports for `{{ vade.app.name }}`, "
        "but it was not found. Please install python3 and try again."
    )

server.shell(
    name="Assign ports and substitute them into the candidate's templated files",
    commands=[
        "python3 {{ vade.internal.assign_ports_script.remote }}"
        " {{ vade.internal.app.paths.deployment_active }}/assigned-ports"
        " {{ vade.internal.app.paths.deployment_candidate }}"
        " {{ vade.app.username }}"
        {%- if vade.internal.app.paths.caddyfile_candidate is defined %}
        " {{ vade.internal.app.paths.caddyfile_candidate }}"
        {%- endif %}
        {%- for unit in vade.internal.app.paths.systemd_units %}
        " {{ unit.candidate_path }}"
        {%- endfor %}
    ],
)

files.directory(
    name="Delete previous deployment",
    path="{{ vade.internal.app.paths.deployment_previous }}",
    present=False,
)

###
# Promote deployment candidate to active deployment
###

server.shell(
    name="Promote deployment candidate (rolling back on failure)",
    commands=r"""
# The weird structure of the script is actually a poor man's try/catch in bash
set -uo pipefail

bash <<'__VADE_PROMOTE__'
set -euo pipefail
{% with src_dir=vade.internal.app.paths.deployment_candidate, downgraded_dir=vade.internal.app.paths.deployment_previous %}{% include "deploy-promote.sh.j2" %}{% endwith %}
__VADE_PROMOTE__
promote_status=$?

if [ "$promote_status" -eq 0 ]; then
  exit 0
fi

echo "Promotion failed (exit $promote_status), rolling back to the previous deployment..." >&2
bash <<'__VADE_ROLLBACK__'
set -euo pipefail
{% with src_dir=vade.internal.app.paths.deployment_previous %}{% include "deploy-promote.sh.j2" %}{% endwith %}
__VADE_ROLLBACK__
rollback_status=$?

if [ "$rollback_status" -ne 0 ]; then
  echo "FATAL: rollback failed (exit $rollback_status). The host may be in an inconsistent state and needs manual recovery." >&2
  exit 2
fi

echo "Deploying failed and was rolled back" >&2
exit 1
""",
)