Solution Designer cloud native relies on access to certain environment variables to run seamlessly. Ensure that the path to your private specification repository variable is set in your environment:

To set the environment variables:

You must store sensitive data and credential information in the form of Kubernetes Secrets that the scripts and Helm charts in the toolkit consume. Managing secrets is out of the scope of the toolkit and must be implemented while adhering to your organization's corporate policies.

As a prerequisite to using the toolkit for installing the Solution Designer database or creating an instance, you must create secrets for access to the following:

• Solution Designer database
• Kafka
• Authentication
• Object Store

The toolkit provides sample scripts for this purpose. However, they are not pipeline-friendly. The scripts should be used for creating an instance manually and quickly, but not for any automated process for creating instances. The scripts also illustrate both the naming of the secret and the layout of the data within the secret that Solution Designer cloud native requires. You must create secrets prior to running the install-db.sh or create-instance.sh scripts.

The following is an example of running the script to create the secrets that you need:

$OCSCD_CNTK/scripts/manage-instance-credentials.sh -i ocscd create db,db-schema,kafka,ocscd-oidc,s3

Where

• db specifies the database connectivity details and the administrator credentials for connecting to the Solution Designer database. This is consumed by the Solution Designer database installer and Oracle Communications Service Catalog and Design- Solution Designer.
• db-schema specifies the schema credentials that the Solution Designer services use to persist data.
• kafka specifies the connectivity details and the credentials for connecting to Kafka provider.
• ocscd-oidc specifies OpenID Connect (OIDC) connectivity and credentials for connecting to the OIDC provider for Service Catalog and Design - Solution Designer.
• s3 specifies the connectivity details and the credentials for connecting to an S3 Object Store provider.

To assemble the specifications:

Copy the instance specification to your $SPEC_PATH and rename:

cp $OCSCD_CNTK/samples/instance.yaml $SPEC_PATH/ocscd.yaml

Edit the instance specification to set the container image location and tag in each microservice location. The following is an instance of a few entries:

initiative-manager: {}
#  env:
#    elasticsearch:
#      host: opensearch-cluster-master
#  replicaCount: 1
#  image:
#    repository: ocscd/initiative-manager
#    tag: latest
#    pullSecrets: []
#  db: 
#    type: "STANDARD" # Acceptable values are STANDARD and ADB
workspace-manager: {}
#  replicaCount: 1
#  image:
#    repository: ocscd/workspace-manager
#    tag: latest
#    pullSecrets: []
#  db: 
#    type: "STANDARD" # Acceptable values are STANDARD and ADB
landing-page-api: {}
#  replicaCount: 1
#  image:
#    repository: ocscd/landing-page-api
#    tag: latest
#    pullSecrets: []
#  db: 
#    type: "STANDARD" # Acceptable values are STANDARD and ADB

If your environment requires a password to download the container images from your repository, create a Kubernetes secret with the image pull credentials. See the Kubernetes documentation for details. Reference the secret name in the instance specification.

# uncomment and set if required
#  image:
#    pullSecrets: []
#      - name: my-regcred

#  db: 
#   type: "STANDARD" # Acceptable values are STANDARD and ADB

#  db:
    #  type: "STANDARD"
    #  defaultTablespace: "USERS"
    #  tempTablespace: "TEMP"

This procedure configures an empty PDB or ADB. Depending on the database strategy for your team, you may have already performed this procedure as described in "Provisioning Oracle Multitenant Container Database (CDB)". Before continuing, ensure that the PDB or ADB being used for creating the Solution Designer instance includes the schema installation. If the database already has the schema installed, skip this procedure.

After the PDB or ADB is created, it is configured with the Solution Designer schema.

$OCSCD_CNTK/scripts/install-db.sh -i ocscd -s $SPEC_PATH -c 4

This procedure describes how to create a Solution Designer instance in your environment using the scripts that are provided with the toolkit.

To create a Solution Designer instance:

1. Run the following command:

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

   The create-instance.sh script creates and deploys the microservices that are specified in the instance specification file. If the scripts fails, see "Troubleshooting Issues with the Scripts", before you make additional attempts.

2. If you query the status of the pods, the READY state of the microservices may display 0/1 for several minutes while the Solution Designer application is starting.

   When the READY state shows 1/1, your Solution Designer instance is up and running. You can then validate the instance by running the Oracle Communications Service Catalog and Design - Solution Designer application and creating a sample PSR model.

After creating an instance, you can validate it by checking the domain configuration and the client UIs.

kubectl get deployment -n ocscd

The command displays the domain configuration information.

http://hostname:port/apps/scd/

You can create multiple instances of the microservices components of Solution Designer by setting the replicaCount accordingly in the MANIFEST.yaml file while creating the Solution Designer instance and during the upgrade. By default, the replicaCount is set to 1. You cannot modify the replicaCount for UIM-Participant component which is set to 1, by default.

To scale the Solution Designer instances, edit the MANIFEST.YAML file.

initiative-manager:  
        replicaCount: 1

workspace-manager:   
        replicaCount: 1

landing-page-api:   
        replicaCount: 1

The following guidelines are for the high availability of the third party deployments such as OpenSearch, Kafka. These guidelines can be altered depending on the desired resiliency.

Deleting Your Solution Designer Instance

$OCSCD_CNTK/scripts/delete-instance.sh -i ocscd

Recreating Your Solution Designer Instance

When you delete a Solution Designer instance, the database state for that instance still remains unaffected. You can re-create the Solution Designer instance by using the same container image.

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

This section provides information about troubleshooting some issues that you may come across when running the scripts.