IBM Cloud App Management

https://www.ibm.com/docs/en/cloud-app-management
Admin
IBM Cloud App Management is a software solution for managing and monitoring cloud applications,...
Tokens:569,355
Snippets:6,587
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Example Post-Install Setup Script Execution

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=options-installing-cloud-app-management-red-hat-openshift

An example of executing the post-install-setup.sh script for Cloud App Management with advanced offering enabled. It specifies release name, namespace, instance name, and the advanced flag.

```bash
my_install_dir/ibm-cloud-appmgmt-prod/ibm_cloud_pak/pak_extensions>/post-install-setup.sh --releaseName ibmcloudappmgmt \
--namespace icam --instanceName ibmcloudappmgmt –-advanced
```

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

### Start WebLogic Agent (Shell/Batch)

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.4_topic=cwm-configuring-agent-by-using-silent-response-file

This command starts the configured WebLogic agent instance. You need to provide the agent's installation directory and the instance name. The agent must be configured prior to starting.

```shell
install_dir/bin/weblogic-agent.sh start instance_name
```

```batch
install_dir\bin\weblogic-agent.bat start instance_name
```

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

### Start MySQL Agent Script

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=cmm-configuring-agent-linux-systems-1

This command starts the configured MySQL agent, allowing it to collect and send data. It requires the installation directory and the previously defined instance name. Ensure the agent is configured before attempting to start it.

```shell
install_dir/bin/mysql-agent.sh start instance_name
```

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

### Start PostgreSQL Agent (Shell)

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=cpm-configuring-agent-by-using-silent-response-file

This command starts the configured PostgreSQL agent instance. It requires the agent's installation directory and the instance name provided during configuration. This script is essential for the agent to begin monitoring.

```shell
install_dir/bin/postgresql-agent.sh start instance_name
```

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

### Start Azure Compute Agent Instance

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=cacm-configuring-agent-by-responding-prompts

Starts the configured Azure Compute agent instance. Requires the installation directory and the instance name provided during configuration.

```shell
install_dir/bin/azure_compute-agent.sh start instance-name

```

```shell
/opt/ibm/apm/agent/bin/azure_compute-agent.sh start azc-inst3

```

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

### Start JBoss Agent Instance

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=cjm-configuring-agent-by-responding-prompts

This command starts a previously configured JBoss agent instance. It requires the installation directory and the instance name as input. The agent will then begin its operation.

```shell
install_dir/bin/jboss-agent.sh start instance_name
```

```shell
/opt/ibm/apm/agent/bin/jboss-agent.sh start example-inst01
```

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

### Example Console URL After Service Instance Creation

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.4_topic=private-creating-your-service-instance

This example demonstrates the output received after successfully running the `post-install-setup.sh` script. It includes a success message and the URL to access the IBM Cloud App Management dashboard.

```text
Wed Sep 11 02:46:50 EDT 2019 Done creating serviceinstance advanced
  Please access the IBM Cloud App Management dashboard at https://xxx.xxx.com/cemui/landing?subscriptionId=e7f18459- d3b6-40c9-b754-74e6d82b4473
```

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

### Start RabbitMQ Agent Instance

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.4_topic=crm-configuring-agent-linux-systems

This command starts the configured RabbitMQ agent instance. It requires the installation directory and the instance name provided during configuration. Ensure the agent is properly configured before executing this command to begin data collection.

```shell
install_dir/bin/rabbitmq.sh start instance_name
```

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

### Start JBoss Agent

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=cjm-configuring-agent-by-using-silent-response-file

Command to start the JBoss agent after it has been configured. This command requires the installation directory and the agent instance name. Ensure the agent is properly configured before starting.

```shell
/opt/ibm/apm/agent/bin/jboss-agent.sh start example-inst01
```

```shell
C:\IBM\APM\bin\jboss-agent.bat start example-inst01
```

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

### Run post-install-setup.sh Script for Service Instance

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.4_topic=private-creating-your-service-instance

This script is used to create a service instance for Cloud App Management. It requires parameters like release name, instance name, and namespace. An optional tenant ID can also be provided. The --advanced parameter is used for the Advanced offering.

```shell
ibm_cloud_pak/pak_extensions/post-install-setup.sh --releaseName my_release_name \
--instanceName my_instance_name \
--namespace my_namespace \
[ --tenantID my_tenant_ID ]
```

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

### Example Agent Configuration File Structure

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=monitoring-disabling-snapshot-data-collection-agent

This example demonstrates the structure of an agent configuration file, showing how different sections like KqiAgent and MonitorBroker are defined. It includes the setting for `defaultRetainRecentSnapshotSamples` within the KqiAgent section.

```INI
INSTANCE=inst1 [
SECTION=KqiAgent [ { agentId=inst1 } { instName=inst1 } {defaultRetainRecentSnapshotSamples=0}]
SECTION=MonitorBroker:BRK1 [ { collectNodeData=NO } ]
SECTION=MonitorBroker:BRK2 [ { collectNodeData=NO } ]
]
```

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

### Start Amazon EC2 Agent

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=monitoring-configuring-agent-by-responding-prompts

This command starts the configured Amazon EC2 agent. It requires the installation directory and the agent instance name as input. Ensure the agent is configured before starting.

```shell
install_dir/bin/amazonec2-agent.sh start instance_name
```

```shell
/opt/ibm/apm/agent/bin/amazonec2-agent.sh start ec2-inst3
```

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

### Run Cloud App Management Post-Install Setup Script (Base Offering)

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=options-installing-cloud-app-management-red-hat-openshift

Executes the post-installation setup script for the base offering of Cloud App Management. This script completes administrative tasks required for dashboard access.

```bash
ibm_cloud_pak/pak_extensions/post-install-setup.sh --releaseName ${default_release} --instanceName ${instance_name} --namespace ${namespace}
```

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

### Start KVM Agent

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=monitoring-configuring-connection-rhevm-server

Start the configured KVM agent by executing a script that includes the agent's installation directory and the instance name. This command initiates the agent's operational status.

```shell
install_dir/bin/linux_kvm-agent.sh start instance_name
Example: /opt/ibm/apm/agent/bin/linux_kvm-agent.sh start instance_name
```

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

### Create Installation Directory (Bash)

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.4_topic=offline-installing-eventing-only

Creates a directory to store installation files. This is the first step in setting up the environment for Cloud App Management server eventing only installation.

```bash
mkdir install_dir/
```

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

### Run Cloud App Management Post-Install Setup Script (Advanced Offering)

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=options-installing-cloud-app-management-red-hat-openshift

Executes the post-installation setup script for the advanced offering of Cloud App Management. This script configures administrative tasks for advanced features and dashboard access.

```bash
ibm_cloud_pak/pak_extensions/post-install-setup.sh --releaseName ${default_release} --instanceName ${instance_name} --namespace ${namespace} --advanced
```

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

### Start WebLogic Agent Instance

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.4_topic=cwm-configuring-agent-by-responding-prompts

This command starts the configured WebLogic agent instance. It requires the installation directory and the name of the agent instance to be started. The agent will then begin monitoring WebLogic.

```bash
install_dir/bin/weblogic-agent.sh start instance_name
```

```bash
/opt/ibm/apm/agent/bin/weblogic-agent.sh start example-inst01
```

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

### Start IBM Integration Bus Agent

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=monitoring-configuring-integration-bus-agent

Command to start a configured instance of the IBM Integration Bus agent. This command requires the installation directory and the specific instance name that was provided during configuration. Ensure the agent is configured before attempting to start it.

```shell
install_dir/bin/iib-agent.sh start instance_name
```

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

### Start IBM Monitoring Agent using Command Line

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=iaws-installing-agents

This snippet shows how to start an IBM monitoring agent using its command-line interface. It assumes the agent's executable is in the system's PATH or the user is in the agent's directory. No specific dependencies are mentioned beyond the agent installation itself.

```batch
name-agent.bat start
```

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

### Run Post-Installation Setup Script for IBM Cloud App Management

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.4_topic=oicamcp-installing-cloud-app-management-stand-alone-cloud-private

Completes administrative tasks after the Helm chart deployment, enabling access to the IBM Cloud App Management dashboard. The script requires release name, namespace, and instance name as parameters. It also supports advanced offering deployment and logging control. Usage examples for base and advanced offerings are provided.

```bash
# Usage: ./ibm-cloud-appmgmt-prod/ibm_cloud_pak/pak_extensions/post-install-setup.sh
# 
# --releaseName <name>             Release name, default of ${default_release}"
# --namespace <name>               Namespace, default of ${namespace}"
# --instanceName <name>            Name for the serviceinstance, default of ${instance_name}"
#
# [ --advanced ]                   Choose Advanced offering ( omit this parameter will chose Base offering )"
# [ --noLog  ]                     Do not log to ${log_file}"
# [ --tenantID <UUID> ]            The TenantID of the new serviceinstance, default is random"

"example: for Base offering"
./ibm-cloud-appmgmt-prod/ibm_cloud_pak/pak_extensions/post-install-setup.sh \
--releaseName ${default_release} --instanceName ${instance_name} --namespace ${namespace}"

"example: for Advanced offering"
./ibm-cloud-appmgmt-prod/ibm_cloud_pak/pak_extensions/post-install-setup.sh \
--releaseName ${default_release} --instanceName ${instance_name} --namespace ${namespace} --advanced"

```

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

### Start WebSphere Infrastructure Manager Agent (Shell)

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=agents-configuring-websphere-infrastructure-manager-monitoring

Command to start the configured WebSphere Infrastructure Manager agent. This command requires the installation directory and the previously defined instance name.

```shell
install_dir/bin/wim-agent.sh start instance_name
```

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

### Create Installation Directory

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.4_topic=oicamcp-installing-cloud-app-management-stand-alone-cloud-private

Creates a directory for the installation. The directory name can be specified by the user. Ensure sufficient free space for the installation image.

```bash
mkdir -p install_dir
```

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

### Helm Install Command with Data Retention Setting

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.4_topic=oicamcp-installing-cloud-app-management-stand-alone-cloud-private

This example shows a Helm installation command that configures the data retention period to 15 days, demonstrating the use of the --set option for customization.

```bash
# Helm install command example with data retention set to 15 days
# Replace with actual Helm install command details as needed.
```

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

### Create Installation Directory and Download PPA

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=private-installing-cloud-app-management-server

Creates a directory for installation and downloads the Cloud App Management server installation PPA file (app_mgmt_server_2019.3.0.tar.gz). Ensures sufficient disk space is available.

```shell
mkdir -p install
cd install
```

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

### JavaScript: Perform a GET request for REST API testing

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=test-create-rest-api-case

Execute a GET request to retrieve data from an API endpoint. The example demonstrates setting up the request, validating the status code, and completing the step.

```javascript
let baseUrl = 'https://reqres.in/api/messages';
// Make GET request
describe('get messages', function (complete) {
    request.get(baseUrl, {}, function (error, response) {
        // Validate the response code, if assertion fails, log "failed to get message " plus results as error message on synthetic dashboard
        assert.ok(response && response.statusCode == 200, "failed to get message" + error);
        complete();
    });
});
```

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

### Configure Agent Startup with Non-Root User

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=procedures-starting-agents-as-non-root-user

This XML configuration in `kcirunas.cfg` defines how monitoring agents start. It allows specifying the product code and the user under which the agent should run, with support for instance-specific configurations.

```xml
<productCode>mq</productCode>
<instance>
<name>qmgrinst1</name>
<user>qmgrinst1</user>
</instance>
<instance>
<name>qmgrinst2</name>
<user>root</user>
</instance>
```

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

### Run Pre-installation Script for IBM Cloud App Management

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.4_topic=oicamcp-installing-cloud-app-management-stand-alone-cloud-private

The `pre-install.sh` script performs essential preparation tasks before installing IBM Cloud App Management. It creates a `values.yaml` file for customization and can enable TLS encryption. The script requires several flags to configure the installation, including license acceptance, HTTPS enablement, offering type (Base/Advanced), release name, master node details, ingress port, proxy information, namespace, cluster domain, and image repository port. Optional flags are available for email setup.

```bash
Usage ./ibm-cloud-appmgmt-prod/ibm_cloud_pak/pak_extensions/pre-install.sh
Use this script to perform preparation tasks that require admin permissions before IBM Cloud AppMgmt is installed.

  *Required flags
    --accept                               Accepts license agreement(s)
    --https                                Install with HTTPS enabled (HTTPS is always enabled in Advanced offering)
    --advanced                             Install as ADVANCED offering (omit this parameter will install as Base offering)
    --releaseName <name>                   Release name (default is ibmcloudappmgmt)
    --masterAddress <FQDN>                 Fully qualified domain name (FQDN) for the ICP Master.
                                           In a highly available environment, this would be the FQDN of the HAProxy or load balancer for ICP.
    --masterPort <int>                     The port of the ICP master. On OpenShift the default port is 443, which will need to be specified here. (default is 8443)
    --ingressPort <int>                    The ingress port used to access the ICP console. (default is 443)
    --proxyIP <IP>                         IP address for ICP Proxy.
                                           In a highly available environment, this would be the IP address of the HAProxy or load balancer for ICP.
    --proxyFQDN <FQDN>                     Fully qualified domain name (FQDN) for the ICP Proxy.
                                           In a highly available environment, this would be the FQDN of the HAProxy or load balancer for ICP.
    --namespace <name>                     Namespace (default is default)
    --clusterCAdomain <name>               ICP cluster domain name, default is mycluster.icp
	                                       This value, combined with the values provided for --repositoryPort and --namespace, will determine the imageRepository where ICAM will look for images, e.g. with --clusterCAdomain mycluster.icp --repositoryPort 8500 and --namespace icam, you will end up with an imageRepository of mycluster.icp:8500/icam
    --repositoryPort <int>                 The port of the image repository. On OpenShift the default port is 5000, which will need to be specified here. (default is 8500)

  *Optional - Email setup: 
    --emailtype <smtp|api>                 Type of email, either smtp or api
    --emailfrom <emailAddress>             Email address to show on sent mail as from
    --smtphost <hostname>                  SMTP hostname
    --smtpport <port>                      SMTP port
    --smtpuser <user>                      SMTP user
    --smtppass <password>                  SMTP password
```

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

### Run IBM Cloud App Management Pre-installation Script

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.3_topic=options-installing-cloud-app-management-red-hat-openshift

The 'pre-install.sh' script performs essential preparation tasks before installing IBM Cloud App Management, requiring administrator permissions. Key parameters include '--accept' for license agreement, '--https' for enabling HTTPS, '--advanced' for the Advanced offering, and '--releaseName' for specifying the release name. Other important flags control master and proxy addresses, namespace, cluster domain, and Cassandra username for enhanced security.

```shell
Usage ./ibm_cloud_pak/pak_extensions/pre-install.sh
Use this script to perform preparation tasks that require admin permissions before IBM Cloud AppMgmt is installed.

  *Required flags
    --accept                               Accept license agreement(s)
    --https                                Install with HTTPS enabled (HTTPS is always enabled in Advanced offering)
    --advanced                             Install as ADVANCED offering (omit this parameter will install as Base offering)
    --releaseName <name>                   Release name (default is ibmcloudappmgmt)
    --masterAddress <IP|FQDN>              IP address or fully qualified domain name (FQDN) for the ICP Master. You must use the address that you used to login to the ICP console.
                                           In a highly available environment, this would be the FQDN of the HAProxy or load balancer for ICP.
    --proxyIP <IP>                         IP address for ICP Proxy.
                                           In a highly available environment, this would be the IP address of the HAProxy or load balancer for ICP.
    --proxyFQDN <FQDN>                     Fully qualified domain name (FQDN) for the ICP Proxy.
                                           In a highly available environment, this would be the FQDN of the HAProxy or load balancer for ICP.
    --namespace <name>                     Namespace (default is default)
    --clusterCAdomain <name>               ICP cluster domain name, default is mycluster.icp
    --cassandraUsername <string>           The username Cassandra will use. If left unset, the default cassandra credentials will be used.

  *Optional - Email setup:
```

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

### Change Directory to Agent Installation

Source: https://www.ibm.com/docs/en/cloud-app-management/2019.4_topic=csnjsm-configuring-agent-linux-aix-systems

Navigates to the agent's installation directory on the command line. This is a prerequisite step before running agent configuration or start commands.

```bash
cd /opt/ibm/apm/agent/bin
```
Tokens:
Raw