IBM Application Modernization Accelerator

https://www.ibm.com/docs/en/ama
Admin
IBM Application Modernization Accelerator is a platform that helps organizations modernize and...
Tokens:64,318
Snippets:361
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install Podman on macOS

Source: https://www.ibm.com/docs/en/ama/index_topic=install

This snippet covers the steps to install and configure Podman on macOS. It includes commands to install Podman using Homebrew, check its version, initialize the Podman machine with specified resources, set it to run as rootful, and start the machine. It also includes a command to remove an existing Podman machine if necessary.

```bash
brew install podman
```

```bash
podman --version
```

```bash
podman machine init --cpus 4 --memory 8192
```

```bash
podman machine set --rootful
```

```bash
podman machine start
```

```bash
podman machine rm
```

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

### Start Application Modernization Accelerator (Shell)

Source: https://www.ibm.com/docs/en/ama/index_topic=install-configuring-authentication

This script starts the Application Modernization Accelerator after configuration changes have been made. It is executed from the installation directory and presents a menu for starting the application.

```shell
./launch.sh
Choose Start Application Modernization Accelerator from the menu option
```

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

### GitHub OAuth Configuration File for CASE Install

Source: https://www.ibm.com/docs/en/ama/index_topic=configuring-application-modernization-accelerator

Example of an authentication configuration file used with the `--authConfigFile` option for CASE `install`. This file sets various OAuth2 parameters for GitHub.

```properties
# set to true to disable authentication on UI server
TA_AUTH_UI_DISABLED=false
# set to true to disable authentication on Liberty server
TA_AUTH_LIBERTY_DISABLED=false

# OAuth2 Server client id
TA_AUTH_OIDC_CLIENT_ID=xxx
# OAuth2 Server client secret
TA_AUTH_OIDC_CLIENT_SECRET=xxx

# endpoint to request identity of the OAuth2 Server, no tailing /
TA_AUTH_IDENTITY_REQUEST_ENDPOINT=https://github.com
# path of the endpoint to request identity to OAuth2 Server, with heading /
TA_AUTH_IDENTITY_REQUEST_ENDPOINT_PATH=/login/oauth/authorize
# OAuth2 scope
TA_AUTH_IDENTITY_REQUEST_ENDPOINT_SCOPE=openid+offline
# some OAuth2 state requires minimum length, default to empty
TA_AUTH_CALLBACK_STATE_PREFIX_PADDING=

# endpoint to request token of the OAuth2 Server, no tailing /
TA_AUTH_TOKEN_REQUEST_ENDPOINT=https://github.com
# path of the endpoint to request token of the OAuth2 Server, with heading /
TA_AUTH_TOKEN_REQUEST_ENDPOINT_PATH=/login/oauth/access_token

# endpoint to verify tokens of the OAuth2 Server, no tailing /
TA_AUTH_TOKEN_VERIFICATION_ENDPOINT=https://api.github.com
# path to the endpoint to verify tokens of the OAuth2 Server, with heading /
TA_AUTH_TOKEN_VERIFICATION_ENDPOINT_PATH=/user
```

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

### Launch Application Modernization Accelerator Installation

Source: https://www.ibm.com/docs/en/ama/index_topic=ocp-air-gap-install

Launches the installation process for the Application Modernization Accelerator on an OpenShift cluster. This command installs the private catalog, operator, and the product instance. It requires `CASE_NAME`, `CASE_VERSION`, `NAMESPACE`, and other optional parameters.

```bash
export NAMESPACE=<my_ama_namespace>
oc ibm-pak launch \
 $CASE_NAME \
 --version $CASE_VERSION \
 --action install \
 --inventory v2InstallProduct \
 --namespace $NAMESPACE \

```

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

### Application Modernization Accelerator Installation Arguments

Source: https://www.ibm.com/docs/en/ama/index_topic=ocp-air-gap-install

These arguments customize the installation of the Application Modernization Accelerator. Options include viewing help (`--taHelp`), license details (`--viewLicense`), installing the private catalog (`--installAmaCatalog`), and enabling persistence with a specific storage class (`--persistence true --storageClass ibmc-block-gold`).

```bash
--acceptLicense true --licenseType <X-XXXX-XXXXXX> --installAmaCatalog --persistence true --storageClass ibmc-block-gold
```

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

### Install Binary Scanner

Source: https://www.ibm.com/docs/en/ama/index_topic=accelerator-collecting-websphere-liberty-open-liberty

Installs the Migration Toolkit for Application Binaries by running the installer JAR file. Requires Java to be installed.

```bash
java -jar binaryAppScannerInstaller.jar
```

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

### Transadvui Installation Options (CASE Installer)

Source: https://www.ibm.com/docs/en/ama/index_topic=configuring-application-modernization-accelerator

This list details the available options for configuring the Transadvui installation via the CASE installer. It covers essential settings like license acceptance, resource management (CPU, memory, persistence), registry access credentials, and cluster endpoint configurations. Some options are required, while others are optional with default values.

```text
--licenseType <true|false>          : REQUIRED: Must be used and set to a valid license type.
--acceptLicense <true|false>        : REQUIRED: Must be used and set to true to proceed with install.
--installIbmCatalog <true|false>    : OPTIONAL: If set to true, the IBM operator catalog will be installed if it is not already. Default is false.
--secret <secret>                   : OPTIONAL: Specify a secret to use to pull the Tranformation Advisor images from entitle registry.
--registry <registry>               : OPTIONAL: Specified entitled registry, e.g. cp.icr.io.
--user <user>                       : OPTIONAL: Specify user to access the entitled registry.
--pass <password>                   : OPTIONAL: Specify password for user to access the entitled registry.
--persistence <true|false>          : OPTIONAL: If persistence is required for Application Modernization Accelerator (Default is true).
--accessMode <accessMode>           : OPTIONAL: storage accessMode. Default is ReadWriteOnce.
--persistenceClaimCouchDB <claim>   : OPTIONAL: Use an existing persistence claim for CouchDB.
--persistenceClaimNeo4j <claim>     : OPTIONAL: Use an existing persistence claim for Neo4j.
--storageClass <storage class>      : OPTIONAL: Recommended way use persistence with Application Modernization Accelerator. Specify a valid storage class to use.
--supplementalGroups [gid,...]      : OPTIONAL: May be used if using file system based storage to ensure database container has read/write permission for the storage.
--hostName <hostname>               : OPTIONAL: hostname to access cluster. Application Modernization Accelerator will discover and set this value. It should not need to be changed for most environments.
--apiEndpoint <apiEndpoint>         : OPTIONAL: API url for the cluster. Application Modernization Accelerator will discover and set this value. It should not need to be changed for most environments.
--authIssuerEndpoint <aiEndpoint>   : OPTIONAL: Auth issuer endpoint for the cluster. Application Modernization Accelerator will discover and set this value. It should not need to be changed for most environments.
--publicUrlServer                   : OPTIONAL: See docs for more information. Application Modernization Accelerator will discover and set this value. It should not need to be changed for most environments.
--publicUrlUI                       : OPTIONAL: See docs for more information. Application Modernization Accelerator will discover and set this value. It should not need to be changed for most environments.
--customCACert <file path>          : OPTIONAL: Specify file to use as custom CA cert.
--authConfigFile <file path>        : OPTIONAL: Specify file to use to configure third party authentication.
--namespaceScoped <true|false>      : OPTIONAL: If ommitted, defaults to false. This will make the operator to be insalled into openshift-operators namespace and manage all the namespaces, operand will go into namespace specified by --namespace attribute. If set to true, operator and operand are installed into namespace specified by --namespace attribute.
--taHelp                            : OPTIONAL: Display options available
```

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

### Install Transadvui using CASE Installer (OpenShift CLI)

Source: https://www.ibm.com/docs/en/ama/index_topic=configuring-application-modernization-accelerator

This command initiates the installation of the Transadvui component using the IBM Pak CLI. It requires specifying the CASE name, version, inventory, target namespace, action, and optional arguments for customization. The arguments parameter accepts a string of key-value pairs for further configuration.

```bash
oc ibm-pak launch \
    $CASE_NAME \
    --version $CASE_VERSION \
    --inventory v2InstallProduct \
    --namespace $TA_PROJECT \
    --action install \
    --args "[OPTIONS]"
```

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

### Mirror Images for Disconnected Installation (Bastion Host)

Source: https://www.ibm.com/docs/en/ama/index_topic=ocp-air-gap-install

Mirrors images to a target registry for a 'Bastion host' disconnected installation. It uses the generated `images-mapping.txt` file and requires authentication to registries via `REGISTRY_AUTH_FILE`.

```bash
oc image mirror \
 -f ~/.ibm-pak/data/mirror/$CASE_NAME/$CASE_VERSION/images-mapping.txt \
 --filter-by-os '.*'  \
 -a $REGISTRY_AUTH_FILE \
 --skip-multiple-scopes \
 --max-per-registry=1
```

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

### Mirror Images to Filesystem for Disconnected Installation

Source: https://www.ibm.com/docs/en/ama/index_topic=ocp-air-gap-install

Downloads images to the local filesystem for a 'Filesystem' disconnected installation. It uses `images-mapping-to-filesystem.txt` and requires `REGISTRY_AUTH_FILE` for authentication.

```bash
oc image mirror \
 -f ~/.ibm-pak/data/mirror/$CASE_NAME/$CASE_VERSION/images-mapping-to-filesystem.txt \
 --filter-by-os '.*' \
 -a $REGISTRY_AUTH_FILE \
 --skip-multiple-scopes \
 --max-per-registry=1
```

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

### Copy Data Directories for Local Accelerator Install (Shell)

Source: https://www.ibm.com/docs/en/ama/index_topic=accelerator-backing-up-couchdb

This snippet demonstrates how to copy essential data directories and the password file for backing up an Application Modernization Accelerator Local installation. Ensure the paths `<some location>` and `<backup location>` are correctly specified. This method is suitable for local setups where direct file access is feasible.

```shell
cp -a <some location>/data <backup location>/data
cp -a <some location>/graph_data <backup location>/graph_data
cp -a <some location>/scripts/.neo4j_pass <backup location>/scripts/
```

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

### Run Shell Script for Installation/Uninstallation

Source: https://www.ibm.com/docs/en/ama/index_topic=install-upgrading-latest-version

This script is used to launch the Application Modernization Accelerator installation or uninstallation process. It requires execution from the command line and typically prompts the user for choices, such as installing or uninstalling the application.

```shell
./launch.sh
```

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

### Start and Verify Liberty Server (Shell)

Source: https://www.ibm.com/docs/en/ama/index_topic=migration-how-deploy-your-app-red-hat-openshift-container-platform

These commands initiate the Liberty server and provide instructions for checking the server logs to confirm successful application startup. It also includes the URL format for accessing the deployed application.

```shell
<LIBERTY_HOME>/bin/server start server1
```

```shell
cd <LIBERTY_HOME>/usr/servers/server1/logs
vi messages.log
```

```shell
http://<LIBERTY_HOME_MACHINE_IP>:9080/<APP_CONTEXT_ROOT>
```

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

### Generate Mirror Manifests for Disconnected Installation

Source: https://www.ibm.com/docs/en/ama/index_topic=ocp-air-gap-install

Generates mirror manifests required for disconnected installations. This command differs based on whether a 'Bastion host' or 'Filesystem' path is used. It requires `CASE_NAME`, `CASE_VERSION`, and `TARGET_REGISTRY` environment variables.

```bash
export TARGET_REGISTRY=mytargetregistry.com
oc ibm-pak generate mirror-manifests $CASE_NAME $TARGET_REGISTRY --version $CASE_VERSION
```

```bash
export TARGET_REGISTRY=mytargetregistry.com
oc ibm-pak generate mirror-manifests \
 $CASE_NAME \
 file://local \
 --version $CASE_VERSION \
 --final-registry $TARGET_REGISTRY
```

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

### Start Docker Service

Source: https://www.ibm.com/docs/en/ama/index_topic=migration-how-deploy-your-app-red-hat-openshift-container-platform

Ensures the Docker service is running. This is a prerequisite for using Docker commands. It takes no input and has no output.

```bash
service docker start
```

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

### Restore Local Data Directories for Application Modernization Accelerator

Source: https://www.ibm.com/docs/en/ama/index_topic=accelerator-backing-up-couchdb

This snippet outlines the steps to restore data directories for a local installation of Application Modernization Accelerator. It involves navigating to the installation directory and copying backup data for 'data', 'graph_data', and '.neo4j_pass' scripts.

```bash
cd /path/to/Application/Modernization/Accelerator/Local
cp -a <backup location>/data .
cp -a <backup location>/graph_data .
cp -a <backup location>/scripts/.neo4j_pass scripts/
```

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

### Mirror Images from Filesystem to Final Registry

Source: https://www.ibm.com/docs/en/ama/index_topic=ocp-air-gap-install

Mirrors images from a local filesystem to the final target registry after performing a 'Filesystem' disconnected installation. It uses `images-mapping-from-filesystem.txt` and requires `REGISTRY_AUTH_FILE`.

```bash
oc image mirror \
 -f ~/.ibm-pak/data/mirror/$CASE_NAME/$CASE_VERSION/images-mapping-from-filesystem.txt \
 -a $REGISTRY_AUTH_FILE \
 --from-dir=${v2_dir} \
 --filter-by-os '.*' \
 --skip-multiple-scopes \
 --max-per-registry=1
```

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

### Launch IBM Application Modernization Accelerator on Windows

Source: https://www.ibm.com/docs/en/ama/index_topic=install

This snippet shows the command to execute the batch script for installing IBM Application Modernization Accelerator on Windows using Podman Desktop. The script is located in the `scripts/windowsPodmanDesktop` directory.

```batch
launch.bat
```

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

### Reduce Mirrored Images for CASE Installation (Bash)

Source: https://www.ibm.com/docs/en/ama/index_topic=ocp-air-gap-install

This script snippet reduces the number of images to mirror for Application Modernization Accelerator installation or upgrade when using catalog-based mirroring. It assumes that the `oc ibm-pak generate mirror-manifests ...` command has already been executed. The script renames the original `images-mapping.txt` file and then filters it to include only the necessary images for the specified version and its preceding minor version.

```bash
cd ~/.ibm-pak/data/mirror/ibm-appmod/MAJOR.MINOR.PATCH/
mv images-mapping.txt images-mapping.txt.orig
grep ":MAJOR\.MINOR\.PATCH" images-mapping.txt.orig > images-mapping.txt
grep ":vMAJOR\.MINOR" images-mapping.txt.orig >> images-mapping.txt

```

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

### Navigate to Discovery Tool Directory

Source: https://www.ibm.com/docs/en/ama/index_topic=accelerator-using-data-collector

Command to change the current directory to the Discovery Tool's installation folder. The asterisk (*) is a wildcard to match versioned directory names.

```shell
cd ama-discovery*
```

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

### Validate Application Modernization Accelerator Pods

Source: https://www.ibm.com/docs/en/ama/index_topic=install-ocp

Checks for the expected pods to be in a READY and Running state after installation. This includes ama-couchdb-0, ama-neo4j-0, ama-server-<ID>, and ama-ui-<ID>. It also checks for the ama-operator-instance-preinstall-<ID> job in a Completed state.

```text
ama-couchdb-0
ama-neo4j-0
ama-server-<ID>
ama-ui-<ID>

ama-operator-instance-preinstall-<ID>
```

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

### Create and Configure Liberty Server (Shell)

Source: https://www.ibm.com/docs/en/ama/index_topic=migration-how-deploy-your-app-red-hat-openshift-container-platform

This section details the commands to create a new server instance within a Liberty installation and to copy the application binary and additional configuration files to the appropriate directories. It ensures the server is set up to host the migrated application.

```shell
cd <LIBERTY_HOME>/bin
./server create server1
```

```shell
cd <MIGRATION_ARTIFACTS_HOME>
cp target/*.war <LIBERTY_HOME>/usr/servers/server1/apps
```

```shell
mkdir -p <LIBERTY_HOME>/usr/shared/config/lib/global
cp src/main/liberty/lib/* <LIBERTY_HOME>/usr/shared/config/lib/global
```

```shell
cp src/main/liberty/config/server.xml <LIBERTY_HOME>/usr/servers/server1/server.xml
```

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

### Display Discovery Tool Help and Options

Source: https://www.ibm.com/docs/en/ama/index_topic=troubleshooting-data-collector

Executes the discovery tool with the `--help` flag to display all available command-line options and usage instructions. This is useful for understanding the tool's capabilities and how to configure its execution.

```shell
bin/ama-discovery --help
```

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

### Get Service Names in Namespace

Source: https://www.ibm.com/docs/en/ama/index_topic=troubleshooting-security

This OpenShift command lists all services running within a specified namespace, which is helpful for identifying service names required for network connections or verification steps.

```bash
oc get services -n ta
```

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

### Get Pod Names in Namespace

Source: https://www.ibm.com/docs/en/ama/index_topic=troubleshooting-security

This OpenShift command retrieves a list of all running pods within a specified namespace, which is useful for identifying pod names needed for deletion or execution commands.

```bash
oc get pods -n ta
```

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

### Initialize z/OS Discovery Tool Environment

Source: https://www.ibm.com/docs/en/ama/index_topic=troubleshooting-data-collector

Changes the directory to `bin` and sources the `zOSPrereq` script, then navigates back to the parent directory. This step initializes necessary environment variables or configurations required before running the discovery tool.

```shell
cd bin && . ./zOSPrereq && cd ..
```

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

### Required Environment Variables for IBM Application Modernization Accelerator Security

Source: https://www.ibm.com/docs/en/ama/index_topic=troubleshooting-security

Lists the essential environment variables required for Application Modernization Accelerator security. These variables are typically set during installation. Missing or incorrect values can lead to UI server log messages and readiness probe failures.

```shell
TA_OCP_API_ENDPOINT=https://example.eu-de.containers.cloud.ibm.com:30999
TA_AUTH_ISSUER_ENDPOINT=https://example.eu-de.containers.cloud.ibm.com:30999
TA_AUTH_OIDC_CLIENT_ID=example5282946fac07867fbc937548cb35d3ebbace00
TA_AUTH_OIDC_CLIENT_SECRET=example5282946fac07867fbc937548cb35d3ebbace00
TA_API_KEY=B513VT1zlF56J9ZBjdambQQVM5_jePVN
TA_AES_IV=n6Ma2S4DiYVK3AlM
TA_AES_KEY=B513VT1zlF56J9ZBjdambQQVM5_jePVN
TA_DB_USER=admin
TA_AUTH_OIDC_CALLBACK_URI=http://example-ui-server/auth/callback
# the value of the private key shall be the base64 encoded pem format key
TA_PRIVATE_KEY
# the value of the public key shall be the base64 encoded cert
TA_PUBLIC_KEY
```

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

### Apply Kustomize Overlays for Development

Source: https://www.ibm.com/docs/en/ama/index_topic=migration-how-deploy-your-app-red-hat-openshift-container-platform

Applies Kustomize configurations from the 'overlays/dev' directory to create the custom resource for a Liberty application. This deploys the application to the development environment.

```shell
oc apply -k overlays/dev
```

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

### Validate Operator Pod for Single Namespace Install

Source: https://www.ibm.com/docs/en/ama/index_topic=install-ocp

For a single namespace installation, this command verifies that the operator pod, ibm-app-mod-accelerator-manager-<ID>, is in a READY and Running state.

```text
ibm-app-mod-accelerator-manager-<ID>
```

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

### Run Discovery Tool for Application Servers

Source: https://www.ibm.com/docs/en/ama/index_topic=accelerator-using-data-collector

Commands to execute the Discovery Tool for different application server types. These commands specify the server type and necessary configuration paths. Optional flags for application analysis and upload control are available.

```shell
IBM WebSphere: ./bin/ama-discovery -w <WEBSPHERE_HOME_DIR> -p <PROFILE_NAME> [ --ignore-missing-binary --ignore-missing-shared-library --applications --applications-file --skip-applications --skip-applications-file --no-upload]
Oracle WebLogic: ./bin/ama-discovery --web-logic-config-file <Path to the WebLogic domain config.xml file> [--applications --applications-file --skip-applications --skip-applications-file --no-upload]
JBoss: ./bin/ama-discovery --jboss-config-dir <Path to the JBoss server configuration directory> [--applications --applications-file --skip-applications --skip-applications-file --no-upload]
Apache Tomcat: ./bin/ama-discovery --tomcat-home-dir <TOMCAT_HOME_DIR> --tomcat-config-dir <TOMCAT_CONFIG_DIR> [--applications --applications-file --skip-applications --skip-applications-file --no-upload]
```

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

### Access IBM Application Modernization Accelerator URLs

Source: https://www.ibm.com/docs/en/ama/index_topic=install

This snippet provides the URLs to access the IBM Application Modernization Accelerator after a successful installation on Linux and macOS. The specific host or IP address and port will be provided by the installation program.

```text
Linux: https://< host name >:443
MacOS: https://< IP Address >:443
```

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

### Update .configuration for Disabling TLS

Source: https://www.ibm.com/docs/en/ama/index_topic=install-configuring-tls

This command updates the '.configuration' file, specifically the `TA_EXTERNAL_UI_PORT` value, as part of the process for disabling TLS in a non-OCP installation.

```shell
cd scripts
vi .configuration
... (commented out TA_EXTERNAL_UI_PORT line)
```

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

### Copy Application and Dependency Files to Migration Bundle (Shell)

Source: https://www.ibm.com/docs/en/ama/index_topic=migration-how-deploy-your-app-red-hat-openshift-container-platform

This task involves copying the application binary (ear/war) and any necessary dependency files into the migration artifacts bundle. It also includes removing placeholder files that are no longer needed. Ensure the file paths and names are correctly specified.

```shell
cp <BINARY_FILE_LOCATION>/<APPLICATION_FILE> <MIGRATION_ARTIFACTS_HOME>/target/
rm <MIGRATION_ARTIFACTS_HOME>/target/*.placeholder
```

```shell
cp <DEPENDENCY_FILE_LOCATION>/* <MIGRATION_ARTIFACTS_HOME>/src/main/liberty/lib
rm <MIGRATION_ARTIFACTS_HOME>/src/main/liberty/lib/*.placeholder
```

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

### Stop and Restart TA_LOCAL with Shell Scripts

Source: https://www.ibm.com/docs/en/ama/index_topic=install-configuring-tls

These commands are used to stop and restart the Application Modernization Accelerator (TA_LOCAL). It involves navigating to the installation directory and selecting options from a menu.

```shell
./launch.sh
Choose Stop Application Modernization Accelerator from the menu option
```

```shell
./launch.sh
Choose Re-initialize Configuration from the menu option
```

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

### Backup and Create .security_config for Disabling TLS

Source: https://www.ibm.com/docs/en/ama/index_topic=install-configuring-tls

This snippet shows how to back up an existing '.security_config' file and then create a new one to disable TLS for non-OCP installations. Default values for disabling TLS are provided.

```shell
cd scripts
cp .security_config .security_config.backup
```

```shell
cd scripts
vi .security_config
# Http
TA_AUTH_ENABLE_TLS=false
TA_LOCAL_INTERNAL_SERVER_PORT=9080
TA_LOCAL_INTERNAL_UI_PORT=3000
TA_LOCAL_INTERNAL_DB_PORT=5984

TA_AES_IV=
TA_AES_KEY=
```

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

### Limitations of Try it out

Source: https://www.ibm.com/docs/en/ama/index_topic=accelerator-using-application-modernization-apis

Explains a known limitation with the 'Try it out' feature when Application Modernization Accelerator is deployed in OpenShift Cloud Platform with ingress enabled.

```APIDOC
## Limitations of 'Try it out' Feature

### Description
When Application Modernization Accelerator is running in OpenShift Cloud Platform with ingress enabled, the 'Try it out' functionality in the API UI may fail. This is due to the generated `curl` command missing the ingress value.

### Workaround
To successfully test the API using 'Try it out', manually add the ingress value to the generated `curl` command before executing it.
```

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

### OCP Install Persistence Configuration

Source: https://www.ibm.com/docs/en/ama/index_topic=accelerator-disaster-recovery

YAML configuration for OCP installation of Application Modernization Accelerator, specifying persistence settings for CouchDB and Neo4j, including PVC details. Ensure accessMode and size match previous configurations if modified.

```yaml
persistence:
  couchdb:
    supplementalGroups: []
    accessMode: ReadWriteOnce
    size: 20Gi
    useDynamicProvisioning: true
    existingClaim: '<PVC_NAME>'
    storageClassName: ''
  neo4j:
    supplementalGroups: []
    accessMode: ReadWriteOnce
    size: 5Gi
    useDynamicProvisioning: true
    existingClaim: '<PVC_NAME>'
    storageClassName: ''
  enabled: true

```

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

### Validating Application Modernization Accelerator Pods

Source: https://www.ibm.com/docs/en/ama/index_topic=ocp-air-gap-install

This displays the expected pod names for a successful Application Modernization Accelerator installation. The pods `ama-couchdb-0`, `ama-neo4j-0`, `ama-server-<ID>`, and `ama-ui-<ID>` should be in a READY and Running state. Additionally, the `ama-operator-instance-preinstall-<ID>` job should be 'Completed'.

```text
ama-couchdb-0
ama-neo4j-0
ama-server-<ID>
ama-ui-<ID>
```

```text
ama-operator-instance-preinstall-<ID>
```

```text
ibm-app-mod-accelerator-manager<ID>
```

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

### Example of Successfully Pulled Image Event

Source: https://www.ibm.com/docs/en/ama/index_topic=ocp-upgrading-from-evaluation

This is an example log event indicating that a container image has been successfully pulled from the entitled registry. It shows the image URI and its digest, confirming that the authentication and pull process was successful. This event is typically found in the container logs or events within OpenShift.

```text
Successfully pulled image "cp.icr.io/cp/icpa/transformation-advisor-ui@sha256:<actual image digest here>" in 1.007108858s
```

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

### Create Project Command

Source: https://www.ibm.com/docs/en/ama/index_topic=install-ocp

Command-line utility to create a new project (namespace) in OpenShift. Replace NAMESPACE_PLACEHOLDER with the desired project name. This is a prerequisite for operator and instance deployment.

```bash
oc new-project NAMESPACE_PLACEHOLDER
```

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

### View Discovery Tool Command Line Options

Source: https://www.ibm.com/docs/en/ama/index_topic=accelerator-using-data-collector

This command displays all available command-line options and arguments for the Discovery Tool, aiding in customization and advanced usage.

```shell
./bin/ama-discovery --help
```

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

### Build Docker Image

Source: https://www.ibm.com/docs/en/ama/index_topic=migration-how-deploy-your-app-red-hat-openshift-container-platform

Builds a Docker image from a Dockerfile. Requires the path to migration artifacts and an image reference. The output is a tagged Docker image. It uses the `Dockerfile` or `Containerfile` in the specified directory.

```bash
cd <MIGRATION_ARTIFACTS_HOME>
docker build --no-cache -t "<IMAGE_REFERENCE>" -f Containerfile .
```

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

### Create 'ta' Namespace (oc)

Source: https://www.ibm.com/docs/en/ama/index_topic=configuring-application-modernization-accelerator

Creates the 'ta' namespace in OpenShift if it does not already exist. This is a prerequisite for installing or configuring Application Modernization Accelerator.

```shell
# create ta ns if it's not already there
oc create ns ta
```

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

### Mirror Images to Filesystem using oc image mirror

Source: https://www.ibm.com/docs/en/ama/index_topic=ocp-air-gap-install

This process mirrors container images to the local filesystem using `oc image mirror`. It involves downloading images to a temporary location, moving them to a trusted environment, and then mirroring them to the final destination. The `--insecure` flag is used, which is not recommended. It requires mapping files and authentication.

```bash
oc image mirror \
 -f ~/.ibm-pak/data/mirror/$CASE_NAME/$CASE_VERSION/images-mapping-to-filesystem.txt \
 --filter-by-os '.*' \
 -a $REGISTRY_AUTH_FILE \
 --insecure \
 --skip-multiple-scopes \
 --max-per-registry=1
```

```bash
oc image mirror \
 -f ~/.ibm-pak/data/mirror/$CASE_NAME/$CASE_VERSION/images-mapping-from-filesystem.txt \
 -a $REGISTRY_AUTH_FILE \
 --from-dir=${v2_dir} \
 --filter-by-os '.*' \
 --insecure \
 --skip-multiple-scopes \
 --max-per-registry=1
```

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

### Create New OpenShift Project

Source: https://www.ibm.com/docs/en/ama/index_topic=migration-how-deploy-your-app-red-hat-openshift-container-platform

Creates a new project (namespace) within the OpenShift cluster. This is necessary if a namespace was not created during the Liberty operator installation.

```shell
oc new-project <OCP_PROJECT>
```

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

### Restore Application Data and Configuration

Source: https://www.ibm.com/docs/en/ama/index_topic=install-upgrading-latest-version

These commands copy existing data, graph data, and Neo4j password from an old location to the new directory. This is crucial for preserving your application's state after a reinstallation.

```shell
cp -a <oldLocation>/data .
cp -a <oldLocation>/graph_data .
cp -a <oldLocation>/scripts/.neo4j_pass scripts/
```

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

### Copy Binary Scanner to Application Location

Source: https://www.ibm.com/docs/en/ama/index_topic=accelerator-collecting-websphere-liberty-open-liberty

Copies the installed binary scanner JAR file to the application directory. This is a prerequisite for running the scanner against application binaries.

```bash
cp /path/to/binaryAppScanner.jar .
```

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

### Verify Downloaded CASE Version

Source: https://www.ibm.com/docs/en/ama/index_topic=ocp-air-gap-install

Lists all downloaded CASE packages and their versions, allowing verification that the correct version of the Application Modernization Accelerator CASE has been downloaded.

```bash
oc ibm-pak list --downloaded
```

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

### Configure Box OAuth

Source: https://www.ibm.com/docs/en/ama/index_topic=configuring-application-modernization-accelerator

Example configuration for Box OAuth within the `thirdparty` configuration object. This covers endpoints for identity, token requests, and token verification.

```configuration
description: "box"
identityRequestEndpoint: "https://account.box.com"
identityRequestEndpointPath: "/api/oauth2/authorize"
identityRequestEndpointScope: "root_readonly"
identityRequestEndpointStatePrefix: ""
tokenRequestEndpoint: "https://api.box.com"
tokenRequestEndpointPath: "/oauth2/token"
tokenVerificationEndpoint: "https://api.box.com"
tokenVerificationEndpointPath: "/2.0/users/me"
```

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

### Configure GitHub OAuth

Source: https://www.ibm.com/docs/en/ama/index_topic=configuring-application-modernization-accelerator

Example configuration for GitHub OAuth within the `thirdparty` configuration object. This includes endpoints for identity, token requests, and token verification.

```configuration
description: "github"
identityRequestEndpoint: "https://github.com"
identityRequestEndpointPath: "/login/oauth/authorize"
identityRequestEndpointScope: "openid+offline"
identityRequestEndpointStatePrefix: ""
tokenRequestEndpoint: "https://github.com"
tokenRequestEndpointPath: "/login/oauth/access_token"
tokenVerificationEndpoint: "https://api.github.com"
tokenVerificationEndpointPath: "/user"
```
Tokens:
Raw