Modifying QRadar Suite Software deployment resource specifications

QRadar® Suite Software provides a method to modify the deployment resource specifications by using the modify_deployment tool.

Procedure

  1. Ensure that you have the serviceability pod running by typing the following command.
    oc get pod -lrun=cp-serviceability -n <cp4s_namespace>
  2. Exec into the serviceability pod by typing the following command.
    oc exec -ti deploy/cp-serviceability -- bash
  3. Run the modify_deployment tool by typing the following command.
    /opt/bin/modify_deployment <arguments>
    The following table shows the arguments that are available.
    Table 1. modify_deployment arguments
    Argument Description
    -n Namespace. The default namespace is cp4s.
    --replicas The number of replicas.
    -k The kind of middleware.
    -a The application to update.
    -c The container to update. The default is main.
    -p The middleware parameter name and value. Separate the name and value with a colon (:).
    -r The resource specification. Separate multiple resource specifications with a colon (:).
    -d Delete the entry for an application or a container.
    --force Ignore application or container checks.
    The following example command might be used to modify the CPU, memory, and replicas of the entitlements application.
    /opt/bin/modify_deployment -a entitlements --replicas=1 -r requests.cpu:100m -r requests.memory:128Mi -r limits.cpu:500m -r limits.memory:256Mi
    Important: If you are modifying the CPU or memory settings, you must specify all 4 resource requests and limits at the same time. The application CPU or memory requests and limits must have measurement units set. For example, -r requests.cpu:1000m is accepted but -r requests.cpu:1 is not.

    It is suggested to group parameters for the application into single command to avoid multiple redeployments every time parameters are changed.

    To modify application parameters, you can use the -p parameter. For example, you can increase postgres storage to 2048Gi by typing the following command.

    /opt/bin/modify_deployment -k postgres -a default -p storageSize:2048Gi

    To change the configuration back to its original configuration, you can use the -d parameter.

    /opt/bin/modify_deployment -a entitlements -d

    Any modification that is made by using the tool is stored in a custom configmap called cp4s-values in the QRadar Suite Software namespace. This configmap overrides default configuration and must not be deleted. If the configmap is deleted, QRadar Suite Software returns back to its original configuration.