Scaling the OpenPages application server pod

You can scale the application server pod.

oc describe sts/openpages-<instance_name>-sts

1. Log in to your Red Hat® OpenShift® cluster as a instance administrator.

   ${CPDM_OC_LOGIN}

2. Back up your OpenPages environment.
   For more information, see Backing up, restoring, and migrating OpenPages.
3. Use one or more of the following options:

   For these commands, use the --tethered_instance_ns parameter if the OpenPages instance is installed in a tethered project.

   --cpd_instance_ns and --tethered_instance_ns are mutually exclusive, so you must specify either the --cpd_instance_ns parameter or --tethered_instance_ns parameter.

   Change the size of the instance

   You can use the scaleConfig parameter to change the size of an instance. Valid values that you can pass in the parameter are the following:

   • xsmall
   • small
   • small_mincpureq
   • medium
   • large

   For example, to change the size to xsmall, replace ${size} with xsmall in the following command:

   cpd-cli manage update-cr --component=openpages_instance \
       --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
       --patch="{\"scaleConfig\":\"small\"}" \
       --extra-vars='{"cr_name":"${INSTANCE_NAME}"}' \
       [--tethered_instance_ns=${PROJECT_CPD_INSTANCE_TETHERED}]
   

   The scaleConfig parameter uses the values in Table 1, unless the customScaleConfig parameter is defined.

   Set the minimum and maximum number of application replicas

   If you're using auto-scaling, you can set the minimum and maximum replicas to use:

   cpd-cli manage update-cr --component=openpages_instance \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} 
    --patch="{\"customScaleConfig\":{\"opapp\":{\"min_replicas\":1,\"max_replicas\":5}}}" \
    --extra-vars='{"cr_name":"${INSTANCE_NAME}"}' \
    [--tethered_instance_ns=${PROJECT_CPD_INSTANCE_TETHERED}]

   Use these parameters when you're using autoScaleConfig: true.

   Set the number of application replicas

   If you're using auto-scaling, the replicas parameter sets the initial number of replicas. The number of replicas in use scales up or down within the min_replicas and max_replicas range.

   If you're not using auto-scaling, the replicas parameter sets a fixed number of replicas to use:

   cpd-cli manage update-cr --component=openpages_instance \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --patch="{\"customScaleConfig\":{\"opapp\":{\"replicas\":2}}}" \
    --extra-vars='{"cr_name":"${INSTANCE_NAME}"}' \
    [--tethered_instance_ns=${PROJECT_CPD_INSTANCE_TETHERED}]

   Change the resources for the application pod

   You can change the resources for limits and requests. Change the cpu and memory parameters to set the resources:

   cpd-cli manage update-cr --component=openpages_instance \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --patch="{\"customScaleConfig\":{\"opapp\":{\"replicas\":2,\"resources\":{\"limits\":{\"cpu\":2,\"memory\":\"8Gi\",\"ephemeral-storage\":\"4Gi\"},\"requests\":{\"cpu\":\"5m\",\"memory\":\"8Gi\",\"ephemeral-storage\":\"4Gi\"}}}}}" \
    --extra-vars='{"cr_name":"${INSTANCE_NAME}"}' \
    [--tethered_instance_ns=${PROJECT_CPD_INSTANCE_TETHERED}]

   On a tethered namespace, you might receive the following error message:

   [ERROR] 2025-03-11T01:20:13.024803Z cmd.Run() failed with exit status 2
   [ERROR] 2025-03-11T01:20:13.024950Z Command exception: The update-cr command failed (exit status 2). You may find output and logs in the /root/cpd_cli_linux/cpd-cli-workspace/olm-utils-workspace/work directory.
   [ERROR] 2025-03-11T01:20:13.026910Z RunPluginCommand:Execution error:  exit status 1

   Apply the following patch as a workaround:

   oc -n ${PROJECT_CPD_INSTANCE_TETHERED} patch OpenPagesInstance ${INSTANCE_NAME}  \
     --type=merge \
     --patch '{
       "spec": {
         "customScaleConfig": {
           "opapp": {
             "replicas": 1,
             "resources": {
               "limits": {
                   "cpu": "4",
                   "ephemeral-storage":"4Gi",
                   "memory": "6Gi"
               },
               "requests": {
                   "cpu": "4",
                   "ephemeral-storage":"4Gi",
                   "memory": "6Gi"
               }
             }
           }
         }
       }
   }'

   For more information, see Setting and enforcing quotas.

   For example, if you're using auto-scaling:

   oc -n ${PROJECT_CPD_INSTANCE_TETHERED} patch OpenPagesInstance ${INSTANCE_NAME}  \
     --type=merge \
     --patch '{
       "spec": {
       "customScaleConfig": {
           "opapp": {
               "min_replicas": 1,
               "max_replicas": 5,
               "resources": {
                   "limits": {
                       "cpu": 4,
                       "memory": "6Gi"
                   },
                   "requests": {
                       "cpu": 4,
                       "memory": "6Gi"
                   }
               }
           }
       }
     }
   }'

   Or if you're not using auto-scaling:

   oc -n ${PROJECT_CPD_INSTANCE_TETHERED} patch OpenPagesInstance ${INSTANCE_NAME}  \ 
     --type=merge \
     --patch '{
       "spec": {
       "customScaleConfig": {
       "opapp": {
         "replicas": 2,
         "resources": {
           "limits": {
             "cpu": 4,
             "memory": "6Gi"
           },
           "requests": {
             "cpu": 4,
             "memory": "6Gi"
           }
         }
       }
     }
    }
   }'