2 Planning and Validating Your Cloud Native Instance

In preparation for Oracle Communications Design Studio PSR Designer cloud native deployment, you must set up and validate prerequisite software.

Required Software Components for PSR Designer

To install PSR Designer, you need to set up the following in your cloud native environment:

  • Kubernetes cluster

  • Oracle database (PDB)

  • Helm

  • Persistent volumes

  • Secrets management

Prerequisite Software

This section lists the prerequisite software and the corresponding minimum versions required to deploy PSR Designer.

Software Minimum version required

Docker

19.03.11

Kubernetes

1.23.7

Helm

3.3.1

Oracle Database (PDB)

19.3.0-ee

Along with the above software, you must have the following:

  • Oracle Database PDB (version 19.3 or later) up and running with a default users tablespace and default temporary tablespace as temp.

  • Kubernetes cluster environment set up with at least three worker nodes for high-availability of services or at least one worker node for non-high availability.

PSR Designer Deployment Package

The Oracle Communications Design Studio PSR Designer service packages on the Oracle software delivery website include ready-to-use images and Helm charts to help you orchestrate containers in Kubernetes. The Oracle Communications Design Studio PSR Designer Samples package contains sample blueprint files and scripts that are useful for installation.

The package for each service is an archive file containing image and artifact folders. These folders contain a Docker image and an archive with corresponding Helm scripts, useful for the deployment of services to a Docker repository in a Kubernetes environment. PSR Designer samples are distributed as a separate archive file.

Download the Docker images and artifact archives for each PSR Designer service along with samples to your Linux environment and unarchive the contents to a folder structure.

This diagram shows an example of the folder structure after extracting the archives:



About Images and Containers

PSR Designer has a multi-service architecture with each service provided as a Docker image for deploying as a run-time container in a Kubernetes cluster on cloud infrastructure. A Docker image consists of read-only layers, each of which represents a Dockerfile instruction. The layers are stacked and each one is a delta of the changes from the previous layer. PSR Designer cloud native deployment images are built by stacking multiple layers, extending an operating system image with a dependent library image, and then with an image packing the application.

About Container Image Management

Oracle recommends that you create a private container repository and ensure that all nodes have access to that repository. You should save images in this repository so that all nodes have access to the repository. This may require networking changes such as routes and proxy, and authentication for logging in to the repository. Oracle recommends that you choose a repository that provides centralized storage and management for both container images and other artifacts such as PSR Designer Helm charts, blueprints, and sample scripts.

Failing to ensure that all nodes have access to a centralized repository will mean that images have to be synced to the hosts manually or through custom mechanisms (for example, using scripts), which are error-prone operations as worker nodes are commissioned, decommissioned or even rebooted. When an image on a particular worker node is not available, then the pods using that image are either not scheduled to that node, wasting resources, or fail on that node. If image names and tags are kept constant (such as myapp:latest), the pod may pick up a pre-existing image of the same name and tag, leading to unexpected and difficult to debug behaviors.

Loading PSR Designer Images

Images shipped with the PSR Designer services on Oracle software delivery website are in the form of TGZ files. After downloading the TGZ files, load them as images into the Docker repository.

The PSR Designer Samples package provides a sample script UploadImages.sh to upload the images to your own Docker repository with the corresponding configuration of parameters.

To load PSR Designer images:

  1. Download the images that are in the form of TGZ files.

  2. Log in to your Docker repository.

  3. Set the environment variable DOCKER_REPO with the Docker repository.

  4. Navigate to the scripts folder under Samples folder that you downloaded along with the images.

  5. Run the sample script from the UploadImages.sh file.

  6. Run the following command:

    ./UploadImages.sh <RELEASE> <DESTDIR>

    Where <RELEASE> is the PSR Designer release version, and <DESTDIR> is the destination folder where all the downloaded services are unarchived. The script uploads all the images one-by-one into the Docker repository.

    Note:

    You must save all the PSR Designer service folders under a single root folder on your system to run the UploadImages command as it fetches all of the images from the folder.