Skip to main content

SHIFT SmartDashboard Services

User Documentation for Smartdashboard​

Click here to User Documentation for Smartdashboard

Shift SmartDashboard Services configuration​

Scope: Configuration options for KOBIL Shift SmartDashboard services

The smartDashboard services requires post-deployment reconfiguration to enable the "smartDashboard client" within KOBIL Shift IDP services. See KOBIL Shift  "README" for more details.

Find here part of the KOBIL Shift README:

Post deployment configuration (from KOBIL README)

Create confidential OIDC client workspacemanagement and configure its client_id and client_secret in metaconfig file shift-values.yaml.

smartdashboardKongConfigurationBackend:

# -- client_id and client_secret of an OIDC client in IDP master realm. Must be manually created.
  config:
    masterClientId: "workspacemanagement"
    masterClientSecret: "client_secret"

At configuration work the steps are as follows:

Complete initial KOBIL Shift setup and deployment tasks. At this time a working KOBIL Shift IDP service is running and login to the "admin-GUI" is possible by configured admin-credential-set (from used KOBIL Shift metaconfig). Now create a new IDP client instance in the MASTER realm context - this client will become the Smartdashboard Client ID. Save the configuration parameter from this client setup. Update the KOBIL Shift metaconfig with the created client parameter and reapply the deployment to enable this client.

Sample configuration in IDP(Keycloak) Admin GUI - setup smartdashboard IDP client

Create "smartdashboard" client in IDP-client dialogs with following settings (note: client name is not fixed - could be configured as appropriate i.e. workspacemanagement or smartdashboard):

Login Theme : kobil-portal

Access Type : confidential

Valid Redirect URIs : *

Due to client being confidential after saving the "Credentials" will be filled and you have to save/copy the masterClientSecret.

# -- Configuration for smartdashboard-kong-configuration-backend
smartdashboardKongConfigurationBackend:
  enabled: true
  replicaCount: 1

  # -- client_id and client_secret of an OIDC client in IDP master realm. Must be manually created.
  config:
    masterClientId: "smartdashboard"
    masterClientSecret: "jlieXanpDDLnb4qR8VgoaQncooYpJb"

Access the KOBIL Portal (initial "master" context only) by open URL https://smartdashboard.{{global.routing.domain}}/dashboard/master/workspace-management

Functionality in smartDashboard (what to see, what to do, configuration options to enable more/less views)

Required SmartDashboard Services

smartdashboard-app-managemement smartdashboard-frontend smartdashboard-kong-config smartdashboard-reports smartdashboard-routes-admin smartdashboard-routes-proxy smartdashboard-user-management smartdashboard-workspace-management

References to KOBIL Shift metaconfig values.yaml

# -- Configuration for smartdashboard-routes
smartdashboardRoutes:
  database:
    host: postgres
    port: 5432
    name: "smartdashboard"
    schema: "routes"
    auth:
      username: user
      password: "password"
 
# -- Configuration for smartdashboard-frontend
smartdashboardFrontend:
  enabled: true
  replicaCount: 1
 
# -- Configuration for smartdashboard-smartscreen
smartdashboardSmartscreen:
  enabled: true
  replicaCount: 1
 
  config:
    # -- Default browser flow for OIDC clients created for MiniApps.
    authenticationBrowserFlow: 'browser'
 
  database:
    host: postgres
    port: 5432
    name: "smartdashboard"
    schema: "smartscreen"
    auth:
      username: user
      password: "password"
 
# -- Configuration for smartdashboard-user-management
smartdashboardUserManagement:
  enabled: true
  replicaCount: 1
 
  config:
    # -- Email template to use when sending emails.
    mailTemplateName: 'smartdashboard-update-profile.ftl'
 
    # -- Email subject for invitation emails.
    updateMailSubject: 'Welcome to your KOBIL Shift Portal'
 
    # -- Defines mail type to be sent when inviting a user.
    # Should be set to `UPDATE_USER_PROFILE` when using ast-services
    # and `VERIFY` when using SSMS.
    mailType: 'UPDATE_USER_PROFILE'
 
    # -- Defines required actions that need to be performed by
    # user during first login.
    # Should be set to `KOBIL_UPDATE_USER_PROFILE` when using ast-services
    # and `UPDATE_PASSWORD` when using SSMS.
    requiredActions: 'KOBIL_UPDATE_USER_PROFILE'
 
# -- Configuration for smartdashboard-analytics
smartdashboardAnalytics:
  enabled: false
  replicaCount: 1
 
  # -- Database used by Segment
  database:
    host: postgres-segment
    port: 5432
    name: "shift"
    schema: "tenant"
    auth:
      username: user
      password: "password"
 
# -- Configuration for smartdashboard-reports
smartdashboardReports:
  enabled: false
  replicaCount: 1
 
  # -- Sentry configuration
  sentry:
    url: 'https://sentry.io/api/0/'
    token: 'sentry token'
    env: 'environment=store'
    organization: 'kobil-gmbh'
    project: 'customer app'
    issueId: 'sentry issue id'
    # -- Events endpoint for sentry. Change to eventsv2 for older on premise installations.
    urlEvent: 'events'
 
  config:
    # -- Default sentry environment
    defaultEnv: 'shift'
 
  # -- Redis credentials used by smartdashboard-reports
  redis:
    user: default
    password: password
 
# -- Configuration for smartdashboard-broadcast
smartdashboardBroadcast:
  enabled: true
  replicaCount: 1
 
  database:
    host: postgres
    port: 5432
    name: "smartdashboard"
    schema: "broadcast"
    auth:
      username: user
      password: "password"
 
# -- Configuration for smartdashboard-app-management
smartdashboardAppManagement:
  enabled: true
  replicaCount: 1
 
# -- Configuration for smartdashboard-app-builder
smartdashboardAppBuilder:
  enabled: false
  replicaCount: 1
 
  config:
    # -- App bundle IP
    bundleId: 'com.example.app.{tenant}'
    # -- API key for authentication at app builder proxy
    externalApiKey: 'api-key'
    # -- URL of app-builder proxy
    appBuilderProxyBaseUrl: 'https://app-builder-proxy.example.com'
    # flavor is env specific
    flavorName: 'shift'
    flavorEnv: 'test'
 
    # -- The TLS bundle to be included in sdk-config.jwt. Only a single certificate
    # is supported. Must be set to the root CA that issued the TLS certificate on the
    # public AST endpoints. Expected format is BASE64 encoded PEM.
    tlsBundle: ''
 
    # -- Segment configuration
    segment:
      baseUrl: 'https://api.segmentapis.com'
      authToken: 'segment auth token'
      selectedWarehouseId: 'warehouse id for environment'
      sourceMetadataId: 'source meta data id'
 
    # -- Sentry configuration
    sentry:
      baseUrl: 'https://sentry.io/api/0/'
      baseToken: 'sentry token'
      team: 'development'
      orgEvent: 'kobil-gmbh'
      envName: 'shift'
 
  database:
    host: postgres
    port: 5432
    name: "smartdashboard"
    schema: "appbuilder"
    auth:
      username: user
      password: "password"
 
# -- Configuration for smartdashboard-workspace-management
smartdashboardWorkspaceManagement:
  enabled: true
  replicaCount: 1
 
  # -- Email and theme settings
  config:
    loginTheme: 'smart-dashboard'
    mailTemplateName: 'smartdashboard-password-reset.ftl'
    loginAccountAdminTheme : 'kobilv2'
    emailTheme : 'kobilv2'
    inviteMailSubject : 'Welcome to your KOBIL Shift Portal'
 
# -- Configuration for smartdashboard-kong-configuration-backend
smartdashboardKongConfigurationBackend:
  enabled: true
  replicaCount: 1
 
  # -- client_id and client_secret of an OIDC client in IDP master realm. Must be manually created.
  config:
    masterClientId: "client_id"
    masterClientSecret: "client_secret"
 
# -- Configuration for smartdashboard-tile38
smartdashboardTile38:
  enabled: false
  replicaCount: 1