This the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Advanced configuration guide

Advanced Configuration Guide of SpaceONE

    Title and Favicon

    SpaceONE has default title and CI with Wanny favicon.

    But you can change them to your own title and favicon.


    ComponentFile PathDescription
    Title/var/www/title.txtname of Title
    Favicon/var/www/favicon.icofavicon file

    Console supports the functionality of changing title and favicon. The default values are in source code, but you can overwrite them when deploying pods.


    This is an example value of console.yaml file.
      # favicon
      volumeMounts:
          application:
              - name: favicon
                mountPath: /var/www/title.txt
                subPath: title.txt
                readOnly: true
              - name: favicon-img
                mountPath: /var/www/favicon.ico
                subPath: favicon.ico
                readOnly: true
    
    
      volumes:
          - name: favicon
            configMap:
                name: favicon
          - name: favicon-img
            configMap:
                name: favicon-img
    

    The actual values are from Kubernetes ConfigMap object. So you might have to change the value at ConfigMap or create a new one and mount it in your pod.

    Title

    apiVersion: v1
    kind: ConfigMap
    metadata:
      name: favicon
      namespace: spaceone
    data:
      title.txt: |
        KB One Cloud
    

    Favicon

    apiVersion: v1
    kind: ConfigMap
    metadata:
      name: favicon-img
      namespace: spaceone
    binaryData:
      favicon.ico: AAABAAEAAAAAAAEAIADxxxxxxx...
    

    NOTE: favicon.ico must be base64 encoded.

    # cat favicon.ico | base64
    

    Corporate Identity

    When you open SpaceONE page, you can see the default SpaceONE CI, logo and text. You can change the default SpaceONE CI with your company CI.

    Login Page

    Every Page

    Update helm value of console (console -> production_json -> DOMAIN_IMAGE)

    keyword: DOMAIN_IMAGE

    ConfigurationDescriptionFormat
    CI_LOGOCustom Logo ImageImage (56 * 56 px)
    CI_TEXT_WITH_TYPECI Text ImageImage (164 * 40 px)
    SIGN_INSign-in page ImageImage (1024 * 1024 px)
    CI_TEXTCI Text Image On every pageImage (123 * 16 px)

    NOTE: Recommended file format is SVG. But if you would like to use a PNG file, use transparent background and double the size than recommended size.

    NOTE: SpaceONE does not support uploading files, so upload CI files at your web server or S3.!

    console:
      enabled: true
      developer: false
      name: console
      replicas: 2
      image:
          name: spaceone/console
          version: 1.8.7
      imagePullPolicy: IfNotPresent
    
    #######################
    # TODO: Update value
    #  - ENDPOINT
    #  - GTAG_ID (if you have google analytics ID)
    #  - AMCHARTS_LICENSE (for commercial use only)
    #######################
      production_json:
          CONSOLE_API:
              ENDPOINT: http://console-api.example.com
          DOMAIN_IMAGE:
              CI_LOGO: https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/domain/example/ci-logo.svg
              CI_TEXT_WITH_TYPE: https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/domain/example/ci-text1.svg
              SIGN_IN: https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/domain/example/login-img.png
              CI_TEXT: https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/domain/example/ci-text2.svg
    

    Google Analytics

    You can apply Google Analytics to SpaceONE Console by following the steps below.

    Create accounts and properties

    1. Log in to your Google account after accessing the Google Analytics site.

    2. Click the Start Measurement button.

      ga_start_01

    3. Enter your account name and click the Next button.

      ga_start_02

    4. Enter a property name and click the Next button.

      In the property name, enter the name of the url you want to track.

      ga_start_03

    5. Click the Create button.

      ga_start_04

    6. Click the Agree button after agreeing to the data processing terms.

      ga_start_05

    Set up data streams

    1. Choose Web as the platform for the data stream you want to collect.

      ga_data_stream_01

    2. Enter your SpaceONE Console website URL and stream name and click the Create Stream button.

      ga_data_stream_02

    3. Check the created stream information and copy the measurement ID.

      ga_data_stream_03

    Set up the SpaceONE Helm Chart

    Paste the copied measurement ID as the value for the GTAG_ID key in the helm chart settings as shown below.

    # frontend.yaml
    console:
      ...
      production_json:
        ...
        GTAG_ID: {measurement ID}
        ...