centraldashboard: Support dynamic logout URL

Use dynamic URL for the logout button that can be set by the LOGOUT_URL ENV variable in the deployment of the app. If it is unset, a default '/logout' string is passed from the backend to the frontend. Signed-off-by: Orfeas Kourkakis <orfeas@arrikto.com>
kubeflow · Feb 10, 2023 · 9356553 · 9356553
1 parent 1552c90
commit 9356553
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 10 deletions.
diff --git a/components/centraldashboard/app/k8s_service.ts b/components/centraldashboard/app/k8s_service.ts
@@ -2,14 +2,16 @@ import * as k8s from '@kubernetes/client-node';
 
 /** Retrieve Dashboard configmap Name */
 const {
-  DASHBOARD_CONFIGMAP = "centraldashboard-config"
+  DASHBOARD_CONFIGMAP = "centraldashboard-config",
+  LOGOUT_URL = '/logout'
 } = process.env;
 
 /** Information about the Kubernetes hosting platform. */
 export interface PlatformInfo {
   provider: string;
   providerName: string;
   kubeflowVersion: string;
+  logoutUrl: string;
 }
 
 /**
@@ -111,7 +113,8 @@ export class KubernetesService {
       return {
         kubeflowVersion: version,
         provider,
-        providerName: provider.split(':')[0]
+        providerName: provider.split(':')[0],
+        logoutUrl : LOGOUT_URL,
       };
     } catch (err) {
       console.error('Unexpected error', err);

diff --git a/components/centraldashboard/app/k8s_service_test.ts b/components/centraldashboard/app/k8s_service_test.ts
@@ -228,7 +228,8 @@ describe('KubernetesService', () => {
         provider:
             'gce://kubeflow-dev/us-east1-d/gke-kubeflow-default-pool-59885f2c-08tm',
         providerName: 'gce',
-        kubeflowVersion: '1.0.0'
+        kubeflowVersion: '1.0.0',
+        logoutUrl: '/logout'
       });
     });
 
@@ -269,7 +270,8 @@ describe('KubernetesService', () => {
       expect(platformInfo).toEqual({
         provider: 'other://',
         providerName: 'other',
-        kubeflowVersion: '1.0.0'
+        kubeflowVersion: '1.0.0',
+        logoutUrl: '/logout'
       });
     });
 
@@ -316,7 +318,8 @@ describe('KubernetesService', () => {
         provider:
             'gce://kubeflow-dev/us-east1-d/gke-kubeflow-default-pool-59885f2c-08tm',
         providerName: 'gce',
-        kubeflowVersion: 'unknown'
+        kubeflowVersion: 'unknown',
+        logoutUrl: '/logout'
       });
     });
 
@@ -330,7 +333,8 @@ describe('KubernetesService', () => {
       expect(platformInfo).toEqual({
         provider: 'other://',
         providerName: 'other',
-        kubeflowVersion: 'unknown'
+        kubeflowVersion: 'unknown',
+        logoutUrl: '/logout'
       });
     });
   });

diff --git a/components/centraldashboard/manifests/base/deployment.yaml b/components/centraldashboard/manifests/base/deployment.yaml
@@ -40,4 +40,6 @@ spec:
           value: $(CD_REGISTRATION_FLOW)
         - name: DASHBOARD_LINKS_CONFIGMAP
           value: $(CD_CONFIGMAP_NAME)
+        - name: LOGOUT_URL
+          value: '/authservice/logout'
       serviceAccountName: centraldashboard
diff --git a/components/centraldashboard/public/components/logout-button.js b/components/centraldashboard/public/components/logout-button.js
@@ -13,12 +13,12 @@ export class LogoutButton extends PolymerElement {
     static get template() {
         return html`
             <paper-button id="logout-button" on-tap="logout">
-                <iron-icon icon='kubeflow:logout' title="Logout"
+                <iron-icon icon='kubeflow:logout' title="Logout">
                 </iron-icon>
             </paper-button>
             <iron-ajax
                     id='logout'
-                    url='/logout'
+                    url$='{{logoutUrl}}'
                     method='post'
                     handle-as='json'
                     headers='{{headers}}'
@@ -33,6 +33,9 @@ export class LogoutButton extends PolymerElement {
                 type: Object,
                 computed: '_setHeaders()',
             },
+            logoutUrl: {
+                type: String,
+            },
         };
     }
 

diff --git a/components/centraldashboard/public/components/main-page.js b/components/centraldashboard/public/components/main-page.js
@@ -88,6 +88,7 @@ export class MainPage extends utilitiesMixin(PolymerElement) {
             errorText: {type: String, value: ''},
             buildVersion: {type: String, value: BUILD_VERSION},
             dashVersion: {type: String, value: VERSION},
+            logoutUrl: {type: String, value: '/logout'},
             platformInfo: Object,
             inIframe: {type: Boolean, value: false, readOnly: true},
             hideTabs: {type: Boolean, value: false, readOnly: true},
@@ -476,6 +477,9 @@ export class MainPage extends utilitiesMixin(PolymerElement) {
         if (kVer && kVer != 'unknown') {
             this.buildVersion = this.platformInfo.kubeflowVersion;
         }
+        if (platform.logoutUrl) {
+            this.logoutUrl = platform.logoutUrl;
+        }
         // trigger template render
         this.menuLinks = JSON.parse(JSON.stringify(this.menuLinks));
         this._enableAllNamespaceOption();

diff --git a/components/centraldashboard/public/components/main-page.pug b/components/centraldashboard/public/components/main-page.pug
@@ -82,7 +82,7 @@ app-drawer-layout.flex(narrow='{{narrowMode}}',
                     all-namespaces='[[allNamespaces]]', 
                     user='[[user]]')
                 footer#User-Badge
-                    logout-button
+                    logout-button(logout-url='[[logoutUrl]]')
         main#Content
             section#ViewTabs(hidden$='[[hideTabs]]')
                 paper-tabs(selected='[[page]]', attr-for-selected='page')

diff --git a/components/centraldashboard/public/components/namespace-selector.js b/components/centraldashboard/public/components/namespace-selector.js
@@ -9,7 +9,7 @@ import {html, PolymerElement} from '@polymer/polymer/polymer-element.js';
 
 export const ALL_NAMESPACES = 'All namespaces';
 export const ALL_NAMESPACES_ALLOWED_LIST = ['jupyter', 'volumes',
-                                            'tensorboards'];
+    'tensorboards'];
 
 const allNamespacesAllowedPaths = ALL_NAMESPACES_ALLOWED_LIST
     .map(( p)=>`/_/${p}/`);