Deploy UI bundle

Owned by Renat Safiulin
Last updated: Dec 13, 2023
2 min read

Domain

Pattern for tenant UI: https://<cluster-name>-<project-name>-<tenant-name>.ci.folio.org

This article describes how to deploy ui bundle on rancher environment

Job: Deploy UI

Parameters

ParameterTypeDescription
CLUSTERlist<string>(Required) Select cluster
NAMESPACElist<string>

(Required) Select cluster namespace

FOLIO_REPOSITORYlist<string>Repository from which UI bundle should build
FOLIO_BRANCHlist<string>

(Required) Select what 'platform-complete' branch use for build UI bundle

CONFIG_TYPElist<string>Select deployment config type. By default - deployment
TENANT_IDstringTenant id used for UI bundle creation
UI_BUNDLE_BUILDbooleanTrue if new UI bundle should be created. False if UI_BUNDLE_TAG parameter should be used
UI_BUNDLE_TAGlist<string>Choose image tag for UI
CUSTOM_HASHstring(Optional) Commit hash for UI bundle build from specific commit
CONSORTIAboolean(Optional) If True consortia tenant should be added to UI bundle

To update UI bundle you should know in what cluster you environment located. See Projects(Namespaces) page.

Steps

  1. Go to Jenkins
  2. Navigate to folioRancher -> folioDevTools -> uiManagement -> deployUI -> deployUI
  3. Click Build with Parameters (if you didn't see this button, contact Kitfox team)
  4. Select parameters
    1. CLUSTER - Select name of the cluster where your rancher environment located
    2. NAMESPACE - Select name of target environment
    3. FOLIO_REPOSITORY - Select repository from which ui bundle should build (platform-complete or platform-core)
    4. FOLIO_BRANCH - Select branch from which ui bundle should build
    5. CONFIG_TYPE - Select deployment config type.
    6. TENANT_ID - Set correct tenant id for which this ui bundle should be used 
    7. UI_BUNDLE_BUILD - If you want build and deploy new ui bundle then set this parameter to true
    8. UI_BUNDLE_TAG - If you previously build ui bundle image or you want to rollback, then select it's name from drop-down list and leave ui_bundle_build parameter as false
    9. CUSTOM_HASH - Commit hash for UI bundle build from specific commit
    10. CONSORTIA - If True consortia tenant should be added to UI bundle, in case of creation new UI bundle.
  5. Click Build button
  6. Wait for completion

Example