Add support for namespaces in context (#303)

Fixes
#281

Author: sethvargo

.github/workflows/integration.yml

@@ -44,6 +44,7 @@ jobs:
           project_id: '${{ vars.PROJECT_ID }}'
           cluster_name: '${{ vars.PUBLIC_CLUSTER_NAME }}'
           location: '${{ vars.PUBLIC_CLUSTER_LOCATION }}'
+          namespace: 'default'
 
       - name: 'kubectl'
         run: |-
@@ -74,6 +75,7 @@ jobs:
           cluster_name: '${{ vars.PRIVATE_CLUSTER_NAME }}'
           location: '${{ vars.PRIVATE_CLUSTER_LOCATION }}'
           use_connect_gateway: 'true'
+          namespace: 'default'
 
       - name: 'kubectl'
         run: |-

README.md

@@ -84,6 +84,8 @@ jobs:
 -   <a name="context_name"></a><a href="#user-content-context_name"><code>context_name</code></a>: _(Optional)_ Name to use when creating the `kubectl` context. If not specified, the
     default value is `gke_<project>_<location>_<cluster>`.
 
+-   <a name="namespace"></a><a href="#user-content-namespace"><code>namespace</code></a>: _(Optional)_ Name of the Kubernetes namespace to use within the context.
+
 -   <a name="use_auth_provider"></a><a href="#user-content-use_auth_provider"><code>use_auth_provider</code></a>: _(Optional, default: `false`)_ Set this to true to use the Google Cloud auth plugin in `kubectl` instead
     of inserting a short-lived access token.
 

action.yml

@@ -53,6 +53,11 @@ inputs:
       default value is `gke_<project>_<location>_<cluster>`.
     required: false
 
+  namespace:
+    description: |-
+      Name of the Kubernetes namespace to use within the context.
+    required: false
+
   use_auth_provider:
     description: |-
       Set this to true to use the Google Cloud auth plugin in `kubectl` instead

dist/index.js

@@ -358,6 +358,7 @@ export class ClusterClient {
           context: {
             cluster: cluster.data.name,
             user: cluster.data.name,
+            namespace: opts.namespace,
           },
           name: contextName,
         },
@@ -366,6 +367,7 @@ export class ClusterClient {
       'current-context': contextName,
       'users': [{ ...{ name: cluster.data.name }, ...auth }],
     };
+
     return YAML.stringify(kubeConfig);
   }
 
@@ -393,6 +395,7 @@ type context = {
   context: {
     cluster: string;
     user: string;
+    namespace?: string;
   };
   name: string;
 };
@@ -414,6 +417,9 @@ export type CreateKubeConfigOptions = {
 
   // contextName is the name of the context.
   contextName: string;
+
+  // namespace is the name of the Kubernetes namespace.
+  namespace?: string;
 };
 
 export type KubeConfig = {

src/client.ts

@@ -46,6 +46,7 @@ export async function run(): Promise<void> {
     const useAuthProvider = parseBoolean(getInput('use_auth_provider'));
     const useInternalIP = parseBoolean(getInput('use_internal_ip'));
     let contextName = getInput('context_name');
+    const namespace = presence(getInput('namespace'));
     const useConnectGateway = parseBoolean(getInput('use_connect_gateway'));
 
     // Only one of use_connect_gateway or use_internal_ip should be provided
@@ -129,6 +130,7 @@ export async function run(): Promise<void> {
       connectGWEndpoint: connectGWEndpoint,
       clusterData: clusterData,
       contextName: contextName,
+      namespace: namespace,
     });
 
     // Write kubeconfig to disk

src/main.ts

@@ -20,7 +20,7 @@ import assert from 'node:assert';
 import crypto from 'crypto';
 import YAML from 'yaml';
 
-import { ClusterClient, ClusterResponse } from '../src/client';
+import { ClusterClient, ClusterResponse, KubeConfig } from '../src/client';
 
 import { skipIfMissingEnv } from '@google-github-actions/actions-utils';
 
@@ -152,7 +152,7 @@ test(
   '#getToken',
   {
     concurrency: true,
-    skip: skipIfMissingEnv('TEST_PROJECT_ID', 'TEST_CLUSTER_ID', 'TEST_CLUSTER_LOCATION'),
+    skip: skipIfMissingEnv('TEST_PROJECT_ID', 'TEST_CLUSTER_NAME', 'TEST_CLUSTER_LOCATION'),
   },
   async (suite) => {
     await suite.test('can get token', async () => {
@@ -174,7 +174,7 @@ test(
   '#getCluster',
   {
     concurrency: true,
-    skip: skipIfMissingEnv('TEST_PROJECT_ID', 'TEST_CLUSTER_ID', 'TEST_CLUSTER_LOCATION'),
+    skip: skipIfMissingEnv('TEST_PROJECT_ID', 'TEST_CLUSTER_NAME', 'TEST_CLUSTER_LOCATION'),
   },
   async (suite) => {
     const testProjectID = process.env.TEST_PROJECT_ID!;
@@ -300,7 +300,7 @@ test(
   '#createKubeConfig',
   {
     concurrency: true,
-    skip: skipIfMissingEnv('TEST_PROJECT_ID', 'TEST_CLUSTER_ID', 'TEST_CLUSTER_LOCATION'),
+    skip: skipIfMissingEnv('TEST_PROJECT_ID', 'TEST_CLUSTER_NAME', 'TEST_CLUSTER_LOCATION'),
   },
   async (suite) => {
     const testProjectID = process.env.TEST_PROJECT_ID!;
@@ -345,7 +345,7 @@ test(
           projectID: testProjectID,
           location: testClusterLocation,
         });
-        const kubeconfig = YAML.parse(
+        const kubeconfig: KubeConfig = YAML.parse(
           await client.createKubeConfig({
             useAuthProvider: true,
             useInternalIP: false,
@@ -370,7 +370,7 @@ test(
         );
 
         assert.deepStrictEqual(user?.name, publicCluster?.data?.name);
-        assert.deepStrictEqual(user?.user?.['auth-provider'], 'gcp');
+        assert.deepStrictEqual(user?.user?.['auth-provider']?.name, 'gcp');
       },
     );
 
@@ -380,7 +380,7 @@ test(
         projectID: testProjectID,
         location: testClusterLocation,
       });
-      const kubeconfig = YAML.parse(
+      const kubeconfig: KubeConfig = YAML.parse(
         await client.createKubeConfig({
           useAuthProvider: false,
           useInternalIP: true,
@@ -413,7 +413,7 @@ test(
         projectID: testProjectID,
         location: testClusterLocation,
       });
-      const kubeconfig = YAML.parse(
+      const kubeconfig: KubeConfig = YAML.parse(
         await client.createKubeConfig({
           useAuthProvider: false,
           useInternalIP: false,
@@ -428,7 +428,27 @@ test(
       assert.deepStrictEqual(kubeconfig?.['current-context'], contextName);
 
       assert.deepStrictEqual(cluster?.name, privateCluster.data.name);
-      assert.deepStrictEqual(cluster?.server, 'https://foo');
+      assert.deepStrictEqual(cluster?.cluster.server, 'https://foo');
+    });
+
+    await suite.test('can set a namespace=', async () => {
+      const contextName = crypto.randomBytes(12).toString('hex');
+      const client = new ClusterClient({
+        projectID: testProjectID,
+        location: testClusterLocation,
+      });
+      const kubeconfig: KubeConfig = YAML.parse(
+        await client.createKubeConfig({
+          useAuthProvider: false,
+          useInternalIP: false,
+          clusterData: privateCluster,
+          contextName: contextName,
+          namespace: 'my-namespace',
+        }),
+      );
+
+      const context = kubeconfig?.contexts?.at(0)?.context;
+      assert.deepStrictEqual(context?.namespace, 'my-namespace');
     });
   },
 );