1. Deploying Siebel CRM Containers on Kubernetes using Siebel Cloud Manager
  2. Removing a Siebel CRM Deployment on OCI

Removing a Siebel CRM Deployment on OCI

Where you need to remove (destroy) an existing deployment and its dependent components, including its associated registry and Git repository, you can do so by using the DELETE API method and specifying the unique environment ID of this deployment. Details for this API follow.

Method: DELETE

URL: <CM_Instance_IP>/scm/api/v1.0/environment/<env_id>

Response

Client Validation Failed(400):
{
        "description": "Invalid Environment"
    }
Success(200):
{
        "delete_job_id": ocid | null,
        "is_cm_project_removed": bool | null,
        "is_delete_request_made": bool | null,
        "is_dir_archived": bool | null,
        "is_helm_project_removed": bool | null,
        "is_ingress_removed": bool | null,
        "is_registry_removed": bool | null,
        "is_bucket_deleted": bool | null
    }

Keys in Response Definition

The following keys are part of the response definition:

  • delete_job_id: The OCI resource manager delete job OCID, which can used to track the status of the deletion job.

  • is_cm_project_removed: Indicates whether the SCM project in the Git instance was removed.

  • is_delete_request_made: Indicates whether the DELETE request was made to OCI.

  • is_dir_archived: Indicates whether the environment was moved to the archive directory.

  • is_helm_project_removed: Indicates whether the Helm Charts project in the Git instance was removed.

  • is_ingress_removed: Indicates whether the Load Balancer was removed.

  • is_registry_removed: Indicates whether the Registry was removed.

  • is_bucket_deleted: Indicates whether the object storage bucket was removed.

Note: A Siebel CRM environment on OCI is created in over a dozen stages. If there were issues in any of these stages, then the environment provision can fail. (See also Troubleshooting a Siebel Cloud Manager Instance or Requested Environment.) For example, resource creation might fail if service limits were undefined in the user account. In the response from using the DELETE method to clean up such a failed environment, keys that have null values instead of Boolean values represent stages that did apply in this case: where the stage was not applicable due to an issue in a prior stage of creation. In the above example, the environment failed in the resource creation, and so no Load Balancer ingress would have been configured. So, in this case, the response contains the null value for the key is_ingress_removed.