Manage a Semarchy xDM instance in AWS

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. For more information, see the Docker Hub page.

  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 step 8 and step 9 to apply the new deployments for the active and passive application servers.

  6. Upgrade the repository and upgrade the data locations.

AWS resources

Amazon EKS

For more information on upgrading the EKS cluster control plane, see Updating control plane version.

Amazon Aurora

For more information on upgrading the Amazon Aurora cluster, see Upgrading the PostgreSQL DB engine for Aurora PostgreSQL.

Backup

Semarchy xDM

For more information on backing up your installation of Semarchy xDM, see the upgrade procedure.

Amazon Aurora

For more information on managing backups with Amazon Aurora, see Overview of backing up and restoring an Aurora DB cluster.

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

For more information on maintaining and managing Kubernetes deployment and pods, see Cluster Administration.

AWS resources

Amazon EKS

For more information on troubleshooting Amazon Elastic Kubernetes Service (EKS), see Amazon EKS troubleshooting.

Amazon Aurora

For more information on troubleshooting the Amazon Aurora instances, see Troubleshooting for Amazon Aurora.

License and support

For more information, see Semarchy xDM system requirements.

Additional services on AWS

Secrets

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

Amazon KMS

For more information on configuring Amazon KMS, see Configure a key management service.

Amazon Secrets Manager

For more information on configuring Amazon Secrets Manager, see Configure External Secrets Managers.

CloudWatch

Amazon CloudWatch can be used to monitor the different resources of the architecture.

Amazon EKS

For more information on monitoring the Amazon EKS cluster, see CloudWatch logging.

Amazon Aurora

For more information on monitoring the Amazon Aurora cluster, see Amazon CloudWatch metrics for Amazon Aurora.