Skip to main content
Version: 1.18.2 (latest)

Update instructions

Update OMNI Platform from version =<1.13.0 to version =>1.14.0

Before upgrading OMNI Platform, to maintain access to the database and the main configuration, transfer the existing field values in the files as follows:

note

In the ingress.rules.gateway.host field insert the full host name, for example, platform.example.com.

note

Dots in the field name denote nesting of yaml or json structure.

Old fileFieldNew fileField
./setup/settings.envMASTER_NODE_IP_ADDRESS./cfg/smc.settings.cfgapiserver_advertise_address, external_ip_address
POSTGRES_USER./cfg/platform.secrets.jsonpostgres-root-credentials.user
POSTGRES_PASSWORDpostgres-root-credentials.password
SERVICE_KEYplatform-service-key.service_key
LIC_SERVER_IP_ADDRESSlicense-secret.server_url
LIC_KEYlicense-secret.key
PLATFORM_ADMIN_EMAILplatform-user-secret.admin_email
PLATFORM_ADMIN_PASSWORDplatform-user-secret.admin_password
PLATFORM_DEFAULT_EMAILplatform-user-secret.default_email
PLATFORM_DEFAULT_PASSWORDplatform-user-secret.default_password
EMAIL_HOSTplatform-email-secret.email_host
EMAIL_HOST_USERplatform-email-secret.email_host_user
EMAIL_HOST_PASSWORDplatform-email-secret.email_host_password
EMAIL_FROMplatform-email-secret.email_from
EMAIL_USE_SSLplatform-email-secret.email_use_ssl
QUERY_LIMIT./cfg/platform.values.yamlbackend.query_limit
INDEX_UPDATE_PERIODbackend.index_update_period
USE_CUDAprocessing.use_cuda
DOMAINingress.rules.gateway.host
./setup/settings.envLIC_KEY./cfg/license-server.settings.cfglicense-secret.key
LIC_SERVER_IP_ADDRESSlicense-secret.server_url
./deploy/services_db_config.jsonstorage-engine-db.credentials.POSTGRES_USER./cfg/platform.secrets.jsonstorage-engine-postgres.user
storage-engine-db.credentials.POSTGRES_PASSWORDstorage-engine-postgres.password
storage-engine-db.credentials.POSTGRES_DBstorage-engine-postgres.db
event-service-db.credentials.POSTGRES_USERevent-service-postgres.user
event-service-db.credentials.POSTGRES_PASSWORDevent-service-postgres.password
event-service-db.credentials.POSTGRES_DBevent-service-postgres.db

Update OMNI Platform from version 1.14.* to later

Before updating OMNI Platform, to maintain access to the database and the main configuration, transfer existing field values to the files of the new version.

ATTENTION!

It is not recommended to replace the files, as some fields that appeared in the installed release may be lost.

After all fields have been transferred, go to the folder with the new OMNI Platform and run the following command:

./cli.sh platform install-secrets

This action is mandatory, otherwise the services will not receive the required set of fields and won't be able to start.

You can then continue to deploy the new version as if you were doing a clean installation.

Delete the old OMNI Platform version

  1. Move to <distribution_folder>/setup folder and stop OMNI Platform:

    ./cli.sh platform uninstall
    ./cli.sh image-api uninstall
  2. Make sure that all service containers are stopped:

    watch 'kubectl get pods'

    Service statuses should change from Running to Terminating. As a result, all services are removed from the console output.

  3. Delete the deployed Kubernetes cluster:

    ./cli.sh smc uninstall
  4. Delete auxiliary files of Kubernetes cluster:

    sudo rm -rf ~/.kube/
    note

    When the platform is deleted, the entire database is saved in the /kv/pgdata directory. For further use of this database you need to specify the same authorization data and database name when installing the new version of the Platform. Otherwise, run the command below:

    ./cli.sh platform db-reset