Maintaining Solution Designer Environment

7 Maintaining Solution Designer Environment

This chapter describes the tasks you perform to maintain the Solution Designer environment.

Running Operational Procedures

This section describes the tasks you perform for a planned upgrade to the Solution Designer cloud native environment. You must consider if the change in the environment fundamentally affects the processing to the extent that Solution Designer should not run when the upgrade is applied or Solution Designer can run during the upgrade but must be restarted to properly process the change.

The operational procedures are performed using the Solution Designer cloud native specification files and scripts.

The operational procedures you perform for upgrading your cloud environment are:

Scaling down the instance
Scaling up the instance
Restarting the instance

Rolling Restart

Occasionally, you may need to restart microservices in a rolling fashion, one at a time. This does not result in downtime, but only reduced capacity for a limited period. A rolling restart can be triggered by invoking the restart-instance.sh script. This script can restart the whole instance in a rolling fashion, or only the admin server or all the managed servers in a rolling fashion. Some operations may automatically trigger rolling restart. These include changes such as image updates, parameter changes, and so on pushed via the upgrade-instance.sh script.

Scaling Down the instance

The scaling down is bringing down to 0 microservices. This does not include any of the third party services running in the cluster like Opensearch, Kafka, and Relying party.

Scale down using the following command:

$OCSCD_CNTK/scripts/scale-down.sh -m full

Scaling Up the instance

Scaling up is up to the initial replica count. A generalized scaling can change the number of replicas up to a value between 0 and 1.

To scale up the instance, run the update instance script:

$OCSCD_CNTK/scripts/update-instance.sh -i ocscd -s $SPEC_PATH

Restarting the Instance

The Solution Designer cloud native toolkit provides a script (restart-instance.sh) that you can use to perform different flavors of restarts on a running instance of Solution Designer cloud native.

Following is the usage of the restart-instance.sh script

restart-instance.sh parameters
      -i instanceName : mandatory
      -r restartType : mandatory; what kind of restart is requested
    # restartType can take the following values:
      * full        - Restart the whole instance (rolling restart)
      * lpapi       - Restart all the Landing Page API Servers (rolling restart)
      * im          - Restart all the Initiative Manager Servers (rolling restart)
      * wm          - Restart all the Workspace Manager Servers (rolling restart)
      * ocscdui     - Restart all the OCSCD UI Servers (rolling restart)
      * up          - Restart all the UIM Participant Servers (rolling restart)
      * router      - Restart all the ocscd-router Servers (rolling restart)

    # or just -h for help

For example, to restart a complete instance, run the following command:

$OCSCD_CNTK/scripts/restart-instance.sh -i ocscd -r full

Rotating Secrets

Rotating secrets and passwords is an important part of securing your instance. To perform credential update, run the following:

Update the password or secret in the system that is being updated For example, OIDC secret in your IDP.
Run the following command to update the secret into SCD.
```
$OCSCD_CNTK/scripts/manage-instance-credentials.sh -i ocscd update <secrets> 
```
Choose one or more of the following as needed:
- ocscd-oidc: OIDC client ID and secret
- s3: access key and secret
- db-schema: Database schema passwords
- db: Administrator user password
Restart Solution Designer for the microservices to uptake the new secrets. See "Restarting the Instance" on how to restart the instances.