Merge lp:~bjornt/landscape-charm/deploy-landscape-client into lp:~landscape/landscape-charm/trunk

[Björn Tillenius]

Add a script for deploying landscape-client after deploying landscape-server.

The client will be configured with the right URLs and SSL certficate, so
that the deployed client will register with the deployed server.

Only the suboordinate server will be deployed. To actually get some
clients registered you have to deploy some service (like ubuntu)
yourself and relate landscape-client to it.

Add a script for deploying landscape-client after deploying landscape-server.

The client will be configured with the right URLs and SSL certficate, so
that the deployed client will register with the deployed server.

Only the suboordinate server will be deployed. To actually get some
clients registered you have to deploy some service (like ubuntu)
yourself and relate landscape-client to it.

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 315
Branch: lp:~bjornt/landscape-charm/deploy-landscape-client
Jenkins: https://ci.lscape.net/job/latch-test/1474/

review: Approve (test results)

[Adam Collard (adam-collard)]

I think this code is a bit too long to have it all in just main(), it would benefit from splitting into a few functions e.g.

get_landscape_unit()
get_ssl_cert(landscape_unit)
get_hostname(cert)

[Adam Collard (adam-collard)]

End goal should be to fix #1429046, is this just a step in that direction? Feels like a compromise.

review: Needs Information

[lp:~bjornt/landscape-charm/deploy-landscape-client]

316. By Björn Tillenius on 2015-06-18

Typo.

317. By Björn Tillenius on 2015-06-18

Split out functionality into smaller functions.

318. By Björn Tillenius on 2015-06-18

no ned for a space.

[Björn Tillenius (bjornt)]

I've addressed inline comments and have split up the function into smaller ones.

As explained in IRC, fixing bug 1429046 isn't trivial, so this script is useful in the meantime.

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 318
Branch: lp:~bjornt/landscape-charm/deploy-landscape-client
Jenkins: https://ci.lscape.net/job/latch-test/1483/

review: Approve (test results)

[Adam Collard (adam-collard)]

Script works well, there are a few things I would have done differently but nothing blocking. +1

review: Approve

[Chad Smith (chad.smith)]

+1 nothing but a doc comment and validating the openssl comment Adam made.

review: Approve

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 318
Branch: lp:~bjornt/landscape-charm/deploy-landscape-client
Jenkins: https://ci.lscape.net/job/latch-test/1509/

review: Approve (test results)

[lp:~bjornt/landscape-charm/deploy-landscape-client]

319. By Björn Tillenius on 2015-06-19

Clarify that no relations are added.

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 319
Branch: lp:~bjornt/landscape-charm/deploy-landscape-client
Jenkins: https://ci.lscape.net/job/latch-test/1510/

review: Approve (test results)

[lp:~bjornt/landscape-charm/deploy-landscape-client]

320. By Björn Tillenius on 2015-06-19

No need to pass -e.

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 320
Branch: lp:~bjornt/landscape-charm/deploy-landscape-client
Jenkins: https://ci.lscape.net/job/latch-test/1511/

review: Approve (test results)

=== added file 'dev/deploy-landscape-client'
--- dev/deploy-landscape-client	1970-01-01 00:00:00 +0000
+++ dev/deploy-landscape-client	2015-06-19 09:11:30 +0000
@@ -0,0 +1,133 @@
+#!/usr/bin/python3
+"""
+This script looks at the current Juju environment and generates a
+juju-deployer config for landscape-client that is configured to talk to
+the deployed landscape-server service. The URLs and SSL certificate are
+taken from the deployed landscape-server units.
+
+By default, landscape-client will be deployed, but you can choose to
+only generate the juju-deployer config and deploy manually:
+
+    deploy-landscape-client --no-deploy > landscape-client.yaml
+
+The landscape-client charm is a subordinate one, so you will have to
+related it to a principle services. For example, if you simply want some
+test client, you can deploy 'ubuntu' and relate 'ubuntu' and
+'landscape-client'.
+"""
+
+# This import isn't strictly needed, since we don't need to support
+# Python2, but this makes linting easier, since we have a mix of Python2
+# and Python3 in the charm
+from __future__ import print_function
+
+import argparse
+import os.path
+import shutil
+import subprocess
+import sys
+import tempfile
+
+import yaml
+
+
+def get_landscape_unit():
+    """Get the name of any landscape-server unit."""
+    status = yaml.load(subprocess.check_output(
+        ["juju", "status", "--format", "yaml", "landscape-server"]))
+    units = status["services"]["landscape-server"]["units"]
+    # Any landscape-server unit will do.
+    return next(iter(units.keys()))
+
+
+def get_ssl_cert(landscape_unit, tempdir, ca_cert_name):
+    """Fetch the SSL certificate from the Landscape unit.
+
+    The certficate is saved into tempdir, and the full path is returned.
+    """
+    ca_cert_name = "landscape_server_ca.crt"
+    ca_cert_path = os.path.join(tempdir, ca_cert_name)
+    subprocess.check_call(
+        ["juju", "scp",
+         "{}:/etc/ssl/certs/{}".format(landscape_unit, ca_cert_name),
+         ca_cert_path])
+    return ca_cert_path
+
+
+def get_hostname(ca_cert_path, stderr):
+    """Get the common name from a SSL certificate.
+
+    None is return if there is no CN in the certificate.
+    """
+    ca_subject = subprocess.check_output(
+        ["openssl", "x509", "-in", ca_cert_path, "-subject", "-noout"])
+    for subject in ca_subject.decode("utf-8").split("/"):
+        subject = subject.strip()
+        if subject.startswith("CN="):
+            break
+    else:
+        error_msg = "Couldn't find the common name in {}: {}".format(
+            ca_cert_path, ca_subject)
+        print(error_msg, file=stderr)
+        return None
+
+    _, host = subject.split("=", 1)
+    return host
+
+
+def generate_deploy_config(ca_cert_path, host):
+    """Generate a juju-deployer config.
+
+    Return the YAML config as a string.
+    """
+    ca_base64 = subprocess.check_output(
+        ["openssl", "base64", "-in", ca_cert_path]).decode("utf-8")
+    deployer_config = {
+        "landscape-client": {
+            "series": "trusty",
+            "services": {
+                "landscape-client": {
+                    "charm": "cs:trusty/landscape-client",
+                    "options": {
+                        "account-name": "standalone",
+                        "url": "https://{}/message-system".format(host),
+                        "ping-url": "http://{}/ping".format(host),
+                        "ssl-public-key": "base64:{}".format(ca_base64),
+                        }}}}}
+    return yaml.safe_dump(deployer_config)
+
+
+def main(args, stdout=sys.stdout, stderr=sys.stderr):
+    tempdir = tempfile.mkdtemp()
+    landscape_unit = get_landscape_unit()
+
+    ca_cert_name = "landscape_server_ca.crt"
+    print(
+        "Copying {} from {}".format(ca_cert_name, landscape_unit), file=stderr)
+    ca_cert_path = get_ssl_cert(landscape_unit, tempdir, ca_cert_name)
+
+    host = get_hostname(ca_cert_path, stderr)
+    if host is None:
+        return 1
+
+    print("Generating deployer config.", file=stderr)
+    yaml_config = generate_deploy_config(ca_cert_path, host)
+    config_path = os.path.join(tempdir, "landscape-client.yaml")
+    with open(config_path, "w") as f:
+        f.write(yaml_config)
+    print(yaml_config, file=stdout)
+
+    if args.deploy:
+        print("Deploying landscape-client.", file=stderr)
+        subprocess.check_call(["juju-deployer", "-c", config_path])
+    print("Cleaning up {}".format(tempdir), file=stderr)
+    shutil.rmtree(tempdir)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument(
+        "--no-deploy", dest="deploy", action="store_false", default=True,
+        help="Only generate deployer config, don't deploy service.")
+    args = parser.parse_args()
+    sys.exit(main(args))