IBM Cloud Automation Manager

https://www.ibm.com/docs/en/cam
Admin
IBM Cloud Automation Manager is an enterprise automation platform for managing cloud infrastructure,...
Tokens:584,792
Snippets:3,087
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### SSH Key Format Example

Source: https://www.ibm.com/docs/en/cam/4.1_topic=instances-deploying-template

Illustrates the correct format for an SSH key when configuring a cloud connection for template deployment. Ensures the key starts with 'ssh-rsa' and the encrypted string has no spaces.

```text
ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAkZ5wvjWedYOYnkx2Mp2lnXgTxLKnvSYkvfb36P6JQFPhLY0cmgqY9Vi7XP/LsOFeLk6+7qSsInIILQ5iZ8 /uKsNxAOo2gZdyh5FKzaMDTsBbZggwqayjplADQ1C+QbHbprJLKSFRx98+ROb19u+CUIFL0FSmO03m1ZzZB3cYrEIiXql0vJp3DeSUSq/xCQ76qrXT7qzMUTfJdi3hPjtfTh1UIzC5buyR7jhe8FocDf5dn3KRCMzIUUrvd3zvyYHmcer0InmtK3e2OTvu8V4Xw2Mx4BrbpjBcDAmBShaHOhKq7IqT8qPWek46UxY9vUmnBbB9hP5jOn+ip3HSBJc3BQ==
```

--------------------------------

### SSH Key Format Example

Source: https://www.ibm.com/docs/en/cam/4.2_topic=instances-deploying-template

Illustrates the correct format for an SSH public key when configuring a cloud connection for template deployment. The key must start with 'ssh-rsa' and the encrypted string should not contain spaces.

```text
ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAkZ5wvjWedYOYnkx2Mp2lnXgTxLKnvSYkvfb36P6JQFPhLY0cmgqY9Vi7XP/LsOFeLk6+7qSsInIILQ5iZ8 /uKsNxAOo2gZdyh5FKzaMDTsBbZggwqayjplADQ1C+QbHbprJLKSFRx98+ROb19u+CUIFL0FSmO03m1ZzZB3cYrEIiXql0vJp3DeSUSq/xCQ76qrXT7qzMUTfJdi3hPjtfTh1UIzC5buyR7jhe8FocDf5dn3KRCMzIUUrvd3zvyYHmcer0InmtK3e2OTvu8V4Xw2Mx4BrbpjBcDAmBShaHOhKq7IqT8qPWek46UxY9vUmnBbB9hP5jOn+ip3HSBJc3BQ==

```

--------------------------------

### MariaDB Database Verification and Setup for Template Designer

Source: https://www.ibm.com/docs/en/cam/4.2_topic=support-troubleshooting-issues-in-installation

Provides a series of kubectl and mysql commands to verify, troubleshoot, and manually set up the `ibm_ucdp` database and `ucdpadmin` user for Cloud Automation Manager's Template Designer. This is useful when the MariaDB pod fails to initialize the necessary database components.

```shell
# Get into the MariaDB pod
kubectl exec -it -n services cam-bpd-mariadb-abc123 -- bash

# Get the MariaDB root password
env | grep MYSQL_ROOT_PASSWORD

# Run the mysql command line tool
mysql -u root -p <password_found_above>
# for example: mysql -u root -pabc123
# you might only need mysql without any credentials

# Show the databases
show databases;

# Verify database ibm_ucdp exists. If it does, then
use ibm_ucdp;
show tables;

# Verify there are many tables (should show around 61)

# Verify the user "ucdpadmin" exists
SELECT User,Host FROM mysql.user;
```

```sql
drop database ibm_ucdp;
```

```sql
# In the mysql command line, manually create the database, user, and grant access
CREATE DATABASE ibm_ucdp;
CREATE USER 'ucdpadmin'@'%' IDENTIFIED BY '<password_found_above>';
GRANT ALL ON ibm_ucdp.* TO 'ucdpadmin'@'%' ;
FLUSH PRIVILEGES;
```

--------------------------------

### Terraform main.tf Example for ICAM Agent Installation

Source: https://www.ibm.com/docs/en/cam/4.2_topic=templates-defining-structure-cloud-automation-manager-template

Example of a Terraform `main.tf` file used in Cloud Automation Manager for installing an ICAM agent on a Linux host. It demonstrates the use of modules and variable interpolation for configuring the deployment.

```terraform
 module "icam_agent_install_linux" {
 source = "./modules/icam_agent_install"
 ip_address = "${var.ip_address}"
 user = "${var.user}"
 password = "${var.password}"
 private_key = "${var.private_key}"
 icam_agent_location = "${var.icam_agent_location}"
 icam_agent_location_credentials = "${var.icam_agent_location_credentials}"
 icam_agent_source_subdir = "${var.icam_agent_source_subdir}"
 icam_agent_installation_dir = "${var.icam_agent_installation_dir}"
 icam_agent_name = "${var.icam_agent_name}"
 #######
 bastion_host        = "${var.bastion_host}"
 bastion_user        = "${var.bastion_user}"
 bastion_private_key = "${var.bastion_private_key}"
 bastion_port        = "${var.bastion_port}"
 bastion_password    = "${var.bastion_password}"
 #######
 }


```

--------------------------------

### Create File System on Logical Volume

Source: https://www.ibm.com/docs/en/cam/4.1_topic=infrastructure-deploying-gdpr-enabled-content-runtime

This command creates a file system on the opened logical volume. The example uses XFS, but other file systems like ext4 can also be used. This prepares the volume for data storage.

```bash
mkfs.xfs /dev/mapper/<name of the logical volume>
```

--------------------------------

### GET /cam/api/v1/iaasresources/{CAM_RESOURCE_ID}/tasks/{CAM_IAASTASK_ID} - Get the status of a virtual machine task

Source: https://www.ibm.com/docs/en/cam/4.1_topic=manager-resource-specific-apis

Retrieves the current status of a virtual machine task, such as starting or stopping.

```APIDOC
## GET /cam/api/v1/iaasresources/{CAM_RESOURCE_ID}/tasks/{CAM_IAASTASK_ID} - Get the status of a virtual machine task

### Description
Retrieves the current status of a virtual machine task, such as starting or stopping.

### Method
GET

### Endpoint
`https://${CAM_HOST}:${CAM_PORT}/cam/api/v1/iaasresources/${CAM_RESOURCE_ID}/tasks/${CAM_IAASTASK_ID}`

### Parameters
#### Path Parameters
- **CAM_RESOURCE_ID** (string) - Required - The ID of the virtual machine resource.
- **CAM_IAASTASK_ID** (string) - Required - The ID of the iaas task.

#### Query Parameters
- **tenantId** (string) - Required - The tenant ID.
- **ace_orgGuid** (string) - Required - The organization GUID.
- **cloudOE_spaceGuid** (string) - Optional - The space GUID. If omitted, results for all spaces will be displayed.

### Response
#### Success Response (200)
- **cloud_resource_id** (string) - The ID of the cloud resource.
- **task_name** (string) - The name of the task (e.g., "stop").
- **status** (string) - The final status of the task (e.g., "SUCCESS", "FAILED").
- **created** (string) - The timestamp when the task was created.
- **updated** (string) - The timestamp when the task was last updated.
- **stack_id** (string) - The ID of the stack.
- **resource_id** (string) - The ID of the resource.
- **resource_name** (string) - The name of the resource.
- **message** (string) - Any additional message related to the task status.
- **id** (string) - The unique identifier for the task.

#### Response Example
```json
{
  "cloud_resource_id": "421ac557-7793-fdd5-7b83-c3525571abfe",
  "task_name": "stop",
  "status": "SUCCESS",
  "created": "2017-11-13T16:47:58.298Z",
  "updated": "2017-11-13T16:48:03.728Z",
  "stack_id": "7d55d130-c239-11e7-b95f-c5cc4d245984",
  "resource_id": "59ff272d4ba47e0020cb6583",
  "resource_name": "vsphere_virtual_machine.vm_1",
  "message": "",
  "id": "5a09ccbe9fe5890020316467"
}
```
```

--------------------------------

### Clone IBM-CAMHub-Open GitHub Repository

Source: https://www.ibm.com/docs/en/cam/4.1_topic=infrastructure-offline-content-runtime-deployment

Clones the IBM-CAMHub-Open GitHub repository, which contains helper scripts for downloading Content Runtime prerequisites. This is the first step in preparing to download the necessary software.

```bash
git clone https://github.com/IBM-CAMHub-Open/IBM-CAMHub-Open.git

```

--------------------------------

### Cloud Automation Manager Helm Configuration Example

Source: https://www.ibm.com/docs/en/cam/4.2_topic=manager-installing-cloud-automation-offline-openshift-cloud

An example YAML file demonstrating how to configure persistent volume (PV) settings for MongoDB, logs, and Terraform within Cloud Automation Manager. This file can be used to override default helm installation parameters.

```yaml
camMongoPV:
    name: "cam-mongo-pv"
    persistence:
         enabled: true
         useDynamicProvisioning: true
         existingClaimName: ""
         storageClassName: "ibmc-block-gold"
         accessMode: ReadWriteOnce
         size: 15Gi

     camLogsPV:
         name: "cam-logs-pv"
         persistence:
         enabled: true
         useDynamicProvisioning: true
     existingClaimName: ""
         storageClassName: "ibmc-file-gold"
         accessMode: ReadWriteMany
         size: 10Gi

    camTerraformPV:
       name: "cam-terraform-pv"
       persistence:
         enabled: true
         useDynamicProvisioning: true
    existingClaimName: ""
         storageClassName: "ibmc-file-gold"
         accessMode: ReadWriteMany
         size: 15Gi

```

--------------------------------

### Datatype Instance Examples

Source: https://www.ibm.com/docs/en/cam/4.1_topic=service-managing-code-structure

Provides examples of datatype instances, demonstrating how to set default values and immutability for configurations like Bastion Host and HTTP Proxy.

```json
"datatypes" : [
        {
           "id" : "bastionhost1",
           "label": "Bastion Host Configuration",
           "description": "Select Bastion Host Configuration",
           "datatype": "bastionhost",
           "default": "DefaultNoBastionHostRequired",
           "immutable": false
        },
        {
          "id" : "httpproxy",
          "label": "Bastion Host Configuration",
          "description": "Select HTTP Proxy Configuration",
          "datatype": "httpproxy",
          "default": "DefaultNoProxyRequired",
          "immutable": true
        },
    ],
```

--------------------------------

### Sample NFS /etc/exports settings

Source: https://www.ibm.com/docs/en/cam/4.2_topic=installation-creating-cloud-automation-manager-persistent-volumes

This snippet provides sample configurations for the NFS `/etc/exports` file, illustrating settings for NFSv2, NFSv3, and NFSv4. These examples help in setting up shared file systems for NFS clients.

```bash
# /etc/exports: the access control list for filesystems which may be exported
#               to NFS clients.  See exports(5).
#
# Example for NFSv2 and NFSv3:
# /srv/homes       hostname1(rw,sync,no_subtree_check) hostname2(ro,sync,no_subtree_check)
#
# Example for NFSv4:
# /srv/nfs4        gss/krb5i(rw,sync,fsid=0,crossmnt,no_subtree_check)
# /srv/nfs4/homes  gss/krb5i(rw,sync,no_subtree_check)
```

--------------------------------

### Copy WebSphere Liberty Core Binaries

Source: https://www.ibm.com/docs/en/cam/4.1_topic=repository-using-installation-manager-live-repositories

Copies the WebSphere Liberty Core installation binaries from the IBM live repository to a local target directory. This command requires the offering ID, repository URL, and target path. It also includes options to prompt for user input, show progress, and accept the license.

```bash
./PUCL copy com.ibm.websphere.liberty.CORE -repositories http://www.ibm.com/software/repositorymanager/com.ibm.websphere.liberty.CORE -target /opt/ibm/docker/software-repo/var/swRepo/private/IMRepo/Liberty   -prompt -showProgress -acceptLicense

```

--------------------------------

### GET /cam/api/v1/stacks

Source: https://www.ibm.com/docs/en/cam/4.2_topic=manager-template-template-instance-apis

Retrieves a list of all deployed templates within the Cloud Automation Manager. It supports filtering by tenant ID and organization GUID, with an optional space GUID.

```APIDOC
## Retrieve the list of deployed templates

### Description
Retrieves a list of all deployed templates. This endpoint allows you to query for templates based on tenant ID and organization GUID, with an optional space GUID for more granular filtering. The `cloudOE_spaceGuid` parameter is optional; if omitted, it returns all template instances for the specified `ICP_NAMESPACE`.

### Method
GET

### Endpoint
/cam/api/v1/stacks

### Parameters
#### Query Parameters
- **tenantId** (string) - Required - The ID of the tenant.
- **ace_orgGuid** (string) - Required - The GUID of the organization.
- **cloudOE_spaceGuid** (string) - Optional - The GUID of the space. If not provided, all instances within the `ICP_NAMESPACE` are returned.

### Request Example
```bash
curl -k -X GET -H "Authorization: Bearer ${CAM_BEARER_TOKEN}" "https://${CAM_HOST}:${CAM_PORT}/cam/api/v1/stacks?tenantId=${CAM_TENANT_ID}&ace_orgGuid=${ICP_TEAM}&cloudOE_spaceGuid=${ICP_NAMESPACE}"
```

### Response
#### Success Response (200)
- **array** - An array of deployed template objects, each containing details like name, creation date, template ID, and status.
```

--------------------------------

### Specifying Chef Client Installation Path

Source: https://www.ibm.com/docs/en/cam/4.2_topic=infrastructure-offline-content-runtime-deployment

This example shows the required format for the 'Chef Client Installation Binaries Path' when deploying an offline content runtime. The path should point to the local directory containing the binaries without a trailing slash.

```text
/tmp/chef-clients
```

--------------------------------

### POST /v1/upload/chef Request Example (Chef Supermarket)

Source: https://www.ibm.com/docs/en/cam/4.2_topic=apis-upload-cookbooks-roles

This example demonstrates importing the 'java' cookbook from the Chef Supermarket, including its dependencies. It shows how to specify the cookbook name, version, and a list of dependencies, with an option to overwrite existing cookbooks.

```http
POST /v1/upload/chef\n\nHeader: Authorization = Bearer $ACCESS_TOKEN\n\n{\n  "cookbook_name": "java",\n  "cookbook_version": "1.50.0",\n  "source_repos": "chef_supermarket",\n  "deps": [\n    {\n      "cookbook_name": "apt",\n      "cookbook_version": "6.1.4"\n    },\n    {\n      "cookbook_name": "homebrew",\n      "overwrite_existing": "true"\n    },\n    {\n      "cookbook_name": "windows"\n    },\n    {\n      "cookbook_name": "ohai"\n    }\n  ]\n}\n
```

--------------------------------

### Validation Rule Example (Regex)

Source: https://www.ibm.com/docs/en/cam/4.1_topic=tab-creating-new-input-output-parameters

Provides an example of a regular expression (regex) used for validating string or password input parameters in Cloud Automation Manager. This rule restricts input values to match the specified pattern during service deployment.

```regex
(\w+?@\w+?\x2E.+)
```

--------------------------------

### Create File System on Logical Volume

Source: https://www.ibm.com/docs/en/cam/4.2_topic=infrastructure-deploying-gdpr-enabled-content-runtime

Creates a file system on the opened LUKS container, preparing it for mounting. The example uses the XFS file system, but other file systems can be used. It requires the path to the mapped logical volume, typically found in `/dev/mapper/`, as input.

```bash
mkfs.xfs /dev/mapper/<name of the logical volume>

# Example:
mkfs.xfs /dev/mapper/pmlv
```

--------------------------------

### Get Tenant Information (curl)

Source: https://www.ibm.com/docs/en/cam/4.2_topic=apis-example-retrieve-list-deployed-templates

This curl command retrieves tenant information from the CAM API using the previously obtained bearer token. It sends a GET request to the specified endpoint. Ensure ${CAM_HOST} and the bearer token are correctly set.

```shell
curl -k -X GET -H "Authorization: Bearer ${CAM_BEARER_TOKEN}" https://${CAM_HOST}:30000/cam/tenant/api/v1/tenants/getTenantOnPrem

```

```shell
curl -k -X GET -H "Authorization: Bearer gvWTQGcb9DzZZb5Oj6GYRJm0OOUBYTCxgjJUlI0dDURsw6p2uWdG3jDCe8S8UCqLVSoU3wwr9toWKGtISkcMrttBBGzET8hDHbLd3DXUlPMt1jNZAX65aRLvEhLHouVc1HlWQVavVYT9RBeHfNcTkCbYsaToh8rWmzwxAQsN5vRESk727VeTapSfHs
    tx0CL2oUNanHuu73hukWQI3MEsN2X9q1gnGIyUdeSdHQZYJ1Gll8h0GV9vNzA48dgoEPSPtbGK3vRt3p2gK4lzzzwjjPiRX8LAqPXYxjc3GN4RENkhF2XhHLsZJqWAni9ViRhjQiRTOZjpTLu8xdYg4HPwxqywBviIhUVPyqDe2CaHqjl2JVzeVoodByY7rsSEXiZviwjrvD6vcoQ7nLLkQ4JrpdxZP7Zm1
    SKluNQ0I7ZolGz1gk81Y1F8OKISZZSEyp7PZnHKI6RwNiFtWc54xvAh8tlQ15NHlF3ZsyTOa2lIKFJeO1SW8ejMLQaUxfS5uVIgHnOetY4auLU7X82IaR9r6n2BB9ftUWq7ZKf2uG1pC1MwW5ployNvu1sCrgh7bvsthwGRlOdRp04zE94rmidihnCGCUlcf6hWxKNq8cqVsLmk5IJKfpbLVxu2OYFWEMd0b
    qL1YzaDpdgtDD5iH0BNw83d2omjisukkfINNA0T0Z7vpuxuXZ13NBC7fsK1FvN1WWDDs7oHcZ8SPYsITu4cbdjuVayilE1QCAxTzyDVz70DQa84qv1sqczn5jPGVh5cyBVikTEPd6BEQuBhV7Tbq2WVhuS3IuAHWUqfQb085Xb14SqQOXRtatlcRZb11npg44WLXTqH4HliglpyQpbAJTWGCV5AgDWc8fGjjUIz6nWo5O70OmrcvNOhVKzshXv49PqaONdLQpQ13LnUrRCsD9L3IpdJfxojR6eCSG4qQW1JVJC8uSQtjKYkqvdlmAPrxUgMv8yrPfIEOH1tV6h45SricSYKoOfBG72DqIXH" https://<IP address>:<port>/cam/tenant/api/v1/tenants/getTenantOnPrem

```

--------------------------------

### Get the status of a virtual machine task

Source: https://www.ibm.com/docs/en/cam/4.2_topic=manager-resource-specific-apis

Retrieves the current status of a virtual machine task, such as starting or stopping.

```APIDOC
## GET /cam/api/v1/iaasresources/{CAM_RESOURCE_ID}/tasks/{CAM_IAASTASK_ID}

### Description
Gets the status of a virtual machine task (e.g., starting or stopping).

### Method
GET

### Endpoint
`https://${CAM_HOST}:${CAM_PORT}/cam/api/v1/iaasresources/${CAM_RESOURCE_ID}/tasks/${CAM_IAASTASK_ID}?tenantId=${CAM_TENANT_ID}&ace_orgGuid=${ICP_TEAM}&cloudOE_spaceGuid=${ICP_NAMESPACE}`

### Parameters
#### Path Parameters
- **CAM_RESOURCE_ID** (string) - Required - The ID of the virtual machine resource.
- **CAM_IAASTASK_ID** (string) - Required - The ID of the IaaS task.

#### Query Parameters
- **tenantId** (string) - Required - The tenant ID.
- **ace_orgGuid** (string) - Required - The ACE organization GUID.
- **cloudOE_spaceGuid** (string) - Optional - The CloudOE space GUID.

### Response
#### Success Response (200)
- **cloud_resource_id** (string) - The ID of the cloud resource.
- **task_name** (string) - The name of the task performed.
- **status** (string) - The current status of the task (e.g., 'SUCCESS', 'IN_PROGRESS').
- **created** (string) - The timestamp when the task was created.
- **updated** (string) - The timestamp when the task was last updated.
- **stack_id** (string) - The ID of the stack.
- **resource_id** (string) - The ID of the resource.
- **resource_name** (string) - The name of the resource.
- **message** (string) - Any additional message related to the task status.
- **id** (string) - The unique ID of the task.

#### Response Example
```json
{
  "cloud_resource_id": "421ac557-7793-fdd5-7b83-c3525571abfe",
  "task_name": "stop",
  "status": "SUCCESS",
  "created": "2017-11-13T16:47:58.298Z",
  "updated": "2017-11-13T16:48:03.728Z",
  "stack_id": "7d55d130-c239-11e7-b95f-c5cc4d245984",
  "resource_id": "59ff272d4ba47e0020cb6583",
  "resource_name": "vsphere_virtual_machine.vm_1",
  "message": "",
  "id": "5a09ccbe9fe5890020316467"
}
```
```

--------------------------------

### Deploying a Cloud Automation Manager Template

Source: https://www.ibm.com/docs/en/cam/4.1_topic=cmti-cloud-automation-manager-kubernetes-resource-controller-cloud-automation-manager-templates

Provides instructions and YAML examples for deploying a Cloud Automation Manager template using Kubernetes.

```APIDOC
## POST /websites/ibm_en_cam/deploy

### Description
Deploys a Cloud Automation Manager template by creating a Kubernetes resource of kind `Template`. This resource definition specifies the template to deploy, its parameters, and connection details.

### Method
`kubectl create` (or `kubectl apply` for updates)

### Endpoint
`<yaml file name>` (when using `kubectl create -f <yaml file name>`)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
##### Template Resource Definition (YAML)
- **apiVersion** (string) - Required - Specifies the API version for the template resource.
- **kind** (string) - Required - Must be `Template`.
- **metadata** (object) - Required - Contains metadata for the template resource.
  - **name** (string) - Required - The name of the Cloud Automation Manager deployed instance. Must match the Kubernetes resource name.
  - **namespace** (string) - Required - The Kubernetes and Cloud Automation Manager namespace for the deployment.
- **spec** (object) - Required - Specifies the deployment details.
  - **connection** (string) - Required - The name of the Cloud Automation Manager cloud connection to use.
  - **template** (object) - Required - Details of the Cloud Automation Manager template to deploy.
    - **name** (string) - Required - The name of the Cloud Automation Manager template.
    - **version** (string) - Required - The version of the Cloud Automation Manager template.
    - **parameters** (object) - Optional - Input parameters for the template.
      - **parameters** (object) - Collection of name/value pairs mapping to template input parameters.
      - **sharedParameters** (array) - Optional - List of shared parameter data objects.
        - **name** (string) - Required - Name of the shared parameter.
        - **dataType** (string) - Required - Data type of the shared parameter.
      - **secretParameters** (array) - Optional - List of secret parameter data objects.
        - **name** (string) - Required - Name of the template parameter.
        - **secretKeyRef** (object) - Required - Reference to the Kubernetes secret.
          - **name** (string) - Required - Name of the Kubernetes secret.
          - **key** (string) - Required - Key of the secret data within the secret.

### Request Example
```yaml
apiVersion: cloudautomationmgr.ibm.com/v1alpha1
kind: Template
metadata:
  name: template-ibmcloud-sample
  namespace: "default"
spec:
  connection: "IBMCloud"
  template:
    name: "Virtual Server with SSH key"
    version: "2.3"
    parameters:
      parameters:
        datacenter: "dal09"
        hostname: "lrhibmcloud1"
        domain: "raleigh.ibm.com"
      secretParameters:
        - name: vm_password_lrh
          secretKeyRef:
            name: vm-password-lrh-secret
            key: password
```

### Response
#### Success Response (200)
Kubernetes API confirmation of resource creation or update.

#### Response Example
```json
{
  "apiVersion": "cloudautomationmgr.ibm.com/v1alpha1",
  "kind": "Template",
  "metadata": {
    "creationTimestamp": "2023-10-27T10:00:00Z",
    "name": "template-ibmcloud-sample",
    "namespace": "default"
  },
  "spec": {
    "connection": "IBMCloud",
    "template": {
      "name": "Virtual Server with SSH key",
      "version": "2.3",
      "parameters": {
        "parameters": {
          "datacenter": "dal09",
          "hostname": "lrhibmcloud1",
          "domain": "raleigh.ibm.com"
        },
        "secretParameters": [
          {
            "name": "vm_password_lrh",
            "secretKeyRef": {
              "name": "vm-password-lrh-secret",
              "key": "password"
            }
          }
        ]
      }
    }
  },
  "status": {
    "phase": "Creating"
  }
}
```
```

--------------------------------

### Install IBM Package Utility (Bash)

Source: https://www.ibm.com/docs/en/cam/4.2_topic=repository-using-installation-manager-live-repositories

Installs the IBM Package Utility using the imcl command-line tool. It specifies the repository, installation directory, data location, shared resources directory, and log location, while accepting licenses and showing progress.

```bash
./imcl install com.ibm.cic.packagingUtility_1.8.8000.20171130_1136 -repositories http://www.ibm.com/software/repositorymanager/com.ibm.cic.packagingUtility -installationDirectory /opt/ibm/docker/software-repo/var/swRepo/private/IMProducts/PUCL -dataLocation /opt/ibm/docker/software-repo/var/swRepo/private/IMProducts/datalocation -sharedResourcesDirectory /opt/ibm/docker/software-repo/var/swRepo/private/IMProducts/IMshared -log /opt/ibm/docker/software-repo/var/swRepo/private/IMProducts/IMlogs -prompt -showProgress -acceptLicense
```

--------------------------------

### Patch cam-bpd-mariadb Deployment for CAM Installation

Source: https://www.ibm.com/docs/en/cam/4.1_topic=ts-troubleshooting-issues-in-installation-cloud-automation-manager-multicloud-manager-openshift-cloud

This snippet guides users through modifying the cam-bpd-mariadb deployment using kubectl to add an initContainer. This action addresses permission problems with the MySQL data directory, which is crucial for the correct functioning of Cloud Automation Manager.

```bash
kubectl edit deployment -n services cam-bpd-mariadb
```

```yaml
      imagePullSecrets:
      - name: xxxxxx
      initContainers:
      - args:
        - chown 1000:1000 /var/lib/mysql; 
        command:
        - /bin/sh
        - -c
        image: alpine:latest
        imagePullPolicy: Always
        name: permissionfix
        resources: {}
        securityContext:
          capabilities:
            add:
            - CHOWN
            - FOWNER
            - DAC_OVERRIDE
            drop:
            - ALL
          privileged: false
          readOnlyRootFilesystem: false
          runAsNonRoot: false
          runAsUser: 0
          seLinuxOptions:
            type: spc_t
        terminationMessagePath: /dev/termination-log
        terminationMessagePolicy: File
        volumeMounts:
        - mountPath: /var/lib/mysql
          name: cam-bpd-appdata-pv
          subPath: mysql

```

--------------------------------

### GET /cam/api/v1/managedvirtualmachines/download

Source: https://www.ibm.com/docs/en/cam/4.1_topic=manager-usage-specific-apis

Downloads a report of managed virtual machines. Requires tenant ID and organization GUID.

```APIDOC
## GET /cam/api/v1/managedvirtualmachines/download

### Description
Downloads a report of managed virtual machines.

### Method
GET

### Endpoint
/cam/api/v1/managedvirtualmachines/download

### Parameters
#### Query Parameters
- **tenantId** (string) - Required - The ID of the tenant.
- **ace_orgGuid** (string) - Required - The organization GUID for the ACE.

### Request Example
```bash
curl -k -X GET -H "Authorization: Bearer ${CAM_BEARER_TOKEN}" "https://${CAM_HOST}:${CAM_PORT}/cam/api/v1/managedvirtualmachines/download?tenantId=${CAM_TENANT_ID}&ace_orgGuid=${ICP_TEAM}"
```

### Response
#### Success Response (200)
- **file** (binary) - The report file in CSV format.

#### Response Example
(Binary file content representing the CSV report)
```

--------------------------------

### Copy Java 8 SDK Binaries

Source: https://www.ibm.com/docs/en/cam/4.1_topic=repository-using-installation-manager-live-repositories

Copies the Java 8 SDK installation binaries from the IBM live repository to a local target directory. This command requires the offering ID, repository URL, and target path. It includes options to prompt, show progress, and accept the license.

```bash
./PUCL copy com.ibm.java.jdk.v8 -repositories http://www.ibm.com/software/repositorymanager/com.ibm.java.jdk.v8  -target /opt/ibm/docker/software-repo/var/swRepo/private/IMRepo/jdk8   -prompt  -showProgress -acceptLicense

```

--------------------------------

### Copy WebSphere Liberty Network Deployment Binaries

Source: https://www.ibm.com/docs/en/cam/4.1_topic=repository-using-installation-manager-live-repositories

Copies the WebSphere Liberty Network Deployment installation binaries from the IBM live repository to a local target directory. This command requires the offering ID, repository URL, and target path. It includes options to prompt, show progress, and accept the license.

```bash
./PUCL copy com.ibm.websphere.liberty.ND -repositories http://www.ibm.com/software/repositorymanager/com.ibm.websphere.liberty.ND -target /opt/ibm/docker/software-repo/var/swRepo/private/IMRepo/Liberty -prompt  -showProgress -acceptLicense

```

--------------------------------

### Example Overwritten YAML for Helm Installation

Source: https://www.ibm.com/docs/en/cam/4.1_topic=icamce-installing-cloud-automation-manager-community-edition-openshift-cloud

This YAML file demonstrates how to override default Helm chart values for persistent volume configurations and service replica counts. It specifies storage classes, sizes, and enables dynamic provisioning for various Cloud Automation Manager components.

```yaml
camMongoPV:
  name: "cam-mongo-pv"
  persistence:
    enabled: true
    useDynamicProvisioning: true
    existingClaimName: ""
    storageClassName: "ibmc-block-gold"
    accessMode: ReadWriteOnce
    size: 15Gi

camLogsPV:
  name: "cam-logs-pv"
  persistence:
    enabled: true
    useDynamicProvisioning: true
    existingClaimName: ""
    storageClassName: "ibmc-file-gold"
    accessMode: ReadWriteMany
    size: 10Gi

camTerraformPV:
  name: "cam-terraform-pv"
  persistence:
    enabled: true
    useDynamicProvisioning: true
    existingClaimName: ""
    storageClassName: "ibmc-file-gold"
    accessMode: ReadWriteMany
    size: 15Gi

camBPDAppDataPV:
  name: "cam-bpd-appdata-pv"
  persistence:
    enabled: true
    useDynamicProvisioning: true
    existingClaimName: ""
    storageClassName: "ibmc-file-gold"
    accessMode: ReadWriteMany
    size: 15Gi

 camBpmProvider:
   replicaCount: 1
camAnsibleProvider:
   replicaCount: 1
camIcoProvider:
   replicaCount: 1
camBrokerProvider:
   replicaCount: 1
   storeNamespace: helm-consume-test

```

--------------------------------

### Example of updated calico-config with etcd_endpoints

Source: https://www.ibm.com/docs/en/cam/4.2_topic=service-strongswan-helm-chart-cloud-private

Illustrates the structure of the 'calico-config' configmap after updating it to include 'etcd_endpoints'. This configuration is crucial for Calico networking to connect to etcd.

```yaml
etcd_ca: /calico-secrets/etcd-ca
etcd_cert: /calico-secrets/etcd-cert
etcd_key: /calico-secrets/etcd-key
etcd_endpoints: https://9.9.9.9:4001
```

--------------------------------

### Plan Parameter Example for Cloud Automation Manager

Source: https://www.ibm.com/docs/en/cam/4.1_topic=actions-creating-service

This example demonstrates how to define plan parameters for Cloud Automation Manager, specifically showing the structure for input parameters that can take multiple values. It illustrates the nested array format required for such configurations.

```json
[["value": "VMware"],["value": "PowerVC"]]
```

--------------------------------

### Get Tenant Information

Source: https://www.ibm.com/docs/en/cam/4.2_topic=apis-example-retrieve-list-deployed-templates

Retrieves information about the current tenant, including its ID and namespaces. This is often a prerequisite for other API calls.

```APIDOC
## GET /cam/tenant/api/v1/tenants/getTenantOnPrem

### Description
Retrieves information about the current tenant, including its ID and namespaces.

### Method
GET

### Endpoint
/cam/tenant/api/v1/tenants/getTenantOnPrem

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -k -X GET https://9.37.194.250:30000/cam/tenant/api/v1/tenants/getTenantOnPrem
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the tenant.
- **name** (string) - The name of the tenant.
- **ownerId** (string) - The ID of the tenant owner.
- **wlpClientId** (string) - The client ID for the WebSphere Liberty profile.
- **namespaces** (array) - A list of namespaces associated with the tenant.
  - **name** (string) - The name of the namespace.
  - **uid** (string) - The unique identifier for the namespace.

#### Response Example
```json
{
  "id": "5c0e0a5e-d431-468c-9a11-a3df3978e424",
  "name": "ICP Account",
  "ownerId": "On_Prem",
  "wlpClientId": "a7lLLVER8bTekvyNmJjEdWY6XO7NGb3I",
  "namespaces": [
    {
      "name": "default",
      "uid": "default"
    },
    {
      "name": "kube-public",
      "uid": "kube-public"
    },
    {
      "name": "kube-system",
      "uid": "kube-system"
    },
    {
      "name": "services",
      "uid": "services"
    }
  ]
}
```
```

--------------------------------

### Copy Web Server Plug-ins offering using PUCL

Source: https://www.ibm.com/docs/en/cam/4.2_topic=repository-using-installation-manager-live-repositories

Copies the Web Server Plug-ins offering from an IBM hosted repository to a local target directory using the IBM Package Utility (PUCL). This command facilitates the creation of a unified repository by including necessary web server components, specifying the offering ID, source repository URL, and target directory.

```shell
./PUCL copy com.ibm.websphere.PLG -repositories http://www.ibm.com/software/repositorymanager/com.ibm.websphere.PLG.v85 -target /opt/ibm/docker/software-repo/var/swRepo/private/IMRepo/WAS8 -acceptLicense -prompt
```

--------------------------------

### GET /cam/api/v1/managedvirtualmachines/highwatermark

Source: https://www.ibm.com/docs/en/cam/4.1_topic=manager-usage-specific-apis

Retrieves the maximum number of virtual machines provisioned for each month. Requires tenant ID and organization GUID.

```APIDOC
## GET /cam/api/v1/managedvirtualmachines/highwatermark

### Description
Retrieves the maximum number of virtual machines provisioned for each month.

### Method
GET

### Endpoint
/cam/api/v1/managedvirtualmachines/highwatermark

### Parameters
#### Query Parameters
- **tenantId** (string) - Required - The ID of the tenant.
- **ace_orgGuid** (string) - Required - The organization GUID for the ACE.

### Request Example
```bash
curl -k -X GET -H "Authorization: Bearer ${CAM_BEARER_TOKEN}" "https://${CAM_HOST}:${CAM_PORT}/cam/api/v1/managedvirtualmachines/highwatermark?tenantId=${CAM_TENANT_ID}&ace_orgGuid=${ICP_TEAM}"
```

### Response
#### Success Response (200)
- **data** (object) - Contains the high watermark data for virtual machines.
  - **month** (string) - The month.
  - **max_vms** (integer) - The maximum number of virtual machines for that month.

#### Response Example
```json
{
  "data": [
    {
      "month": "2023-01",
      "max_vms": 150
    },
    {
      "month": "2023-02",
      "max_vms": 175
    }
  ]
}
```
```

--------------------------------

### Sample NFS /etc/exports Configuration

Source: https://www.ibm.com/docs/en/cam/4.1_topic=installation-creating-cloud-automation-manager-persistent-volumes

This is a sample configuration file for NFS exports. It shows examples for NFSv2/v3 and NFSv4, demonstrating how to specify which directories to export and the access control options (read/write, sync, etc.) for different clients. Customize this file according to your specific environment needs.

```text
# /etc/exports: the access control list for filesystems which may be exported
#               to NFS clients.  See exports(5).
#
# Example for NFSv2 and NFSv3:
# /srv/homes       hostname1(rw,sync,no_subtree_check) hostname2(ro,sync,no_subtree_check)
#
# Example for NFSv4:
# /srv/nfs4        gss/krb5i(rw,sync,fsid=0,crossmnt,no_subtree_check)
# /srv/nfs4/homes  gss/krb5i(rw,sync,no_subtree_check)

```

--------------------------------

### Create Directory (Bash)

Source: https://www.ibm.com/docs/en/cam/4.2_topic=repository-using-installation-manager-live-repositories

Creates a new directory with the specified name. This command is used to organize files and structure the file system.

```bash
mkdir IMTemp
```

--------------------------------

### Get and set etcd endpoint details for calico-config

Source: https://www.ibm.com/docs/en/cam/4.2_topic=service-strongswan-helm-chart-cloud-private

Retrieves the etcd endpoint details from the 'etcd-config' configmap in the 'kube-system' namespace and prepares to update the 'calico-config' configmap with these details.

```bash
etcd_ep=kubectl -n kube-system get cm etcd-config -ojsonpath={.data.etcd_endpoints} -n kube-system; echo "$etcd_ep"
kubectl -n kube-system edit cm calico-config
```

--------------------------------

### Get Stacks

Source: https://www.ibm.com/docs/en/cam/4.2_topic=apis-example-retrieve-list-deployed-templates

Retrieves a list of stacks associated with a specific tenant, team, and namespace. This endpoint is useful for managing and querying deployed resources.

```APIDOC
## GET /cam/api/v1/stacks

### Description
Retrieves a list of stacks associated with a specific tenant, team, and namespace. This endpoint is useful for managing and querying deployed resources.

### Method
GET

### Endpoint
/cam/api/v1/stacks

### Parameters
#### Path Parameters
None

#### Query Parameters
- **tenantId** (string) - Required - The unique identifier for the tenant.
- **ace_orgGuid** (string) - Required - The organization GUID, often referred to as the team.
- **cloudOE_spaceGuid** (string) - Required - The namespace GUID, often referred to as the space.

#### Request Body
None

### Request Example
```bash
curl -k -X GET -H "Authorization: Bearer ${CAM_BEARER_TOKEN}" "https://${CAM_HOST}:30000/cam/api/v1/stacks?tenantId=${CAM_TENANT_ID}&ace_orgGuid=${ICP_TEAM}&cloudOE_spaceGuid=${ICP_NAMESPACE}"
```

### Response
#### Success Response (200)
- **name** (string) - The name of the stack.
- **created_at** (string) - The timestamp when the stack was created.
- **templateId** (string) - The ID of the template used to create the stack.
- **namespaceId** (string) - The ID of the namespace where the stack is deployed.
- **templateName** (string) - The name of the template.
- **templateCategory** (string) - The category of the template.
- **templateProvider** (string) - The provider of the template (e.g., VMware vSphere).
- **template_type** (string) - The type of the template (e.g., Terraform).
- **template_format** (string) - The format of the template (e.g., HCL).
- **applied_state_id** (string) - The ID of the last applied state.
- **latest_state_id** (string) - The ID of the latest state.
- **cloud_connection_ids** (array) - A list of cloud connection IDs used by the stack.
- **id** (string) - The unique identifier for the stack.
- **tenantId** (string) - The ID of the tenant.
- **status** (string) - The current status of the stack (e.g., IN_PROGRESS).
- **message** (string) - A message providing details about the stack's status.
- **action** (string) - The last action performed on the stack (e.g., CREATE).
- **stack_id** (string) - A unique identifier for the stack instance.
- **applied_status** (string) - The status of the last applied action.
- **applied_action** (string) - The last applied action.

#### Response Example
```json
[
  {
    "name": "MyvSphereDeploy",
    "created_at": "2017-11-02T18:08:00.818Z",
    "templateId": "59f8b7b50377070020bdf501",
    "namespaceId": "default",
    "templateName": "SingleVirtualMachine-Hugh",
    "templateCategory": "userCreated",
    "templateProvider": "VMware vSphere",
    "template_type": "Terraform",
    "template_format": "HCL",
    "applied_state_id": "59fb5f01873a17001f1d3896",
    "latest_state_id": "59fb5f01873a17001f1d3896",
    "cloud_connection_ids": [
      "59f8b79e0377070020bdf4fe"
    ],
    "id": "59fb5f00873a17001f1d3895",
    "tenantId": "5c0e0a5e-d431-468c-9a11-a3df3978e424",
    "status": "IN_PROGRESS",
    "message": "",
    "action": "CREATE",
    "stack_id": "c36cc6d0-bff8-11e7-ac54-5bb358fd234d",
    "applied_status": "IN_PROGRESS",
    "applied_action": "CREATE"
  }
]
```
```

--------------------------------

### Backup Cloud Automation Manager BPD UI Repositories

Source: https://www.ibm.com/docs/en/cam/4.2_topic=installing-backing-up-cloud-automation-manager

This snippet shows how to back up the repositories for the Cloud Automation Manager BPD UI. It involves scaling the `cam-bpd-ui` deployment and then executing a tar command within the pod to create a compressed archive of the specified directories.

```shell
kubectl scale -n services deploy cam-bpd-ui --replicas=1

```

```shell
export BPD_UI=$(kubectl get -n services pods | grep cam-bpd-ui | awk '{print $1}')
kubectl exec -it -n services $BPD_UI -- tar -cvzf /tmp/cam-bpd-ui-backup.tgz -C /opt/ibm-ucd-patterns/ workspace repositories

```

--------------------------------

### List Available Packages using PUCL

Source: https://www.ibm.com/docs/en/cam/4.2_topic=repository-using-installation-manager-live-repositories

This command lists available packages from a specified WebSphere Liberty repository. It requires the PUCL executable and prompts for IBMid credentials. The output shows available offerings that can be copied.

```bash
/opt/ibm/docker/software-repo/var/swRepo/private/IMProducts/PUCL/PUCL listAvailablePackages -repositories http://www.ibm.com/software/repositorymanager/com.ibm.websphere.liberty.CORE -prompt
```
Tokens:
Raw