Merge lp:~mitchburton/landscape-charm/deployment_mode into lp:landscape-charm

[Mitch Burton]

Add deployment_mode and additional_service_config config vars

This includes changes needed to be able to set up a juju deployment in SaaS/production mode. Here's the config I've been using - feel free to change it:

landscape-server:
  openid_provider_url: https://login.ubuntu.com/
  openid_logout_url: https://login.ubuntu.com/+logout
  admin_email: <Ubuntu One email>
  admin_name: <Your name>
  admin_password: thisisatest
  additional_service_config: |
    [stores]
    main = landscape_production_main
    account-1 = landscape_production_account_1
    resource-1 = landscape_production_resource_1
    package = landscape_production_package
    session = landscape_production_session
    session-autocommit = landscape_production_session?isolation=autocommit
    knowledge = landscape_production_knowledge

steps to test:
1. deploy by running the following:

charmcraft pack
juju deploy ./landscape-server_ubuntu-22.04-amd64-arm64_ubuntu-20.04-amd64-arm64.charm --config landscape-server.yaml
juju deploy postgresql --config postgresql.yaml --series bionic
juju deploy haproxy --config haproxy.yaml --series focal
juju deploy rabbitmq-server --series focal
juju relate landscape-server:db postgresql:db-admin
juju relate landscape-server haproxy
juju relate landscape-server rabbitmq-server

2. Wait until everything is in ready status
3. update the landscape-server application config (can be production or staging):

juju config landscape-server deployment_mode=production

4. Wait for config-changed to finish
5. hook up your user to your SSO id:

juju ssh postgresql/0
sudo -u postgres psql landscape_production_main
UPDATE person SET identity='<Ubuntu One ID URL>';

6. If you want, give yourself admin privileges while you're there:

INSERT INTO person_access VALUES (1, 6, NULL);

7. Poke around by going to the HAProxy unit's IP, make sure things in general are working

[lp:~mitchburton/landscape-charm/deployment_mode]

434. By Mitch Burton on 2023-03-10

Add bundle.yaml for quick testing; update README

[Kevin Nasto (silverdrake11)]

LGTM+1

review: Approve

=== modified file 'README.md'
--- README.md	2022-12-02 00:45:26 +0000
+++ README.md	2023-03-10 18:34:17 +0000
@@ -33,7 +33,7 @@
 ## Configuration
 
 Landscape requires configuration of a license file before deployment.
-Please sign in to your "hosted account" at
+Please sign in to your "SaaS account" at
 [https://landscape.canonical.com](https://landscape.canonical.com) to
 download your license file. It can be found by following the link on
 the left side of the page: "access the Landscape On Premises archive."
@@ -44,7 +44,7 @@
 deployed landscape-server application:
 
 ```bash
-juju config landscape-server "license-file=$(cat license-file"
+juju config landscape-server "license_file=$(cat license-file)"
 ```
 
 ### SSL
@@ -63,4 +63,12 @@
 
 Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines
 on enhancements to this charm following best practice guidelines, and
-`CONTRIBUTING.md` for developer guidance.
 \ No newline at end of file
+`CONTRIBUTING.md` for developer guidance.
+
+When developing the charm, here's a quick way to test out changes as
+they would be deployed by `landscape-scalable`:
+
+```bash
+charmcraft pack
+juju deploy ./bundle.yaml
+```
 \ No newline at end of file
 
=== added file 'bundle.yaml'
--- bundle.yaml	1970-01-01 00:00:00 +0000
+++ bundle.yaml	2023-03-10 18:34:17 +0000
@@ -0,0 +1,32 @@
+description: Landscape Scalable
+applications:
+  postgresql:
+    series: focal
+    charm: ch:postgresql
+    num_units: 1
+    options:
+      extra_packages: python3-apt postgresql-contrib postgresql-.*-debversion postgresql-plpython3-*
+      max_connections: 500
+      max_prepared_transactions: 500
+  rabbitmq-server:
+    series: focal
+    charm: ch:rabbitmq-server
+    num_units: 1
+  haproxy:
+    series: focal
+    charm: ch:haproxy
+    num_units: 1
+    expose: true
+    options:
+      default_timeouts: "queue 60000, connect 5000, client 120000, server 120000"
+      services: ""
+      ssl_cert: SELFSIGNED
+      global_default_bind_options: "no-tlsv10"
+  landscape-server:
+    series: jammy
+    charm: ./landscape-server_ubuntu-22.04-amd64-arm64_ubuntu-20.04-amd64-arm64.charm
+    num_units: 1
+relations:
+  - [landscape-server, rabbitmq-server]
+  - [landscape-server, haproxy]
+  - ["landscape-server:db", "postgresql:db-admin"]
 
=== modified file 'config.yaml'
--- config.yaml	2023-01-27 20:37:12 +0000
+++ config.yaml	2023-03-10 18:34:17 +0000
@@ -140,3 +140,16 @@
     description: |
       Comma-separated list of nagios servicegroups. If empty, the
       nagios-context will be used as the servicegroup.
+  deployment_mode:
+    type: string
+    default: standalone
+    description: |
+      Landscape Server tenancy mode - do not modify unless you are able
+      to provide the additional configuration required to run
+      Landscape in SaaS mode.
+  additional_service_config:
+    type: string
+    default:
+    description: |
+      Additional service.conf settings to be merged with the default
+      configuration.
 
=== modified file 'src/charm.py'
--- src/charm.py	2023-01-27 20:37:12 +0000
+++ src/charm.py	2023-03-10 18:34:17 +0000
@@ -36,8 +36,8 @@
     ActiveStatus, BlockedStatus, Relation, MaintenanceStatus, WaitingStatus)
 
 from settings_files import (
-    prepend_default_settings, update_default_settings, update_service_conf,
-    write_license_file, write_ssl_cert)
+    configure_for_deployment_mode, merge_service_conf, prepend_default_settings,
+    update_default_settings, update_service_conf, write_license_file, write_ssl_cert)
 
 logger = logging.getLogger(__name__)
 
@@ -136,6 +136,7 @@
         })
         self._stored.set_default(leader_ip="")
         self._stored.set_default(running=False)
+        self._stored.set_default(paused=False)
         self._stored.set_default(default_root_url="")
         self._stored.set_default(account_bootstrapped=False)
 
@@ -193,6 +194,16 @@
         if isinstance(prev_status, BlockedStatus):
             self.unit.status = prev_status
 
+        # Update additional configuration
+        deployment_mode = self.model.config.get("deployment_mode")
+        update_service_conf({"global": {"deployment-mode": deployment_mode}})
+
+        configure_for_deployment_mode(deployment_mode)
+
+        additional_config = self.model.config.get("additional_service_config")
+        if additional_config:
+            merge_service_conf(additional_config)
+
         self._update_ready_status(restart_services=True)
 
     def _on_install(self, event: InstallEvent) -> None:
@@ -264,6 +275,10 @@
             self.unit.status = ActiveStatus("Unit is ready")
             return
 
+        if self._stored.paused:
+            self.unit.status = MaintenanceStatus("Services stopped")
+            return
+
         self._stored.running = self._start_services()
 
     def _start_services(self) -> bool:
@@ -273,6 +288,7 @@
         """
         self.unit.status = MaintenanceStatus("Starting services")
         is_leader = self.unit.is_leader()
+        deployment_mode = self.model.config.get("deployment_mode")
 
         update_default_settings({
             "RUN_ALL": "no",
@@ -285,6 +301,7 @@
             "RUN_CRON": "yes" if is_leader else "no",
             "RUN_PACKAGESEARCH": "yes" if is_leader else "no",
             "RUN_PACKAGEUPLOADSERVER": "yes" if is_leader else "no",
+            "RUN_PPPA_PROXY": "yes" if deployment_mode != "standalone" else "no",
         })
 
         logger.info("Starting services")
@@ -800,6 +817,7 @@
         else:
             self.unit.status = MaintenanceStatus("Services stopped")
             self._stored.running = False
+            self._stored.paused = True
 
     def _resume(self, event: ActionEvent):
         self.unit.status = MaintenanceStatus("Starting services")
@@ -820,6 +838,7 @@
             event.fail("Failed to start services: %s", start_result.stdout)
         else:
             self._stored.running = True
+            self._stored.paused = False
             self.unit.status = ActiveStatus("Unit is ready")
             self._update_ready_status()
 
 
=== modified file 'src/settings_files.py'
--- src/settings_files.py	2023-01-03 22:10:55 +0000
+++ src/settings_files.py	2023-03-10 18:34:17 +0000
@@ -11,6 +11,8 @@
 from urllib.request import urlopen
 from urllib.error import URLError
 
+CONFIGS_DIR = "/opt/canonical/landscape/configs"
+
 DEFAULT_SETTINGS = "/etc/default/landscape-server"
 
 LICENSE_FILE = "/etc/landscape/license.txt"
@@ -32,6 +34,30 @@
     pass
 
 
+def configure_for_deployment_mode(mode: str) -> None:
+    """
+    Places files where Landscape expects to find them for different deployment
+    modes.
+    """
+    if mode == "standalone":
+        return
+
+    os.symlink(os.path.join(CONFIGS_DIR, "standalone"), os.path.join(CONFIGS_DIR, mode))
+
+
+def merge_service_conf(other: str) -> None:
+    """
+    Merges `other` into the Landscape Server configuration file,
+    overwriting existing config.
+    """
+    config = ConfigParser()
+    config.read(SERVICE_CONF)
+    config.read_string(other)
+
+    with open(SERVICE_CONF, "w") as config_fp:
+        config.write(config_fp)
+
+
 def prepend_default_settings(updates: dict) -> None:
     """
     Adds `updates` to the start of the Landscape Server default
 
=== modified file 'tests/test_settings_files.py'
--- tests/test_settings_files.py	2023-01-03 22:10:55 +0000
+++ tests/test_settings_files.py	2023-03-10 18:34:17 +0000
@@ -9,9 +9,9 @@
 from urllib.error import URLError
 
 from settings_files import (
-    LICENSE_FILE, LicenseFileReadException, SSLCertReadException,
-    prepend_default_settings, update_default_settings, update_service_conf,
-    write_license_file, write_ssl_cert)
+    CONFIGS_DIR, LICENSE_FILE, LicenseFileReadException, SSLCertReadException,
+    configure_for_deployment_mode, merge_service_conf, prepend_default_settings,
+    update_default_settings, update_service_conf, write_license_file, write_ssl_cert)
 
 
 class CapturingBytesIO(BytesIO):
@@ -44,6 +44,83 @@
         return super().close(*args, **kwargs)
 
 
+class ConfigureForDeploymentModeTestCase(TestCase):
+
+    @patch("os.symlink")
+    def test_configure_for_deployment_mode_standalone(self, symlink_mock):
+        """
+        The default mode, "standalone", should result in no changes.
+        """
+        configure_for_deployment_mode("standalone")
+
+        symlink_mock.assert_not_called()
+
+    @patch("os.symlink")
+    def test_configure_for_deployment_mode_other(self, symlink_mock):
+        """
+        Modes other than the magic "standalone" should symlink to a similarly named directory.
+        """
+        configure_for_deployment_mode("elite_dangerous")
+
+        symlink_mock.assert_called_once_with(
+            os.path.join(CONFIGS_DIR, "standalone"),
+            os.path.join(CONFIGS_DIR, "elite_dangerous")
+        )
+
+
+class MergeServiceConfTestCase(TestCase):
+
+    def test_merge_service_conf_new(self):
+        """
+        Tests that a new section and key are created in the existing
+        config file.
+        """
+        old_conf = "[global]\nfoo = bar\nbat = baz\n"
+        infile = StringIO(old_conf)
+        outfile = CapturingStringIO()
+        new_conf = "[new]\ncat = meow\n"
+
+        i = 0
+
+        def return_conf(path, *args, **kwargs):
+            nonlocal i
+            retval = (infile, outfile)[i]
+            i += 1
+            return retval
+
+        with patch("builtins.open") as open_mock:
+            open_mock.side_effect = return_conf
+            merge_service_conf(new_conf)
+
+        self.assertIn(old_conf, outfile.captured)
+        self.assertIn(new_conf, outfile.captured)
+
+    def test_merge_service_conf_override(self):
+        """
+        Tests that a provided config overrides values in the old config.
+        """
+        old_conf = "[global]\nleft = true\ntouched = false\n"
+        infile = StringIO(old_conf)
+        outfile = CapturingStringIO()
+        new_conf = "[global]\ntouched = true\n"
+
+        i = 0
+
+        def return_conf(path, *args, **kwargs):
+            nonlocal i
+            retval = (infile, outfile)[i]
+            i += 1
+            return retval
+
+        with patch("builtins.open") as open_mock:
+            open_mock.side_effect = return_conf
+            merge_service_conf(new_conf)
+
+        self.assertIn("left = true", outfile.captured)
+        self.assertIn("touched = true", outfile.captured)
+        self.assertNotIn("touched = false", outfile.captured)
+
+
 class PrependDefaultSettingsTestCase(TestCase):
 
     def test_prepend(self):