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:
In the ingress.rules.gateway.host field
insert the full host name, for example, platform.example.com.
Dots in the field name denote nesting of yaml or json structure.
Old file | Field | New file | Field |
./setup/settings.env | MASTER_NODE_IP_ADDRESS | ./cfg/smc.settings.cfg | apiserver_advertise_address, external_ip_address |
POSTGRES_USER | ./cfg/platform.secrets.json | postgres-root-credentials.user | |
POSTGRES_PASSWORD | postgres-root-credentials.password | ||
SERVICE_KEY | platform-service-key.service_key | ||
LIC_SERVER_IP_ADDRESS | license-secret.server_url | ||
LIC_KEY | license-secret.key | ||
PLATFORM_ADMIN_EMAIL | platform-user-secret.admin_email | ||
PLATFORM_ADMIN_PASSWORD | platform-user-secret.admin_password | ||
PLATFORM_DEFAULT_EMAIL | platform-user-secret.default_email | ||
PLATFORM_DEFAULT_PASSWORD | platform-user-secret.default_password | ||
EMAIL_HOST | platform-email-secret.email_host | ||
EMAIL_HOST_USER | platform-email-secret.email_host_user | ||
EMAIL_HOST_PASSWORD | platform-email-secret.email_host_password | ||
EMAIL_FROM | platform-email-secret.email_from | ||
EMAIL_USE_SSL | platform-email-secret.email_use_ssl | ||
QUERY_LIMIT | ./cfg/platform.values.yaml | backend.query_limit | |
INDEX_UPDATE_PERIOD | backend.index_update_period | ||
USE_CUDA | processing.use_cuda | ||
DOMAIN | ingress.rules.gateway.host | ||
./setup/settings.env | LIC_KEY | ./cfg/license-server.settings.cfg | license-secret.key |
LIC_SERVER_IP_ADDRESS | license-secret.server_url | ||
./deploy/services_db_config.json | storage-engine-db.credentials.POSTGRES_USER | ./cfg/platform.secrets.json | storage-engine-postgres.user |
storage-engine-db.credentials.POSTGRES_PASSWORD | storage-engine-postgres.password | ||
storage-engine-db.credentials.POSTGRES_DB | storage-engine-postgres.db | ||
event-service-db.credentials.POSTGRES_USER | event-service-postgres.user | ||
event-service-db.credentials.POSTGRES_PASSWORD | event-service-postgres.password | ||
event-service-db.credentials.POSTGRES_DB | event-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.
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
Move to
<distribution_folder>/setup
folder and stop OMNI Platform:./cli.sh platform uninstall
./cli.sh image-api uninstallMake sure that all service containers are stopped:
```bash
watch 'kubectl get pods'
```Service statuses should change from Running to Terminating. As a result, all services are removed from the console output.
Delete the deployed Kubernetes cluster:
./cli.sh smc uninstall
Delete auxiliary files of Kubernetes cluster:
sudo rm -rf ~/.kube/
Reset IPVS tables of your system:
```bash
sudo ipvsadm --clear
```noteWhen 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:```bash
./cli.sh platform db-reset
```