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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
"""ansible enables running on first boot either ansible-pull"""
import abc
import logging
import os
import re
import sys
from copy import deepcopy
from textwrap import dedent
from typing import Optional
from cloudinit.cloud import Cloud
from cloudinit.config.schema import MetaSchema, get_meta_doc
from cloudinit.distros import ALL_DISTROS
from cloudinit.settings import PER_INSTANCE
from cloudinit.subp import subp, which
from cloudinit.util import Version, get_cfg_by_path
meta: MetaSchema = {
"id": "cc_ansible",
"name": "Ansible",
"title": "Configure ansible for instance",
"frequency": PER_INSTANCE,
"distros": [ALL_DISTROS],
"activate_by_schema_keys": ["ansible"],
"description": dedent(
"""\
This module provides ``ansible`` integration for
augmenting cloud-init's configuration of the local
node.
This module installs ansible during boot and
then uses ``ansible-pull`` to run the playbook
repository at the remote URL.
"""
),
"examples": [
dedent(
"""\
#cloud-config
ansible:
install-method: distro
pull:
url: "https://github.com/holmanb/vmboot.git"
playbook-name: ubuntu.yml
"""
),
dedent(
"""\
#cloud-config
ansible:
package-name: ansible-core
install-method: pip
pull:
url: "https://github.com/holmanb/vmboot.git"
playbook-name: ubuntu.yml
"""
),
],
}
__doc__ = get_meta_doc(meta)
LOG = logging.getLogger(__name__)
class AnsiblePull(abc.ABC):
cmd_version: list = []
cmd_pull: list = []
env: dict = os.environ.copy()
def get_version(self) -> Optional[Version]:
stdout, _ = subp(self.cmd_version, env=self.env)
first_line = stdout.splitlines().pop(0)
matches = re.search(r"([\d\.]+)", first_line)
if matches:
version = matches.group(0)
return Version.from_str(version)
return None
def pull(self, *args) -> str:
stdout, _ = subp([*self.cmd_pull, *args], env=self.env)
return stdout
def check_deps(self):
if not self.is_installed():
raise ValueError("command: ansible is not installed")
@abc.abstractmethod
def is_installed(self):
pass
@abc.abstractmethod
def install(self, pkg_name: str):
pass
class AnsiblePullPip(AnsiblePull):
def __init__(self):
self.cmd_pull = ["ansible-pull"]
self.cmd_version = ["ansible-pull", "--version"]
self.env["PATH"] = ":".join([self.env["PATH"], "/root/.local/bin/"])
def install(self, pkg_name: str):
"""should cloud-init grow an interface for non-distro package
managers? this seems reusable
"""
if not self.is_installed():
subp(["python3", "-m", "pip", "install", "--user", pkg_name])
def is_installed(self) -> bool:
stdout, _ = subp(["python3", "-m", "pip", "list"])
return "ansible" in stdout
class AnsiblePullDistro(AnsiblePull):
def __init__(self, distro):
self.cmd_pull = ["ansible-pull"]
self.cmd_version = ["ansible-pull", "--version"]
self.distro = distro
def install(self, pkg_name: str):
if not self.is_installed():
self.distro.install_packages(pkg_name)
def is_installed(self) -> bool:
return bool(which("ansible"))
def handle(name: str, cfg: dict, cloud: Cloud, _, __):
ansible_cfg: dict = cfg.get("ansible", {})
if ansible_cfg:
validate_config(ansible_cfg)
install = ansible_cfg["install-method"]
pull_cfg = ansible_cfg.get("pull")
if pull_cfg:
ansible: AnsiblePull
if install == "pip":
ansible = AnsiblePullPip()
else:
ansible = AnsiblePullDistro(cloud.distro)
ansible.install(ansible_cfg["package-name"])
ansible.check_deps()
run_ansible_pull(ansible, deepcopy(pull_cfg))
def validate_config(cfg: dict):
required_keys = {
"install-method",
"package-name",
"pull/url",
"pull/playbook-name",
}
for key in required_keys:
if not get_cfg_by_path(cfg, key):
raise ValueError(f"Invalid value config key: '{key}'")
install = cfg["install-method"]
if install not in ("pip", "distro"):
raise ValueError("Invalid install method {install}")
def filter_args(cfg: dict) -> dict:
"""remove boolean false values"""
return {key: value for (key, value) in cfg.items() if value is not False}
def run_ansible_pull(pull: AnsiblePull, cfg: dict):
playbook_name: str = cfg.pop("playbook-name")
v = pull.get_version()
if not v:
LOG.warning("Cannot parse ansible version")
elif v < Version(2, 7, 0):
# diff was added in commit edaa0b52450ade9b86b5f63097ce18ebb147f46f
if cfg.get("diff"):
raise ValueError(
f"Ansible version {v.major}.{v.minor}.{v.patch}"
"doesn't support --diff flag, exiting."
)
stdout = pull.pull(
*[
f"--{key}={value}" if value is not True else f"--{key}"
for key, value in filter_args(cfg).items()
],
playbook_name,
)
if stdout:
sys.stdout.write(f"{stdout}")
|
