Manage a Semarchy xDM instance on Azure Kubernetes Service (AKS)

Upgrade Semarchy xDM

Review the pre-upgrade instructions before upgrading your instance(s) of Semarchy xDM.

Stop all applications and user connections to Semarchy xDM during the upgrade:

  • No application should access the Semarchy xDM services and APIs.

  • No user should access the Semarchy user interfaces for design-time or data management operations.

  • No user or application should access the repository or data locations' database schemas.

Contact your database administrator and middleware administrator to ensure Semarchy xDM remains unavailable throughout the upgrade process.

To upgrade Semarchy xDM:

  1. Navigate to the folder containing Kubernetes descriptor files for the active and passive deployments.

  2. Update both the descriptor files to use the new Semarchy xDM image to upgrade to. Refer to the Semarchy xDM Docker Hub page for more information.

  3. Run the following command to delete the active application server deployment:

    $ kubectl delete deployment.apps/semarchy-appserver-active
  4. Run the following command to delete the passive application server deployment:

    $ kubectl delete deployment.apps/semarchy-appserver-passive
  5. Repeat the deployment steps 8 and 9 to apply the new deployments for the active and passive application servers.

  6. Upgrade the repository and upgrade the data locations.

Azure resources

Azure AKS

Refer to Upgrade an Azure Kubernetes Service Cluster for more information on upgrading the AKS cluster control plane.

Azure Database for PostgreSQL

Refer to Upgrade PostgreSQL database for more information on upgrading the Azure PostgreSQL instances.

Backup

Semarchy xDM

Refer to the Upgrade Procedure Steps for more information on backing up your installation of Semarchy xDM.

Azure Database for PostgreSQL

Refer to Back up Azure Database for PostgreSQL server for more information on managing backups with Azure Database for PostgreSQL server.

Maintenance and troubleshooting

Semarchy xDM

The following is a non-exhaustive list of commands useful for monitoring and troubleshooting Semarchy xDM:

  • Get the pods running on the active application server.

    $ kubectl get pods -l app=semarchy-appserver-active
  • Get the pods running on the passive application servers.

    $ kubectl get pods -l app=semarchy-appserver-passive
  • Get details for a specific pod.

    $ kubectl describe pod _<pod_name>_
  • Get logs for the active application server.

    $ kubectl logs -l app=semarchy-appserver-active
  • Get logs for the passive application servers.

    $ kubectl logs -l app=semarchy-appserver-passive
  • Get details for the active application server deployment.

    $ kubectl get deployments -l app=semarchy-appserver-active
  • Get details for the passive application server deployment.

    $ kubectl get deployments -l app=semarchy-appserver-passive

Additionally, the platform offers REST API readiness probes to monitor the application status.

Kubernetes deployments and pods

Refer to Cluster Administration for more information on maintaining and managing Kubernetes deployment and pods.

Azure resources

Azure AKS

Refer to AKS troubleshooting for more information on troubleshooting Azure AKS.

Azure Database for PostgreSQL

Refer to Troubleshoot PostgreSQL database for more information on troubleshooting the Azure Database for PostgreSQL instances.

License and support

Refer to Manage the license for more information.

Additional services on Azure

Azure Key Vault

Semarchy xDM supports Key Management Services and Secrets Manager to store the platform’s sensitive configuration items such as credentials, API keys, or passwords and to implement rotating system credentials.

Refer to Configure a Key Management Service for more information on configuring Azure Key Vault.

Azure Monitor

Azure Monitor can be used to monitor the different resources of the architecture.

Azure AKS

Azure Database for PostgreSQL

Refer to Monitor Azure SQL Database with Azure Monitor for more information.