feat(k8s): allow specifying default username in k8s provider config

Also, fix it to "default" in local-kubernetes plugin.
garden-io · Jul 10, 2018 · 1e42cfb · 1e42cfb
1 parent ad0a54f
commit 1e42cfb
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 12 deletions.
diff --git a/src/plugins/kubernetes/kubernetes.ts b/src/plugins/kubernetes/kubernetes.ts
@@ -7,7 +7,10 @@
  */
 
 import * as Joi from "joi"
-import { validate } from "../../types/common"
+import {
+  joiIdentifier,
+  validate
+} from "../../types/common"
 import {
   GardenPlugin,
   Provider,
@@ -47,6 +50,7 @@ export interface KubernetesConfig extends ProviderConfig {
   ingressPort: number
   ingressClass: string
   forceSsl: boolean
+  defaultUsername?: string
 }
 
 export interface KubernetesProvider extends Provider<KubernetesConfig> { }
@@ -60,6 +64,8 @@ const kubernetesConfigBase = providerConfigBase
       .hostname()
       .required()
       .description("The external hostname of the cluster's ingress controller."),
+    defaultUsername: joiIdentifier()
+      .description("Set a default username (used for namespacing within a cluster)."),
   })
 
 const configSchema = kubernetesConfigBase

diff --git a/src/plugins/kubernetes/local.ts b/src/plugins/kubernetes/local.ts
@@ -237,6 +237,7 @@ export async function gardenPlugin({ config, logEntry }): Promise<GardenPlugin>
     ingressClass: "nginx",
     // TODO: support SSL on local deployments
     forceSsl: false,
+    defaultUsername: "default",
     _system: config._system,
     _systemServices: systemServices,
   }

diff --git a/src/plugins/kubernetes/namespace.ts b/src/plugins/kubernetes/namespace.ts
@@ -33,22 +33,31 @@ export async function createNamespace(context: string, namespace: string) {
 }
 
 export async function getAppNamespace(ctx: PluginContext, provider: KubernetesProvider) {
+  let namespace
+
   if (isSystemGarden(provider)) {
-    return GARDEN_SYSTEM_NAMESPACE
-  }
+    namespace = GARDEN_SYSTEM_NAMESPACE
+  } else {
+    const localConfig = await ctx.localConfigStore.get()
+    const k8sConfig = localConfig.kubernetes || {}
+    let { username, ["previous-usernames"]: previousUsernames } = k8sConfig
+
+    if (!username) {
+      username = provider.config.defaultUsername
+    }
 
-  const localConfig = await ctx.localConfigStore.get()
-  const k8sConfig = localConfig.kubernetes || {}
-  const { username, ["previous-usernames"]: previousUsernames } = k8sConfig
+    if (!username) {
+      throw new AuthenticationError(
+        `User not logged into provider ${providerName}. Please specify defaultUsername in provider ` +
+        `config or run garden login.`,
+        { previousUsernames, provider: providerName },
+      )
+    }
 
-  if (!username) {
-    throw new AuthenticationError(
-      `User not logged into provider ${providerName}. Please run garden login.`,
-      { previousUsernames, provider: providerName },
-    )
+    namespace = `garden--${username}--${ctx.projectName}`
   }
 
-  return `garden--${username}--${ctx.projectName}`
+  return namespace
 }
 
 export function getMetadataNamespace(ctx: PluginContext, provider: KubernetesProvider) {