Uninstalling Planning Analytics

A project administrator can uninstall Planning Analytics.

What permissions do you need to complete this task?
The permissions that you need depend on which tasks you must complete:
  • To uninstall Planning Analytics, you must be an administrator of the project where Planning Analytics is installed. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.
  • To uninstall the Planning Analytics operators, you must be an administrator of the project where the Cloud Pak for Data operators are installed. This project is identified by the ${PROJECT_CPD_OPS} environment variable.
When do you need to complete this task?
Complete this task if you want to remove a running instance of Planning Analytics from your environment.

Information you need to complete this task

Review the following information before you uninstall Planning Analytics:

Environment variables
The commands in this task use environment variables so that you can run the commands exactly as written.
  • If you don't have the script that defines the environment variables, see Setting up installation environment variables.
  • To use the environment variables from the script, you must source the environment variables before you run the commands in this task, for example:
    source ./cpd_vars.sh
Installation location
Planning Analytics is installed in the same project (namespace) as the Cloud Pak for Data control plane. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

Procedure

Complete the following tasks to uninstall Planning Analytics:

  1. Deleting service instances
  2. Logging in to the cluster
  3. Uninstalling the service
  4. Uninstalling the operator

Deleting service instances

Before you uninstall Planning Analytics, you must delete any service instances that are associated with Planning Analytics. This ensures that each instance releases the resources that it reserved.

Who needs to complete this task?
A user with the Manage service instances permission must complete this task.
When do you need to complete this task?
Complete this task before you uninstall Planning Analytics.

From the Cloud Pak for Data web client:

  1. Log in to the web client as a user with sufficient permissions to complete the task.
  2. From the menu, select Services > Instances.
  3. Filter the list to show the pa type.
  4. Delete each pa instance in the list.

Logging in to the cluster

To run cpd-cli manage commands, you must log in to the cluster.

To log in to the cluster:

  1. Run the cpd-cli manage login-to-ocp command to log in to the cluster as a user with sufficient permissions to complete this task. For example:
    cpd-cli manage login-to-ocp \
--username=${OCP_USERNAME} \
--password=${OCP_PASSWORD} \
--server=${OCP_URL}
    Tip: The login-to-ocp command takes the same input as the oc login command. Run oc login --help for details.

Uninstalling the service

Who needs to complete this task?
You must be an administrator of the project where Planning Analytics is installed.
When do you need to complete this task?
Complete this task if you want to remove Planning Analytics from your deployment.

If you installed Planning Analytics in multiple projects, you must complete this task for each instance of Planning Analytics that you want to uninstall.

To uninstall the service:

  1. Delete the custom resource for Planning Analytics.
    cpd-cli manage delete-cr \
--components=planning_analytics \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE}

Uninstalling the operator

Who needs to complete this task?
You must be an administrator with the appropriate permissions to manage OLM objects.
When do you need to complete this task?
Complete this task only if you want to completely remove the Planning Analytics software from the cluster.

To uninstall the operator and other OLM objects:

  1. Delete the OLM objects for Planning Analytics:
    cpd-cli manage delete-olm-artifacts \
--cpd_operator_ns=${PROJECT_CPD_OPS} \
--components=planning_analytics
    • If the command succeeds, it returns [SUCCESS]... The delete-olm-artifacts command ran successfully.
    • If the command fails, it returns [ERROR] and includes information about the cause of the failure.