import os
import re
import shlex
+from subprocess import CalledProcessError
import tempfile
import time
import uuid
-from subprocess import CalledProcessError
-
-import paramiko
-import n2vc.exceptions
from juju.client import client
+import n2vc.exceptions
+import paramiko
+import asyncio
arches = [
[re.compile(r"amd64|x86_64"), "amd64"],
[re.compile(r"aarch64"), "arm64"],
[re.compile(r"ppc64|ppc64el|ppc64le"), "ppc64el"],
[re.compile(r"s390x?"), "s390x"],
-
]
netfilter-persistent save
"""
+
+class AsyncSSHProvisioner:
+ """Provision a manually created machine via SSH."""
+
+ user = ""
+ host = ""
+ private_key_path = ""
+
+ def __init__(self, user, host, private_key_path, log=None):
+ self.host = host
+ self.user = user
+ self.private_key_path = private_key_path
+ self.log = log if log else logging.getLogger(__name__)
+
+ async def _scp(self, source_file, destination_file):
+ """Execute an scp command. Requires a fully qualified source and
+ destination.
+
+ :param str source_file: Path to the source file
+ :param str destination_file: Path to the destination file
+ """
+ cmd = [
+ "scp",
+ "-i",
+ os.path.expanduser(self.private_key_path),
+ "-o",
+ "StrictHostKeyChecking=no",
+ "-q",
+ "-B",
+ ]
+ destination = "{}@{}:{}".format(self.user, self.host, destination_file)
+ cmd.extend([source_file, destination])
+ process = await asyncio.create_subprocess_exec(*cmd)
+ await process.wait()
+ if process.returncode != 0:
+ raise CalledProcessError(returncode=process.returncode, cmd=cmd)
+
+ async def _ssh(self, command):
+ """Run a command remotely via SSH.
+
+ :param str command: The command to execute
+ :return: tuple: The stdout and stderr of the command execution
+ :raises: :class:`CalledProcessError` if the command fails
+ """
+
+ destination = "{}@{}".format(self.user, self.host)
+ cmd = [
+ "ssh",
+ "-i",
+ os.path.expanduser(self.private_key_path),
+ "-o",
+ "StrictHostKeyChecking=no",
+ "-q",
+ destination,
+ ]
+ cmd.extend([command])
+ process = await asyncio.create_subprocess_exec(
+ *cmd, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE
+ )
+ stdout, stderr = await process.communicate()
+
+ if process.returncode != 0:
+ output = stderr.decode("utf-8").strip()
+ raise CalledProcessError(
+ returncode=process.returncode, cmd=cmd, output=output
+ )
+ return (stdout.decode("utf-8").strip(), stderr.decode("utf-8").strip())
+
+ async def _init_ubuntu_user(self):
+ """Initialize the ubuntu user.
+
+ :return: bool: If the initialization was successful
+ :raises: :class:`CalledProcessError` if the _ssh command fails
+ """
+ retry = 10
+ attempts = 0
+ delay = 15
+ while attempts <= retry:
+ try:
+ attempts += 1
+ # Attempt to establish a SSH connection
+ stdout, stderr = await self._ssh("sudo -n true")
+ break
+ except CalledProcessError as e:
+ self.log.debug(
+ "Waiting for VM to boot, sleeping {} seconds".format(delay)
+ )
+ if attempts > retry:
+ raise e
+ else:
+ await asyncio.sleep(delay)
+ # Slowly back off the retry
+ delay += 15
+
+ # Infer the public key
+ public_key = None
+ public_key_path = "{}.pub".format(self.private_key_path)
+
+ if not os.path.exists(public_key_path):
+ raise FileNotFoundError(
+ "Public key '{}' doesn't exist.".format(public_key_path)
+ )
+
+ with open(public_key_path, "r") as f:
+ public_key = f.readline()
+
+ script = INITIALIZE_UBUNTU_SCRIPT.format(public_key)
+
+ stdout, stderr = await self._run_configure_script(script)
+
+ return True
+
+ async def _detect_hardware_and_os(self):
+ """Detect the target hardware capabilities and OS series.
+
+ :return: str: A raw string containing OS and hardware information.
+ """
+
+ info = {
+ "series": "",
+ "arch": "",
+ "cpu-cores": "",
+ "mem": "",
+ }
+
+ stdout, stderr = await self._run_configure_script(DETECTION_SCRIPT)
+
+ lines = stdout.split("\n")
+ info["series"] = lines[0].strip()
+ info["arch"] = normalize_arch(lines[1].strip())
+
+ memKb = re.split(r"\s+", lines[2])[1]
+
+ # Convert megabytes -> kilobytes
+ info["mem"] = round(int(memKb) / 1024)
+
+ # Detect available CPUs
+ recorded = {}
+ for line in lines[3:]:
+ physical_id = ""
+ print(line)
+
+ if line.find("physical id") == 0:
+ physical_id = line.split(":")[1].strip()
+ elif line.find("cpu cores") == 0:
+ cores = line.split(":")[1].strip()
+
+ if physical_id not in recorded.keys():
+ info["cpu-cores"] += cores
+ recorded[physical_id] = True
+
+ return info
+
+ async def provision_machine(self):
+ """Perform the initial provisioning of the target machine.
+
+ :return: bool: The client.AddMachineParams
+ """
+ params = client.AddMachineParams()
+
+ if await self._init_ubuntu_user():
+ hw = await self._detect_hardware_and_os()
+ params.series = hw["series"]
+ params.instance_id = "manual:{}".format(self.host)
+ params.nonce = "manual:{}:{}".format(
+ self.host, str(uuid.uuid4()), # a nop for Juju w/manual machines
+ )
+ params.hardware_characteristics = {
+ "arch": hw["arch"],
+ "mem": int(hw["mem"]),
+ "cpu-cores": int(hw["cpu-cores"]),
+ }
+ params.addresses = [{"value": self.host, "type": "ipv4", "scope": "public"}]
+
+ return params
+
+ async def install_agent(self, connection, nonce, machine_id, api):
+ """
+ :param object connection: Connection to Juju API
+ :param str nonce: The nonce machine specification
+ :param str machine_id: The id assigned to the machine
+ :param str api: IP of the API_PROXY
+
+ :return: bool: If the initialization was successful
+ """
+ # The path where the Juju agent should be installed.
+ data_dir = "/var/lib/juju"
+
+ # Disabling this prevents `apt-get update` from running initially, so
+ # charms will fail to deploy
+ disable_package_commands = False
+
+ client_facade = client.ClientFacade.from_connection(connection)
+ results = await client_facade.ProvisioningScript(
+ data_dir=data_dir,
+ disable_package_commands=disable_package_commands,
+ machine_id=machine_id,
+ nonce=nonce,
+ )
+
+ """Get the IP of the controller
+
+ Parse the provisioning script, looking for the first apiaddress.
+
+ Example:
+ apiaddresses:
+ - 10.195.8.2:17070
+ - 127.0.0.1:17070
+ - '[::1]:17070'
+ """
+ m = re.search(r"apiaddresses:\n- (\d+\.\d+\.\d+\.\d+):17070", results.script)
+ apiaddress = m.group(1)
+
+ """Add IP Table rule
+
+ In order to route the traffic to the private ip of the Juju controller
+ we use a DNAT rule to tell the machine that the destination for the
+ private address is the public address of the machine where the Juju
+ controller is running in LXD. That machine will have a complimentary
+ iptables rule, routing traffic to the appropriate LXD container.
+ """
+
+ script = IPTABLES_SCRIPT.format(apiaddress, api)
+
+ # Run this in a retry loop, because dpkg may be running and cause the
+ # script to fail.
+ retry = 10
+ attempts = 0
+ delay = 15
+
+ while attempts <= retry:
+ try:
+ attempts += 1
+ stdout, stderr = await self._run_configure_script(script)
+ break
+ except Exception as e:
+ self.log.debug("Waiting for dpkg, sleeping {} seconds".format(delay))
+ if attempts > retry:
+ raise e
+ else:
+ await asyncio.sleep(delay)
+ # Slowly back off the retry
+ delay += 15
+
+ # self.log.debug("Running configure script")
+ await self._run_configure_script(results.script)
+ # self.log.debug("Configure script finished")
+
+ async def _run_configure_script(self, script, root=True):
+ """Run the script to install the Juju agent on the target machine.
+
+ :param str script: The script to be executed
+ """
+ _, tmpFile = tempfile.mkstemp()
+ with open(tmpFile, "w") as f:
+ f.write(script)
+ f.close()
+
+ # copy the local copy of the script to the remote machine
+ await self._scp(tmpFile, tmpFile)
+
+ # run the provisioning script
+ return await self._ssh(
+ "{} /bin/bash {}".format("sudo" if root else "", tmpFile)
+ )
+
+
class SSHProvisioner:
"""Provision a manually created machine via SSH."""
# Read the private key into a paramiko.RSAKey
if os.path.exists(private_key_path):
- with open(private_key_path, 'r') as f:
+ with open(private_key_path, "r") as f:
pkey = paramiko.RSAKey.from_private_key(f)
#######################################################################
)
break
except paramiko.ssh_exception.SSHException as e:
- if 'Error reading SSH protocol banner' == str(e):
+ if "Error reading SSH protocol banner" == str(e):
# Once more, with feeling
ssh.connect(host, port=22, username=user, pkey=pkey)
else:
self.log.debug("Unhandled exception caught: {}".format(e))
raise e
except Exception as e:
- if 'Unable to connect to port' in str(e):
- self.log.debug("Waiting for VM to boot, sleeping {} seconds".format(delay))
+ if "Unable to connect to port" in str(e):
+ self.log.debug(
+ "Waiting for VM to boot, sleeping {} seconds".format(delay)
+ )
if attempts > retry:
raise e
else:
if type(cmd) is not list:
cmd = [cmd]
- cmds = ' '.join(cmd)
- stdin, stdout, stderr = ssh.exec_command(cmds, get_pty=pty)
+ cmds = " ".join(cmd)
+ _, stdout, stderr = ssh.exec_command(cmds, get_pty=pty)
retcode = stdout.channel.recv_exit_status()
if retcode > 0:
output = stderr.read().strip()
- raise CalledProcessError(returncode=retcode, cmd=cmd,
- output=output)
+ raise CalledProcessError(returncode=retcode, cmd=cmd, output=output)
return (
- stdout.read().decode('utf-8').strip(),
- stderr.read().decode('utf-8').strip()
+ stdout.read().decode("utf-8").strip(),
+ stderr.read().decode("utf-8").strip(),
)
def _init_ubuntu_user(self):
try:
# Run w/o allocating a pty, so we fail if sudo prompts for a passwd
ssh = self._get_ssh_client()
- stdout, stderr = self._run_command(ssh, "sudo -n true", pty=False)
+ self._run_command(ssh, "sudo -n true", pty=False)
except paramiko.ssh_exception.AuthenticationException:
raise n2vc.exceptions.AuthenticationFailed(self.user)
except paramiko.ssh_exception.NoValidConnectionsError:
ssh.close()
# Infer the public key
- public_key = None
public_key_path = "{}.pub".format(self.private_key_path)
if not os.path.exists(public_key_path):
ssh = self._get_ssh_client()
self._run_command(
- ssh,
- ["sudo", "/bin/bash -c " + shlex.quote(script)],
- pty=True
+ ssh, ["sudo", "/bin/bash -c " + shlex.quote(script)], pty=True
)
except paramiko.ssh_exception.AuthenticationException as e:
raise e
"""
info = {
- 'series': '',
- 'arch': '',
- 'cpu-cores': '',
- 'mem': '',
+ "series": "",
+ "arch": "",
+ "cpu-cores": "",
+ "mem": "",
}
- stdout, stderr = self._run_command(
- ssh,
- ["sudo", "/bin/bash -c " + shlex.quote(DETECTION_SCRIPT)],
- pty=True,
+ stdout, _ = self._run_command(
+ ssh, ["sudo", "/bin/bash -c " + shlex.quote(DETECTION_SCRIPT)], pty=True,
)
lines = stdout.split("\n")
# Remove extraneous line if DNS resolution of hostname famils
# i.e. sudo: unable to resolve host test-1-mgmtvm-1: Connection timed out
- if 'unable to resolve host' in lines[0]:
+ if "unable to resolve host" in lines[0]:
lines = lines[1:]
- info['series'] = lines[0].strip()
- info['arch'] = normalize_arch(lines[1].strip())
+ info["series"] = lines[0].strip()
+ info["arch"] = normalize_arch(lines[1].strip())
- memKb = re.split(r'\s+', lines[2])[1]
+ memKb = re.split(r"\s+", lines[2])[1]
# Convert megabytes -> kilobytes
- info['mem'] = round(int(memKb) / 1024)
+ info["mem"] = round(int(memKb) / 1024)
# Detect available CPUs
recorded = {}
cores = line.split(":")[1].strip()
if physical_id not in recorded.keys():
- info['cpu-cores'] += cores
+ info["cpu-cores"] += cores
recorded[physical_id] = True
return info
ssh = self._get_ssh_client()
hw = self._detect_hardware_and_os(ssh)
- params.series = hw['series']
+ params.series = hw["series"]
params.instance_id = "manual:{}".format(self.host)
params.nonce = "manual:{}:{}".format(
- self.host,
- str(uuid.uuid4()), # a nop for Juju w/manual machines
+ self.host, str(uuid.uuid4()), # a nop for Juju w/manual machines
)
params.hardware_characteristics = {
- 'arch': hw['arch'],
- 'mem': int(hw['mem']),
- 'cpu-cores': int(hw['cpu-cores']),
+ "arch": hw["arch"],
+ "mem": int(hw["mem"]),
+ "cpu-cores": int(hw["cpu-cores"]),
}
- params.addresses = [{
- 'value': self.host,
- 'type': 'ipv4',
- 'scope': 'public',
- }]
+ params.addresses = [
+ {"value": self.host, "type": "ipv4", "scope": "public"}
+ ]
except paramiko.ssh_exception.AuthenticationException as e:
raise e
- 127.0.0.1:17070
- '[::1]:17070'
"""
- m = re.search('apiaddresses:\n- (\d+\.\d+\.\d+\.\d+):17070', results.script)
+ m = re.search(r"apiaddresses:\n- (\d+\.\d+\.\d+\.\d+):17070", results.script)
apiaddress = m.group(1)
"""Add IP Table rule
self._run_configure_script(script)
break
except Exception as e:
- self.log.debug("Waiting for dpkg, sleeping {} seconds".format(delay))
- if attempts > retry:
- raise e
- else:
- time.sleep(delay)
- # Slowly back off the retry
- delay += 15
+ self.log.debug("Waiting for dpkg, sleeping {} seconds".format(delay))
+ if attempts > retry:
+ raise e
+ else:
+ time.sleep(delay)
+ # Slowly back off the retry
+ delay += 15
# self.log.debug("Running configure script")
self._run_configure_script(results.script)
# self.log.debug("Configure script finished")
-
-
def _run_configure_script(self, script: str):
"""Run the script to install the Juju agent on the target machine.
if the upload fails
"""
_, tmpFile = tempfile.mkstemp()
- with open(tmpFile, 'w') as f:
+ with open(tmpFile, "w") as f:
f.write(script)
try:
# get ssh client
- ssh = self._get_ssh_client(
- user="ubuntu",
- )
+ ssh = self._get_ssh_client(user="ubuntu",)
# copy the local copy of the script to the remote machine
sftp = paramiko.SFTPClient.from_transport(ssh.get_transport())
sftp.put(
- tmpFile,
- tmpFile,
+ tmpFile, tmpFile,
)
# run the provisioning script
- stdout, stderr = self._run_command(
- ssh,
- "sudo /bin/bash {}".format(tmpFile),
+ self._run_command(
+ ssh, "sudo /bin/bash {}".format(tmpFile),
)
except paramiko.ssh_exception.AuthenticationException as e:
projects / osm / N2VC.git / blobdiff