Hub configuration

Author: johannes-graner

codehub/cli/config.py

@@ -1,8 +1,7 @@
 from dataclasses import dataclass
 import os
 from pathlib import Path
-
-from codehub.cli.gcp.terraform import TerraformOutput
+from typing import Optional
 
 
 ROOT = Path(__file__).parents[2]
@@ -39,6 +38,33 @@
 CLUSTER_MAX_LEN = 14
 
 
+@dataclass
+class CloudState:
+    nfs_ip: str
+    nfs_name: str
+    cluster_id: str
+    hub_sa_key: str
+    cluster_endpoint: str
+    cluster_cert: str
+    gcp_token: str
+    docker_registry_hostname: str
+    docker_image: str
+
+
+@dataclass
+class OAuthConfig:
+    client_id: str
+    client_secret: str
+
+
+@dataclass
+class HubConfig:
+    admins: list[str]
+    https: Optional[str] = None
+    oauth_config: Optional[OAuthConfig] = None
+    contact_email: Optional[str] = None
+
+
 @dataclass
 class CreateConfig:
     name: str
@@ -49,9 +75,9 @@ class CreateConfig:
 
 
 @dataclass
-class OAuthConfig:
-    client_id: str
-    client_secret: str
+class UpgradeConfig:
+    name: str
+    hub_config: HubConfig
 
 
 @dataclass
@@ -61,4 +87,4 @@ class DeployConfig:
     helm_dir: str
     hub_dir: str
     k8s_dir: str
-    cloud_state: TerraformOutput
+    cloud_state: CloudState

codehub/cli/create.py

@@ -2,14 +2,19 @@
 import os
 import logging
 import json
-from typing import Optional
 from codehub.cli.gcp.terraform import (
     setup_terraform,
     terraform_apply,
     terraform_output,
 )
 from distutils.dir_util import copy_tree
-from codehub.cli.config import STRUCTURE, CreateConfig, DeployConfig, OAuthConfig
+from codehub.cli.config import (
+    STRUCTURE,
+    CreateConfig,
+    DeployConfig,
+    HubConfig,
+    UpgradeConfig,
+)
 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
@@ -48,39 +53,40 @@ def create(config: CreateConfig):
     deploy_config = DeployConfig(
         config.name, config.region, helm_dir, hub_dir, k8s_dir, cloud_state
     )
+    hub_config = HubConfig(config.admins)
 
     __create_k8s_resources(deploy_config)
 
-    __create_deploy(deploy_config, admins=config.admins)
+    __create_deploy(deploy_config, hub_config)
     install_helm_chart(deploy_config, upgrade=False)
 
     wait_for_hub_to_get_ready(k8s_dir)
 
     return get_ip(config.name, k8s_dir)
 
 
-def upgrade(name, admins, https=None, oauth_config: Optional[OAuthConfig] = None):
-    old_deploy_dir = get_latest_deployment(name=name)
+def upgrade(config: UpgradeConfig):
+    old_deploy_dir = get_latest_deployment(config.name)
 
     helm_dir, hub_dir, k8s_dir, cloud_dir = __upgrade_deploy_structure(
-        name, old_deploy_dir
+        config.name, old_deploy_dir
     )
     cloud_state = terraform_output(cloud_dir=cloud_dir)
 
     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)
+    deploy_config = DeployConfig(
+        config.name, region, helm_dir, hub_dir, k8s_dir, cloud_state
+    )
 
     __create_deploy(
         deploy_config,
-        admins=admins,
-        https=https,
-        oauth_config=oauth_config,
+        config.hub_config,
     )
     install_helm_chart(deploy_config, upgrade=True)
 
-    authenticate_k8s_GKE(name)
+    authenticate_k8s_GKE(config.name)
     wait_for_hub_to_get_ready(k8s_dir)
 
 
@@ -134,18 +140,9 @@ def __create_k8s_resources(deploy_config: DeployConfig):
 
 def __create_deploy(
     deploy_config: DeployConfig,
-    admins,
-    https=None,
-    oauth_config: Optional[OAuthConfig] = None,
+    hub_config: HubConfig,
 ):
-    contact_email = None
     with open(STRUCTURE["secrets"]["gcp"]["sa"], "rt") as f:
-        contact_email = json.loads(f.read())["client_email"]
+        hub_config.contact_email = json.loads(f.read())["client_email"]
 
-    create_deploy(
-        deploy_config,
-        contact_email=contact_email,
-        admins=admins,
-        https=https,
-        oauth_config=oauth_config,
-    )
+    create_deploy(deploy_config, hub_config)

codehub/cli/entrypoint.py

@@ -2,7 +2,7 @@
 import click
 import logging
 import sys
-from codehub.cli.config import CreateConfig, OAuthConfig
+from codehub.cli.config import CreateConfig, HubConfig, OAuthConfig, UpgradeConfig
 from codehub.cli.create import create, upgrade, scale, create_infrastructure
 from codehub.cli.delete import delete
 from codehub.cli.helpers import check_commands, validate_cluster_name, check_credentials
@@ -61,10 +61,14 @@ def upgradecluster(name, admin, https=None, client_id=None, client_secret=None):
     logger = logging.getLogger(__name__)
     logger.info(f"Updating cluster '{name}'")
 
-    oauth_config: Optional[OAuthConfig] = None
+    hub_config = HubConfig([i.lower() for i in admin])
+
     if https is not None:
+        hub_config.https = https
         if client_id and client_secret:
-            oauth_config = OAuthConfig(client_id=client_id, client_secret=client_secret)
+            hub_config.oauth_config = OAuthConfig(
+                client_id=client_id, client_secret=client_secret
+            )
         # None or both need to be passed
         elif client_id or client_secret:
             raise ValueError(
@@ -74,14 +78,9 @@ def upgradecluster(name, admin, https=None, client_id=None, client_secret=None):
                 + "`--client-secret` <github-client-secret>"
             )
 
-    admins = [i.lower() for i in admin]
+    config = UpgradeConfig(name, hub_config)
 
-    res = upgrade(
-        name=name,
-        admins=admins,
-        https=https,
-        oauth_config=oauth_config,
-    )
+    res = upgrade(config)
 
     logger.debug(f"{upgrade.__module__}.{upgrade.__name__} output:")
     logger.debug(res)

codehub/cli/gcp/terraform.py

@@ -3,27 +3,14 @@
 import os
 from typing import Any, List, Optional
 from distutils.dir_util import copy_tree
-from codehub.cli.config import STRUCTURE, CreateConfig
+from codehub.cli.config import STRUCTURE, CreateConfig, CloudState
 from codehub.cli.helpers import (
     fill_file_placeholders,
     run_cmd,
     run_cmd_passthrough_stdout,
 )
 
 
-@dataclasses.dataclass
-class TerraformOutput:
-    nfs_ip: str
-    nfs_name: str
-    cluster_id: str
-    hub_sa_key: str
-    cluster_endpoint: str
-    cluster_cert: str
-    gcp_token: str
-    docker_registry_hostname: str
-    docker_image: str
-
-
 def setup_terraform(
     *,
     config: CreateConfig,
@@ -55,7 +42,7 @@ def terraform_apply(
     *,
     cloud_dir: str,
     additional_vars: Optional[dict[str, Any]] = None,
-) -> TerraformOutput:
+) -> CloudState:
     terraform_cmd = _terraform_cmd(cloud_dir)
     run_cmd(terraform_cmd + ["init"])
 
@@ -84,13 +71,13 @@ def terraform_destroy(*, cloud_dir: str):
     )
 
 
-def terraform_output(*, cloud_dir: str) -> TerraformOutput:
+def terraform_output(*, cloud_dir: str) -> CloudState:
     command = _terraform_cmd(cloud_dir) + ["output", "-json"]
     terraform_output: dict[str, dict[str, Any]] = json.loads(
         run_cmd(command, verbose=False)
     )
     output = {key: val_dict["value"] for key, val_dict in terraform_output.items()}
-    return TerraformOutput(**output)
+    return CloudState(**output)
 
 
 def _get_project_from_sa(gcp_sa_path: str) -> str:

codehub/cli/helm/create.py

@@ -1,34 +1,34 @@
 import os
 from secrets import token_hex
-from typing import Optional
 from dotenv import load_dotenv
 from codehub.cli.helpers import read_yaml, copy_file, fill_file_placeholders
-from codehub.cli.config import STRUCTURE, DeployConfig, OAuthConfig
+from codehub.cli.config import STRUCTURE, DeployConfig, HubConfig
 
 
 def create_deploy(
     deploy_config: DeployConfig,
-    contact_email=None,
-    https=None,
-    oauth_config: Optional[OAuthConfig] = None,
-    admins=[],
+    hub_config: HubConfig,
 ):
-    config_fps = __get_config_fps(https=https, oauth=oauth_config is not None)
+    oauth_config = hub_config.oauth_config
+    config_fps = __get_config_fps(
+        https=hub_config.https, oauth=oauth_config is not None
+    )
     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"] = deploy_config.name
-    placeholder_replacements["HOST_NAME"] = https
-    placeholder_replacements["CONTACT_EMAIL"] = contact_email
+    placeholder_replacements["HOST_NAME"] = hub_config.https
+    placeholder_replacements["CONTACT_EMAIL"] = hub_config.contact_email
     if oauth_config is not None:
         placeholder_replacements["GITHUB_OAUTH_CLIENT_ID"] = oauth_config.client_id
         placeholder_replacements["GITHUB_OAUTH_CLIENT_SECRET"] = (
             oauth_config.client_secret
         )
 
+    admins = hub_config.admins.copy()
     if "admin" not in admins:
         admins.append("admin")