Deployment configuration

Author: johannes-graner

codehub/cli/config.py

@@ -2,6 +2,8 @@
 import os
 from pathlib import Path
 
+from codehub.cli.gcp.terraform import TerraformOutput
+
 
 ROOT = Path(__file__).parents[2]
 PACKAGE_ROOT = Path(__file__).parents[1]
@@ -50,3 +52,13 @@ class CreateConfig:
 class OAuthConfig:
     client_id: str
     client_secret: str
+
+
+@dataclass
+class DeployConfig:
+    name: str
+    region: str
+    helm_dir: str
+    hub_dir: str
+    k8s_dir: str
+    cloud_state: TerraformOutput

codehub/cli/create.py

@@ -4,13 +4,12 @@
 import json
 from typing import Optional
 from codehub.cli.gcp.terraform import (
-    TerraformOutput,
     setup_terraform,
     terraform_apply,
     terraform_output,
 )
 from distutils.dir_util import copy_tree
-from codehub.cli.config import STRUCTURE, CreateConfig, OAuthConfig
+from codehub.cli.config import STRUCTURE, CreateConfig, DeployConfig, OAuthConfig
 from codehub.cli.gcp.helpers import authenticate_k8s_GKE
 from codehub.cli.k8s.create import create_k8s_resources
 from codehub.cli.helm.create import create_deploy
@@ -21,20 +20,18 @@
 
 
 def create_infrastructure(config: CreateConfig):
-    _, _, k8s_dir, cloud_dir = __create_deploy_structure(config.name)
+    helm_dir, hub_dir, k8s_dir, cloud_dir = __create_deploy_structure(config.name)
 
     setup_terraform(
         config=config,
         cloud_dir=cloud_dir,
     )
 
     cloud_state = terraform_apply(cloud_dir=cloud_dir)
-    __create_k8s_resources(
-        config.name,
-        deploy_dir=k8s_dir,
-        nfs_name=cloud_state.nfs_name,
-        nfs_ip=cloud_state.nfs_ip,
+    deploy_config = DeployConfig(
+        config.name, config.region, helm_dir, hub_dir, k8s_dir, cloud_state
     )
+    __create_k8s_resources(deploy_config)
 
     return get_ip(config.name, k8s_dir)
 
@@ -48,19 +45,14 @@ def create(config: CreateConfig):
     )
 
     cloud_state = terraform_apply(cloud_dir=cloud_dir)
-    __create_k8s_resources(
-        config.name,
-        deploy_dir=k8s_dir,
-        nfs_name=cloud_state.nfs_name,
-        nfs_ip=cloud_state.nfs_ip,
+    deploy_config = DeployConfig(
+        config.name, config.region, helm_dir, hub_dir, k8s_dir, cloud_state
     )
 
+    __create_k8s_resources(deploy_config)
+
     __install_helm_chart(
-        config.name,
-        region=config.region,
-        helm_deploy_dir=helm_dir,
-        hub_deploy_dir=hub_dir,
-        cloud_state=cloud_state,
+        deploy_config,
         admins=config.admins,
     )
 
@@ -77,16 +69,13 @@ def upgrade(name, admins, https=None, oauth_config: Optional[OAuthConfig] = None
     )
     cloud_state = terraform_output(cloud_dir=cloud_dir)
 
-    last_helm_install = read_yaml(os.path.join(old_deploy_dir, "helm", "chart.yaml"))[
-        "install"
+    region = read_yaml(os.path.join(old_deploy_dir, "helm", "chart.yaml"))["install"][
+        "region"
     ]
+    deploy_config = DeployConfig(name, region, helm_dir, hub_dir, k8s_dir, cloud_state)
 
     __upgrade_helm_chart(
-        name,
-        region=last_helm_install["region"],
-        helm_deploy_dir=helm_dir,
-        hub_deploy_dir=hub_dir,
-        cloud_state=cloud_state,
+        deploy_config,
         admins=admins,
         https=https,
         oauth_config=oauth_config,
@@ -130,10 +119,10 @@ def __upgrade_deploy_structure(name, old_deploy_dir):
     return helm_dir, hub_dir, k8s_dir, cloud_dir
 
 
-def __create_k8s_resources(name, deploy_dir, nfs_name, nfs_ip):
-    authenticate_k8s_GKE(name)
+def __create_k8s_resources(deploy_config: DeployConfig):
+    authenticate_k8s_GKE(deploy_config.name)
     try:
-        create_k8s_resources(deploy_dir, nfs_name, nfs_ip)
+        create_k8s_resources(deploy_config)
     except kubernetes.client.rest.ApiException as e:
         logger = logging.getLogger(__name__)
         # If the error is due to a resource already existing, we can continue
@@ -145,52 +134,31 @@ def __create_k8s_resources(name, deploy_dir, nfs_name, nfs_ip):
 
 
 def __install_helm_chart(
-    name,
-    region,
-    helm_deploy_dir,
-    hub_deploy_dir,
-    cloud_state: TerraformOutput,
+    deploy_config: DeployConfig,
     admins,
 ):
-    __create_deploy(name, helm_deploy_dir, hub_deploy_dir, cloud_state, admins)
-    install_helm_chart(
-        name,
-        region=region,
-        helm_deploy_dir=helm_deploy_dir,
-        hub_deploy_dir=hub_deploy_dir,
-    )
+    __create_deploy(deploy_config, admins)
+    install_helm_chart(deploy_config)
 
 
 def __upgrade_helm_chart(
-    name,
-    region,
-    helm_deploy_dir,
-    hub_deploy_dir,
-    cloud_state: TerraformOutput,
+    deploy_config: DeployConfig,
     admins,
     https=None,
     oauth_config: Optional[OAuthConfig] = None,
 ):
     __create_deploy(
-        name,
-        helm_deploy_dir,
-        hub_deploy_dir,
-        cloud_state=cloud_state,
+        deploy_config,
         admins=admins,
         https=https,
         oauth_config=oauth_config,
     )
 
-    upgrade_helm_chart(
-        name, region, helm_deploy_dir=helm_deploy_dir, hub_deploy_dir=hub_deploy_dir
-    )
+    upgrade_helm_chart(deploy_config)
 
 
 def __create_deploy(
-    name,
-    helm_deploy_dir,
-    hub_deploy_dir,
-    cloud_state: TerraformOutput,
+    deploy_config: DeployConfig,
     admins,
     https=None,
     oauth_config: Optional[OAuthConfig] = None,
@@ -200,12 +168,9 @@ def __create_deploy(
         contact_email = json.loads(f.read())["client_email"]
 
     create_deploy(
-        name,
+        deploy_config,
         contact_email=contact_email,
         admins=admins,
-        helm_deploy_dir=helm_deploy_dir,
-        hub_deploy_dir=hub_deploy_dir,
-        cloud_state=cloud_state,
         https=https,
         oauth_config=oauth_config,
     )

codehub/cli/helm/create.py

@@ -2,29 +2,25 @@
 from secrets import token_hex
 from typing import Optional
 from dotenv import load_dotenv
-from codehub.cli.gcp.terraform import TerraformOutput
-from codehub.cli.helpers import read_yaml, run_cmd, copy_file, fill_file_placeholders
-from codehub.cli.config import STRUCTURE, OAuthConfig
+from codehub.cli.helpers import read_yaml, copy_file, fill_file_placeholders
+from codehub.cli.config import STRUCTURE, DeployConfig, OAuthConfig
 
 
 def create_deploy(
-    cluster_name,
-    hub_deploy_dir,
-    helm_deploy_dir,
-    cloud_state: TerraformOutput,
+    deploy_config: DeployConfig,
     contact_email=None,
     https=None,
     oauth_config: Optional[OAuthConfig] = None,
     admins=[],
 ):
     config_fps = __get_config_fps(https=https, oauth=oauth_config is not None)
-    template_fp = __build_template(hub_deploy_dir, config_fps)
+    template_fp = __build_template(deploy_config.hub_dir, config_fps)
 
     placeholder_replacements = read_yaml(
         os.path.join(STRUCTURE["templates"]["hub"], "config_variables.yaml")
     )
     placeholder_replacements["SECRET_TOKEN"] = token_hex(32)
-    placeholder_replacements["CLUSTER_NAME"] = cluster_name
+    placeholder_replacements["CLUSTER_NAME"] = deploy_config.name
     placeholder_replacements["HOST_NAME"] = https
     placeholder_replacements["CONTACT_EMAIL"] = contact_email
     if oauth_config is not None:
@@ -44,6 +40,7 @@ def admin_to_yaml_str(admin):
     )
     placeholder_replacements["SUDOERS"] = " ".join(admins)
 
+    cloud_state = deploy_config.cloud_state
     placeholder_replacements["REGISTRY_HOSTNAME"] = cloud_state.docker_registry_hostname
     # The spaces after newline are important for the indentation in the yaml file
     placeholder_replacements["REGISTRY_PASSWORD"] = cloud_state.hub_sa_key.replace(
@@ -54,9 +51,9 @@ def admin_to_yaml_str(admin):
     if "DOCKER_IMAGE_TAG" not in placeholder_replacements:
         placeholder_replacements["DOCKER_IMAGE_TAG"] = "stable"
 
-    __add_config_content(hub_deploy_dir, template_fp, placeholder_replacements)
+    __add_config_content(deploy_config.hub_dir, template_fp, placeholder_replacements)
 
-    __add_helm_chart_config(helm_deploy_dir)
+    __add_helm_chart_config(deploy_config.helm_dir)
 
 
 def __get_config_fps(https=None, oauth=None):

codehub/cli/helm/install.py

@@ -1,34 +1,28 @@
 import os
 from codehub.cli.helpers import run_cmd, read_yaml, fill_file_placeholders
-from codehub.cli.config import STRUCTURE
+from codehub.cli.config import STRUCTURE, DeployConfig
 
 
-def install_helm_chart(cluster_name, region, helm_deploy_dir, hub_deploy_dir):
-    __upgrade_or_install_helm_chart(
-        cluster_name, region, helm_deploy_dir, hub_deploy_dir, upgrade=False
-    )
+def install_helm_chart(deploy_config: DeployConfig):
+    __upgrade_or_install_helm_chart(deploy_config, upgrade=False)
 
 
-def upgrade_helm_chart(cluster_name, region, helm_deploy_dir, hub_deploy_dir):
-    __upgrade_or_install_helm_chart(
-        cluster_name, region, helm_deploy_dir, hub_deploy_dir, upgrade=True
-    )
+def upgrade_helm_chart(deploy_config: DeployConfig):
+    __upgrade_or_install_helm_chart(deploy_config, upgrade=True)
 
 
-def __upgrade_or_install_helm_chart(
-    cluster_name, region, helm_deploy_dir, hub_deploy_dir, upgrade=False
-):
+def __upgrade_or_install_helm_chart(deploy_config: DeployConfig, upgrade=False):
     chart_template_fp = os.path.join(STRUCTURE["templates"]["helm"], "chart.yaml")
-    chart_deploy_fp = os.path.join(helm_deploy_dir, "chart.yaml")
+    chart_deploy_fp = os.path.join(deploy_config.helm_dir, "chart.yaml")
 
-    placeholder_replacements = dict(REGION=region)
+    placeholder_replacements = dict(REGION=deploy_config.region)
     fill_file_placeholders(chart_template_fp, chart_deploy_fp, placeholder_replacements)
 
     helm_config = read_yaml(chart_deploy_fp)
     repo_config = helm_config["repo"]
     install_config = helm_config["install"]
 
-    config_file = os.path.join(hub_deploy_dir, "config.yaml")
+    config_file = os.path.join(deploy_config.hub_dir, "config.yaml")
 
     cmds = []
     cmds.append(
@@ -38,7 +32,7 @@ def __upgrade_or_install_helm_chart(
             "clusters",
             "get-credentials",
             f"--location={install_config['region']}",
-            cluster_name,
+            deploy_config.name,
         ]
     )
 

codehub/cli/k8s/create.py

@@ -1,21 +1,28 @@
 from kubernetes import client as k8s_client
 import os
 from codehub.cli.helpers import read_yaml, fill_file_placeholders
-from codehub.cli.config import STRUCTURE
+from codehub.cli.config import STRUCTURE, DeployConfig
 
 
-def create_k8s_resources(k8s_deploy_path, nfs_name, nfs_ip):
-    __create_cluster_role_binding(k8s_deploy_path)
+def create_k8s_resources(deploy_config: DeployConfig):
+    k8s_dir = deploy_config.k8s_dir
+
+    __create_cluster_role_binding(k8s_dir)
 
     namespace = read_yaml(
         os.path.join(STRUCTURE["templates"]["k8s"], "namespace.yaml")
     )["metadata"]["name"]
 
     placeholder_replacements = {"NAMESPACE": namespace}
 
-    __create_namespace(k8s_deploy_path, placeholder_replacements)
-    __create_pvs(k8s_deploy_path, nfs_name, nfs_ip, placeholder_replacements)
-    __create_pvcs(k8s_deploy_path, nfs_name, nfs_ip, placeholder_replacements)
+    __create_namespace(k8s_dir, placeholder_replacements)
+    __create_pvs(
+        k8s_dir,
+        deploy_config.cloud_state.nfs_name,
+        deploy_config.cloud_state.nfs_ip,
+        placeholder_replacements,
+    )
+    __create_pvcs(k8s_dir, placeholder_replacements)
 
 
 def __create_cluster_role_binding(k8s_deploy_path):
@@ -50,7 +57,7 @@ def __create_pvs(k8s_deploy_path, nfs_name, nfs_ip, placeholder_replacements):
         )
 
 
-def __create_pvcs(k8s_deploy_path, nfs_name, nfs_ip, placeholder_replacements):
+def __create_pvcs(k8s_deploy_path, placeholder_replacements):
     for pvc in ["pvc-personal.yaml", "pvc-shared.yaml"]:
         __create_k8s_resource_from_template(
             client_call=k8s_client.CoreV1Api().create_namespaced_persistent_volume_claim,