Merge ~jk0ne/charm-k8s-discourse/+git/charm-k8s-discourse:master into charm-k8s-discourse:master

[Jay Kuri]

Add readinessProbe. Return charm to stateless, update enable_local_redis config option to be false by default.

This is a good point for review, as this, with the discourse image builder, is a fully working charm.

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Tom Haddon (mthaddon)]

Some comments and questions inline.

review: Needs Fixing

[Jay Kuri (jk0ne)]

Additional details inline.

8fa0a6c... by Jay Kuri on 2020-07-09

Remove enable_local_redis, other minor tweaks

e30b545... by Jay Kuri on 2020-07-09

Switch to version 3 pod spec

[Tom Haddon (mthaddon)]

Some more comments inline, and I think this is still WIP, or maybe you missed the comment about the check_config_valid function?

[Jay Kuri (jk0ne)]

> Some more comments inline, and I think this is still WIP, or maybe you missed
> the comment about the check_config_valid function?

Yes, still WIP. I wanted to get the rest of the adjustments made before I jumped into more substantive changes.

[Jay Kuri (jk0ne)]

comments inline.

36d04f3... by Jay Kuri on 2020-07-10

remove sidekiq config and serve_static_assets

6b9dc1f... by Jay Kuri on 2020-07-14

Update config process to be more testable. Add image_user and image_pass
for private registries

Unmerged commits

6b9dc1f... by Jay Kuri on 2020-07-14

Update config process to be more testable. Add image_user and image_pass
for private registries

36d04f3... by Jay Kuri on 2020-07-10

remove sidekiq config and serve_static_assets

e30b545... by Jay Kuri on 2020-07-09

Switch to version 3 pod spec

8fa0a6c... by Jay Kuri on 2020-07-09

Remove enable_local_redis, other minor tweaks

96386eb... by Jay Kuri on 2020-07-08

Add readinessProbe, remove stateful deploy options

e72b687... by Jay Kuri on 2020-07-01

Add pod spec items for serial deployment, and metadata to cause the charm to be deployed as a stateful set

52061b2... by Jay Kuri on 2020-06-30

Add ingress functionality. Remove useless service_port config option.

a15b65c... by Jay Kuri on 2020-06-30

Refactor config handling, remove OCIImage in favor of discourse_image in
juju_config, update operator charm submodule

c96b96a... by Jay Kuri on 2020-05-22

Disable initContainer and add discourse_image to config

d37bd24... by Jay Kuri on 2020-05-21

Revisions toward using initContainers

diff --git a/config.yaml b/config.yaml
index 6d656db..bd8bebe 100644
--- a/config.yaml
+++ b/config.yaml
@@ -1,4 +1,16 @@
 options:
+  discourse_image:
+    type: string
+    description: "Discourse image to use"
+    default: ""
+  image_user:
+    type: string
+    description: "Private registry username"
+    default: ""
+  image_pass:
+    type: string
+    description: "Private registry password"
+    default: ""
   db_host:
     type: string
     description: "PostgreSQL database host"
@@ -15,10 +27,6 @@ options:
     type: string
     description: "PostgreSQL database user's password"
     default: ""
-  service_port:
-    type: int
-    description: "TCP port discourse should listen on"
-    default: 80
   external_hostname:
     type: string
     description: "External hostname this discourse instance should respond to"
@@ -47,6 +55,14 @@ options:
     type: int
     description: "Port to use when connecting to SMTP server"
     default: 587
+  smtp_authentication:
+    type: string
+    description: "Type of smtp authentication to use"
+    default: "none"
+  smtp_openssl_verify_mode:
+    type: string
+    description: "Should discourse verify SSL certs"
+    default: "none"
   smtp_username:
     type: string
     description: "Username to use when sending mail via SMTP"
diff --git a/metadata.yaml b/metadata.yaml
index 97d952c..01334ec 100644
--- a/metadata.yaml
+++ b/metadata.yaml
@@ -9,14 +9,6 @@ tags:
   - forum
 series:
   - kubernetes
-provide:
+provides:
   website:
     interface: http
-resources:
-  discourse_image:
-    type: oci-image
-    description: Image used for discourse pod.
-storage:
-  discourse-storage:
-    type: filesystem
-    location: /shared
diff --git a/mod/operator b/mod/operator
index 60c43f8..59dd098 160000
--- a/mod/operator
+++ b/mod/operator
@@ -1 +1 @@
-Subproject commit 60c43f81e36139ab4044c185247eb27fe389bce6
+Subproject commit 59dd09875421668366ffcaff123bec34a0054ec3
diff --git a/mod/resource-oci-image b/mod/resource-oci-image
index e583429..3141de0 160000
--- a/mod/resource-oci-image
+++ b/mod/resource-oci-image
@@ -1 +1 @@
-Subproject commit e583429139d874bbcab8330c13f3fde30912abdf
+Subproject commit 3141de04152375d2f8df7863d8d78aa9345024b1
diff --git a/src/charm.py b/src/charm.py
index 86f8ab6..29db945 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -8,12 +8,114 @@ from ops.framework import StoredState
 from ops.main import main
 from ops.model import (
     ActiveStatus,
+    BlockedStatus,
     MaintenanceStatus,
     ModelError,
     WaitingStatus,
 )
 
-from oci_image import OCIImageResource, ResourceError
+
+def create_discourse_pod_config(config):
+    pod_config = {
+        'DISCOURSE_POSTGRES_USERNAME': config['db_user'],
+        'DISCOURSE_POSTGRES_PASSWORD': config['db_password'],
+        'DISCOURSE_POSTGRES_HOST': config['db_host'],
+        'DISCOURSE_POSTGRES_NAME': config['db_name'],
+        'DISCOURSE_DEVELOPER_EMAILS': config['developer_emails'],
+        'DISCOURSE_HOSTNAME': config['external_hostname'],
+        'DISCOURSE_SMTP_DOMAIN': config['smtp_domain'],
+        'DISCOURSE_SMTP_ADDRESS': config['smtp_address'],
+        'DISCOURSE_SMTP_PORT': config['smtp_port'],
+        'DISCOURSE_SMTP_AUTHENTICATION': config['smtp_authentication'],
+        'DISCOURSE_SMTP_OPENSSL_VERIFY_MODE': config['smtp_openssl_verify_mode'],
+        'DISCOURSE_SMTP_USER_NAME': config['smtp_username'],
+        'DISCOURSE_SMTP_PASSWORD': config['smtp_password'],
+        'DISCOURSE_REDIS_HOST': config['redis_host'],
+    }
+    return pod_config
+
+
+def create_ingress_config(app_name, config):
+    ingressResource = {
+        "name": app_name + "-ingress",
+        "spec": {
+            "rules": [
+                {
+                    "host": config['external_hostname'],
+                    "http": {
+                        "paths": [
+                            {
+                                "path": "/",
+                                "backend": {
+                                    "serviceName": app_name,
+                                    "servicePort": 3000
+                                }
+                            }
+                        ]
+                    }
+                }
+            ]
+        }
+    }
+    return ingressResource
+
+
+def get_pod_spec(app_name, config):
+    pod_spec = {
+        "version": 3,
+        "containers": [{
+            "name": app_name, 
+            "imageDetails": {"imagePath": config['discourse_image']},
+            "imagePullPolicy": "IfNotPresent",
+            "ports": [{
+                "containerPort": 3000,
+                "protocol": "TCP",
+            }],
+            "envConfig": create_discourse_pod_config(config),
+            "kubernetes": {
+                "readinessProbe": {
+                    "httpGet": {
+                        "path": "/srv/status",
+                        "port": 3000,
+                    }
+                }
+            },
+        }],
+        "kubernetesResources": {
+            "ingressResources": [
+                create_ingress_config(app_name, config)
+            ]
+        }
+    }
+    # This handles when we are trying to get an image from a private
+    # registry.
+    if config['image_user'] and config['image_pass']:
+        pod_spec['containers'][0]['imageDetails'].set("username", config['image_user'])
+        pod_spec['containers'][0]['imageDetails'].set("password", config['image_pass'])
+
+    return pod_spec
+
+
+def check_for_config_problems(config):
+    errors = []
+    missing_fields = check_for_missing_config_fields(config)
+
+    if len(missing_fields):
+        errors.append('Required configuration missing: {}'.format(" ".join(missing_fields)))
+
+    return errors
+
+
+def check_for_missing_config_fields(config):
+    missing_fields = []
+
+    needed_fields = ['db_user', 'db_password', 'db_host', 'db_name', 'smtp_address',
+                     'redis_host']
+    for key in needed_fields:
+        if len(config[key]) == 0:
+            missing_fields.append(key)
+
+    return sorted(missing_fields)
 
 
 class DiscourseCharm(CharmBase):
@@ -23,57 +125,37 @@ class DiscourseCharm(CharmBase):
         super().__init__(framework, key)
 
         self.state.set_default(is_started=False)
-        # get our discourse_image from juju
-        # ie: juju deploy . --resource discourse_image=discourse-canonical:1.0.0 )
-        self.discourse_image = OCIImageResource(self, 'discourse_image')
         self.framework.observe(self.on.leader_elected, self.configure_pod)
         self.framework.observe(self.on.config_changed, self.configure_pod)
         self.framework.observe(self.on.upgrade_charm, self.configure_pod)
 
-    def verify_leadership(self):
-        if not self.model.unit.is_leader():
-            raise LeadershipError()
+    def check_config_is_valid(self, config):
+        valid_config = True
+        errors = check_for_config_problems(config)
 
-    def configure_pod(self, event):
-        # Verify we are leader - throws exception if we are not
-        self.verify_leadership()
+        # set status if we have a bad config
+        if errors:
+            self.model.unit.status = BlockedStatus(", ".join(errors))
+            valid_config = False
+        else:
+            self.model.unit.status = MaintenanceStatus("Configuration passed validation")
+
+        return valid_config
 
-        # Get the image details for our discourse image - this will
-        # obtain all the details needed to access our docker registry / etc.
-        discourse_image_details = self.discourse_image.fetch()
+    def configure_pod(self, event):
 
-        # set our status while we get configured
+        # Set our status while we get configured.
         self.model.unit.status = MaintenanceStatus('Configuring pod')
 
-        # get our config
-        config = self.framework.model.config
-
-        # set our spec per our config
-        self.model.pod.set_spec({
-            'containers': [{
-                'name': self.framework.model.app.name,
-                'imageDetails': discourse_image_details,
-                'imagePullPolicy': 'Never',
-                'ports': [{
-                    'containerPort': int(config['service_port']),
-                    'protocol': 'TCP',
-                }],
-                'config': {
-                    'DISCOURSE_DB_USERNAME': config['db_user'],
-                    'DISCOURSE_DB_PASSWORD': config['db_password'],
-                    'DISCOURSE_DB_HOST': config['db_host'],
-                    'DISCOURSE_DB_NAME': config['db_name'],
-                    'DISCOURSE_DEVELOPER_EMAILS': config['developer_emails'],
-                    'DISCOURSE_HOSTNAME': config['external_hostname'],
-                    'DISCOURSE_SMTP_DOMAIN': config['smtp_domain'],
-                    'DISCOURSE_SMTP_ADDRESS': config['smtp_address'],
-                    'DISCOURSE_SMTP_PORT': config['smtp_port'],
-                    'DISCOURSE_SMTP_USER_NAME': config['smtp_username'],
-                    'DISCOURSE_SMTP_PASSWORD': config['smtp_password'],
-                    'DISCOURSE_REDIS_HOST': config['redis_host'],
-                },
-            }]
-        })
+        # Leader must set the pod spec.
+        if self.model.unit.is_leader():
+            # Get our spec definition.
+            if self.check_config_is_valid(self.framework.model.config):
+                # Get pod spec using our app name and config
+                pod_spec = get_pod_spec(self.framework.model.app.name, self.framework.model.config)
+                # Set our pod spec.
+                self.model.pod.set_spec(pod_spec)
+
         self.state.is_started = True
         self.model.unit.status = ActiveStatus()
 
@@ -84,11 +166,6 @@ class DiscourseCharm(CharmBase):
         event.client.serve(hosts=[event.client.ingress_address],
                            port=self.model.config['http_port'])
 
-class LeadershipError(ModelError):
-    def __init__(self):
-        super().__init__('not leader')
-        self.status = WaitingStatus('Deferring to leader unit to configure pod')
-
 
 if __name__ == '__main__':
     main(DiscourseCharm)