Make base domain configurable for local setup with tilt

Author: Sheikah45

README.MD

@@ -84,6 +84,6 @@ The default test data that is loaded can be found in [faf-db](https://github.com
 You can load the data at anytime by manually triggering the popualte-db resource under the Database label. This needs to be done the first time for data to exist.
 
 ## Endpoints
-Locally traefik uses the same ingress routes as we do in production just with a default base domain of localhost. So accessible domains will be api.localhost, hydra.localhost etc. By default these should resolve to 127.0.0.1. If they do not you can manually modify your hosts file to add the local dns records. For convenience the resource create-hosts-file-content
+Locally traefik uses the same ingress routes as we do in production just with a default base domain of faforever.localhost. So accessible domains will be api.faforever.localhost, hydra.faforever.localhost etc. By default these should resolve to 127.0.0.1. If they do not you can manually modify your hosts file to add the local dns records. For convenience the resource create-hosts-file-content
 will output the necessary lines for the hosts file when run after every service has started.
 

Tiltfile

@@ -5,11 +5,13 @@ config.define_string("default-pull-policy", args=False, usage="Pull policy to us
 config.define_string("host-ip", args=False, usage="IP Address of the host to enable redirection to local services")
 config.define_string("hostname", args=False, usage="Accessible name of the host to enable redirection to local services")
 config.define_string("faf-data-dir", args=False, usage="Directory where the FAF Data lives normally C:/ProgramData/FAForever on Windows or ~/.faforever on Linux")
+config.define_string("base-domain", args=False, usage="Base Domain to use for all faf services. Defaults to faforever.localhost")
 config.define_string_list("local-services", args=False, usage="Names of services that you intend to run locally")
 cfg = config.parse()
 windows_bash_path = cfg.get("windows-bash-path", "C:\\Program Files\\Git\\bin\\bash.exe")
 host_ip = cfg.get("host-ip", "")
 local_services = cfg.get("local-services", [])
+base_domain = cfg.get("base-domain", "faforever.localhost")
 
 data_relative_path = ".local-data"
 if os.name == "nt":
@@ -99,6 +101,7 @@ def helm_with_build_cache(chart, namespace="", values=[], set=[], specifier = ""
         command.extend(["--namespace", namespace])
     command.extend(value_flags)
     command.extend(set_flags)
+    command.extend(["--set", "baseDomain=" + base_domain])
 
     deps = [chart]
     deps.extend(values)
@@ -215,7 +218,7 @@ def proxy_local_service_if_set(service_name, service_chart, service_namespace, a
         k8s_yaml(service_proxy_yaml)
         for object in decode_yaml_stream(service_proxy_yaml):
             service_objects.append(object["metadata"]["name"] + ":" + object["kind"].lower())
-        k8s_resource(new_name=service_name, objects=service_objects, resource_deps=all_service_deps, labels=user_service_labels, links=user_service_links, pod_readiness="ignore")
+        k8s_resource(new_name=service_name, objects=service_objects, resource_deps=all_service_deps, labels=service_labels, links=user_service_links, pod_readiness="ignore")
     else:
         if service_name == "faf-icebreaker":
             service_yaml = remove_init_container(service_yaml)
@@ -257,7 +260,7 @@ for object in decode_yaml_stream(storage_yaml):
 
 k8s_resource(new_name="volumes", objects=volume_identifiers, labels=["core"], trigger_mode=TRIGGER_MODE_MANUAL)
 
-traefik_yaml = helm_with_build_cache("cluster/traefik", values=["config/local.yaml", "cluster/traefik/values-local.yaml"], namespace="traefik")
+traefik_yaml = helm_with_build_cache("cluster/traefik", values=["config/local.yaml", "cluster/traefik/values-local.yaml"], set=["traefik.ingressRoute.dashboard.matchRule='Host(`traefik.{}`)'".format(base_domain)], namespace="traefik")
 k8s_yaml(traefik_yaml)
 
 traefik_identifiers = []
@@ -325,23 +328,23 @@ k8s_resource(workload="ergochat", objects=["ergochat-webirc:ingressroute"], reso
 
 k8s_yaml(helm_with_build_cache("apps/wordpress", namespace="faf-apps", values=["config/local.yaml"]))
 k8s_resource(new_name="wordpress-config", objects=["wordpress:configmap", "wordpress:secret"], labels=["website"])
-k8s_resource(workload="wordpress", objects=["wordpress:ingressroute"], resource_deps=["traefik"], labels=["website"], links=[link("http://direct.localhost", "FAF Wordpress")])
+k8s_resource(workload="wordpress", objects=["wordpress:ingressroute"], resource_deps=["traefik"], labels=["website"], links=[link("http://direct.{}".format(base_domain), "FAF Wordpress")])
 
 k8s_yaml(helm_with_build_cache("apps/wikijs", namespace="faf-apps", values=["config/local.yaml"]))
 k8s_resource(new_name="wikijs-config", objects=["wikijs:configmap", "wikijs:secret", "wikijs-sso:configmap"], labels=["wiki"])
-k8s_resource(workload="wikijs", objects=["wikijs:ingressroute"], resource_deps=["traefik"] + postgres_setup_resources, labels=["wiki"], links=[link("http://wiki.localhost", "FAF Wiki")])
+k8s_resource(workload="wikijs", objects=["wikijs:ingressroute"], resource_deps=["traefik"] + postgres_setup_resources, labels=["wiki"], links=[link("http://wiki.{}".format(base_domain), "FAF Wiki")])
 
 k8s_yaml(helm_with_build_cache("apps/nodebb", namespace="faf-apps", values=["config/local.yaml"]))
 k8s_resource(new_name="nodebb-config", objects=["nodebb:configmap", "nodebb:secret"], labels=["forum"])
-k8s_resource(workload="nodebb", objects=["nodebb:ingressroute"], resource_deps=["traefik"] + mongodb_setup_resources, labels=["forum"], links=[link("http://forum.localhost", "FAF Forum")])
+k8s_resource(workload="nodebb", objects=["nodebb:ingressroute"], resource_deps=["traefik"] + mongodb_setup_resources, labels=["forum"], links=[link("http://forum.{}".format(base_domain), "FAF Forum")])
 
 k8s_yaml(keep_objects_of_kind(helm_with_build_cache("apps/debezium", namespace="faf-apps", values=["config/local.yaml"]), kinds=["ConfigMap", "Secret"]))
 k8s_resource(new_name="debezium-config", objects=["debezium:configmap", "debezium:secret"], labels=["database"])
 
 hydra_yaml = helm_with_build_cache("apps/ory-hydra", namespace="faf-apps", values=["config/local.yaml"])
 hydra_client_create_yaml, hydra_resources_yaml = filter_yaml(hydra_yaml, {"app": "ory-hydra-create-clients"})
 _, hydra_resources_yaml = filter_yaml(hydra_resources_yaml, {"app": "ory-hydra-janitor"})
-hydra_resources_yaml = patch_config(hydra_resources_yaml, "ory-hydra", {"URLS_SELF_ISSUER": "http://ory-hydra:4444", "URLS_SELF_PUBLIC": "http://hydra.localhost", "URLS_LOGIN": "http://user.localhost/oauth2/login", "URLS_CONSENT": "http://user.localhost/oauth2/consent", "DEV": "true"})
+hydra_resources_yaml = patch_config(hydra_resources_yaml, "ory-hydra", {"URLS_SELF_ISSUER": "http://ory-hydra:4444", "URLS_SELF_PUBLIC": "http://hydra.{}".format(base_domain), "URLS_LOGIN": "http://user.{}/oauth2/login".format(base_domain), "URLS_CONSENT": "http://user.{}/oauth2/consent".format(base_domain), "DEV": "true"})
 k8s_yaml(hydra_resources_yaml)
 k8s_yaml(hydra_client_create_yaml)
 k8s_resource(new_name="ory-hydra-config", objects=["ory-hydra:configmap", "ory-hydra:secret"], labels=["hydra"])
@@ -358,24 +361,24 @@ k8s_resource(new_name="faf-policy-server-config", objects=["faf-policy-server:co
 
 # k8s_yaml(helm_with_build_cache("apps/faf-content", namespace="faf-apps", values=["config/local.yaml"]))
 # k8s_resource(new_name="faf-content-config", objects=["faf-content:configmap"], labels=["content"])
-# k8s_resource(workload="faf-content", objects=["faf-content:ingressroute", "cors:middleware", "redirect-replay-subdomain:middleware"], resource_deps=["traefik"], labels=["content"], links=[link("http://content.localhost", "FAForever Content")])
+# k8s_resource(workload="faf-content", objects=["faf-content:ingressroute", "cors:middleware", "redirect-replay-subdomain:middleware"], resource_deps=["traefik"], labels=["content"], links=[link("http://content.{}".format(base_domain), "FAForever Content")])
 
 user_service_deps = ["faf-db-migrations", "ory-hydra"]
 user_service_labels = ["user"]
-user_service_links = [link("http://user.localhost/register", "User Service Registration")]
-user_service_patch = {"HYDRA_TOKEN_ISSUER": "http://ory-hydra:4444", "HYDRA_JWKS_URL": "http://ory-hydra:4444/.well-known/jwks.json", "LOBBY_URL":"ws://ws.localhost", "REPLAY_URL":"ws://replay-ws.localhost"}
+user_service_links = [link("http://user.{}/register".format(base_domain), "User Service Registration")]
+user_service_patch = {"HYDRA_TOKEN_ISSUER": "http://ory-hydra:4444", "HYDRA_JWKS_URL": "http://ory-hydra:4444/.well-known/jwks.json", "LOBBY_URL":"ws://ws.{}".format(base_domain), "REPLAY_URL":"ws://replay-ws.{}".format(base_domain)}
 proxy_local_service_if_set(service_name="faf-user-service", service_chart="apps/faf-user-service", service_namespace="faf-apps", service_deps=user_service_deps, service_labels=user_service_labels, service_links=user_service_links, config_patch=user_service_patch)
 
 website_deps = ["wordpress"]
 website_labels = ["website"]
-website_links = [link("http://www.localhost", "FAForever Website")]
-website_patch = {"OAUTH_URL": "http://ory-hydra:4444", "OAUTH_PUBLIC_URL": "http://hydra.localhost", "API_URL": "http://faf-api:8010", "WP_URL": "http://wordpress:80"}
+website_links = [link("http://www.{}".format(base_domain), "FAForever Website")]
+website_patch = {"OAUTH_URL": "http://ory-hydra:4444", "OAUTH_PUBLIC_URL": "http://hydra.{}".format(base_domain), "API_URL": "http://faf-api:8010", "WP_URL": "http://wordpress:80"}
 proxy_local_service_if_set(service_name="faf-website", service_chart="apps/faf-website", service_namespace="faf-apps", service_deps=website_deps, service_labels=website_labels, service_links=website_links, additional_values=["apps/faf-website/values-prod.yaml"], config_patch=website_patch)
 
 api_deps = ["faf-db-migrations", "ory-hydra"] + rabbitmq_setup_resources
 api_labels = ["api"]
-api_links = [link("http://api.localhost", "FAF API")]
-api_patch = {"JWT_FAF_HYDRA_ISSUER": "http://ory-hydra:4444", "REPLAY_DOWNLOAD_URL_FORMAT": "http://replays.localhost/%s", "MOD_DOWNLOAD_URL_FORMAT": "http://content.localhost/mods/%s", "MAP_DOWNLOAD_URL_FORMAT": "http://content.localhost/maps/%s", "FEATURED_MOD_URL_FORMAT":"http://content.localhost/legacy-featured-mod-files/%s/%s", "AVATAR_DOWNLOAD_URL_FORMAT":"http://content.localhost/faf/avatars/%s"}
+api_links = [link("http://api.{}".format(base_domain), "FAF API")]
+api_patch = {"JWT_FAF_HYDRA_ISSUER": "http://ory-hydra:4444", "REPLAY_DOWNLOAD_URL_FORMAT": "http://replays.{}/%s".format(base_domain), "MOD_DOWNLOAD_URL_FORMAT": "http://content.{}/mods/%s".format(base_domain), "MAP_DOWNLOAD_URL_FORMAT": "http://content.{}/maps/%s".format(base_domain), "FEATURED_MOD_URL_FORMAT":"http://content.{}/legacy-featured-mod-files/%s/%s".format(base_domain), "AVATAR_DOWNLOAD_URL_FORMAT":"http://content.{}/faf/avatars/%s".format(base_domain)}
 proxy_local_service_if_set(service_name="faf-api", service_chart="apps/faf-api", service_namespace="faf-apps", service_deps=api_deps, service_labels=api_labels, service_links=api_links, config_patch=api_patch)
 
 league_service_deps = mariadb_setup_resources + rabbitmq_setup_resources
@@ -392,7 +395,7 @@ replay_server_labels = ["replay"]
 proxy_local_service_if_set(service_name="faf-replay-server", service_chart="apps/faf-replay-server", service_namespace="faf-apps", service_deps=replay_server_deps, service_labels=replay_server_labels)
 
 unitdb_labels = ["unitdb"]
-unitdb_links = [link("http://unitdb.localhost", "Rackover UnitDB")]
+unitdb_links = [link("http://unitdb.{}".format(base_domain), "Rackover UnitDB")]
 proxy_local_service_if_set(service_name="faf-unitdb", service_chart="apps/faf-unitdb", service_namespace="faf-apps", service_labels=unitdb_labels, service_links=unitdb_links)
 
 ws_bridge_deps = ["faf-lobby-server"]

apps/nodebb/templates/local-secret.yaml

@@ -9,7 +9,7 @@ stringData:
   OAUTH_SECRET: "banana"
   "config.json": |
     {
-      "url": "https://forum.localhost",
+      "url": "https://forum.{{ .Values.baseDomain }}",
       "secret": "banana",
       "database": "mongo",
       "port": 4567,

cluster/traefik/values-local.yaml

@@ -5,7 +5,7 @@ traefik:
   ingressRoute:
     dashboard:
       enabled: true
-      matchRule: Host(`traefik.localhost`)
+      matchRule: Host(`traefik.faforever.localhost`)
       entryPoints: ["websecure", "web"]
 
   additionalArguments:

config/local.yaml

@@ -1,6 +1,6 @@
 hostName: "localhost"
 environment: "local"
-baseDomain: "localhost"
+baseDomain: "faforever.localhost"
 infisical-secret:
   enabled: false
 traefik: {}