### Concert Workflows Setup Usage and Examples

Source: https://www.ibm.com/docs/en/concert/1_topic=workflows-installing-concert-add-vm

This block details the usage of the `setup` command for installing Concert Workflows, including all required and optional parameters. It also provides a practical example of how to set environment variables and run the setup command for a default installation.

```bash
Usage: setup --license-acceptance=y --instance-address=INSTANCE_ADDRESS --concert-user=CONCERT_USER --concert-url=CONCERT_URL --c-api-key=CONCERT_API_KEY [OPTIONS]
    -----
    Installs and configures the IBM Concert Workflows 1.1.5.2 and registers it in the IBM Concert.

    Required Options:
    ------
    --license-acceptance=y                  license acceptance. For license details please check ../licenses/LICENSE   
    --instance-address=INSTANCE_ADDRESS     instance address, long host name (FQDN) of your VM               
    --concert-user=CONCERT_USER             user used to install IBM Concert
    --concert-url=CONCERT_URL               unique URL of your IBM Concert
    --c-api-key=CONCERT_API_KEY             IBM Concert API key

    Optional Options:
    ------
    --namespace=CW_NAMESPACE           target namespace name where IBM Concert Workflows will be deployed (default: concert-workflows)
    --registry=IMAGE_REGISTRY           registry to pull the images from (default: cp.icr.io)
    --registry-user=REGISTRY_USER       user which is used to access the images registry (default value cp)
    --registry-password=REGISTRY_PWD    registry password - if unset then the env variable IBM_REG_PASS is used
    --namespace-faas=FAAS_NAMESPACE     namespace name which will be used by FaaS pods (default: faas)
    --override-values="VALUES_PATH"       path to the values file to override the defaults
    --override-charts="CHART_PATH"        path to the charts archive tgz file to override the Helm repository call
    --upgrade                           force upgrade of existing IBM Concert Workflows installation

    Examples:
    ------
    # 1. default namespace
    export IBM_REG_PASS="<ENTITLEMENT_KEY>"
    
    ./setup --license-acceptance=y --instance-address=my-concert-vm1.fyre.ibm.com --concert-user=ibmconcert --concert-url=https://my-concert-vm1.fyre.ibm.com:12443 --c-api-key=c_api_key_test_123xddxxEXAMPLE123456abcdef
```

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

### Example params.ini Configuration (INI)

Source: https://www.ibm.com/docs/en/concert/2.1_topic=vm-installing

This is an example snippet of the params.ini file, showcasing key-value pairs for configuring installation parameters. It includes settings for container runtime, product installation flags, image registry prefixes, and specific suffixes for different product images. Adjust these values based on your environment and desired installation.

```ini
DOCKER_EXE=<podman|docker>

INSTALL_VM=true
INSTALL_CONCERT=true
IMAGE_REGISTRY_PREFIX=cp.icr.io/cp
HUB_IMAGE_REGISTRY_SUFFIX=/solis-hub
CONCERT_IMAGE_REGISTRY_SUFFIX=/concert

INSTALL_DATAAPPS=true
DATAAPPS_IMAGE_REGISTRY_SUFFIX=/concert

INSTALL_WORKFLOWS=true
WORKFLOWS_IMAGE_REGISTRY_SUFFIX=/concert         
WORKFLOWS_INSTANCE_ADDRESS=hostname.domain.com <FQDN of your VM>
#namespace for Workflows(optional:default will be concert-workflows)
WORKFLOWS_NS=
#For enabling AI feature in workflow
WORKFLOWS_OVERRIDE_VALUES=
```

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

### Example Concert Data Apps Installation

Source: https://www.ibm.com/docs/en/concert/1_topic=apps-installing-concert-data-ocp

Provides a concrete example of the installation script execution for the Concert Data Apps add-on. This demonstrates how to fill in the required parameters like namespace, storage class, Concert URL, and API key.

```shell
./deploy-k8s.sh  \
--namespace=concert1  \
--cfg=sw_ent_native  \
--storage_class=nfs-client  \
--license_acceptance=y  \
--concert_url=https://roja-concert1.apps.concert-op.cp.fyre.ibm.com  \
--customer_api_key=*******
```

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

### Install Concert Backup Service using systemd

Source: https://www.ibm.com/docs/en/concert/2.0_topic=vm-backing-up-restoring-concert-data

Installs and starts the Concert data backup service and timer. This script automates the setup of the backup service, ensuring it runs according to the configured schedule. It requires the `install_backup_service` script to be executed.

```bash
./ibm-concert/ibm-concert-std/systemd/backup/install_backup_service
```

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

### Example: Install Concert Workflows Standalone OCP (Bash)

Source: https://www.ibm.com/docs/en/concert/1_topic=workflows-installing-concert-in-air-gapped-environment

An example command demonstrating the installation of Concert Workflows standalone on OCP in an air-gapped environment with a password-protected private image registry. Includes essential parameters like license acceptance and instance address.

```bash
./deploy-k8s-standalone \
--license-acceptance=y \
--standalone \
--instance-address=${SCW_ROUTE}
--registry=IMAGE_REGISTRY
--registry-user=REGISTRY_USER
--registry-password=REGISTRY_PWD
```

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

### Run Concert Workflows Setup Script

Source: https://www.ibm.com/docs/en/concert/2.0_topic=dcwv-installing-concert-workflows-in-air-gapped-environment-vm

Execute the `setup` script to prepare your machine for Concert Workflows deployment. This script requires accepting the license agreement and providing user credentials for installation. Ensure the INSTALL_DIR variable points to the correct installation directory.

```bash
$INSTALL_DIR/bin/setup --license_acceptance=y --username=<user> --password=<password>
```

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

### Initialize IBM Concert Setup Script

Source: https://www.ibm.com/docs/en/concert/1_topic=vm-installing-concert-software

Runs the IBM Concert setup script to prepare the machine for installation. Requires license acceptance and configuration of registry and runtime. The `--tag` option is only needed for version 1.0.0.

```bash
ibm-concert-std/bin/setup --license_acceptance=y --registry=${CONCERT_REGISTRY} --runtime=${DOCKER_EXE} --username=ibmconcert --password
```

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

### Copy Kubernetes Quickstart Parameters File

Source: https://www.ibm.com/docs/en/concert/2.0_topic=cluster-installing-concert-workflows-ocp

Copies the sample parameters file for Kubernetes quickstart deployment to be used as the main params.ini file. This file contains essential variables for the installation script.

```Shell
cp $INSTALL_DIR/etc/sample-params/workflows-quickstart-k8s-params.ini $INSTALL_DIR/etc/params.ini
```

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

### Install Concert Backup Service using systemd

Source: https://www.ibm.com/docs/en/concert/1_topic=vm-backing-up-restoring-concert-data

Installs and starts the Concert data backup service and timer. Requires replacing a placeholder and running the install_backup_service script. Changes to the service file necessitate rerunning this script.

```bash
./ibm-concert-std/systemd/backup/install_backup_service

```

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

### Example params.ini Configuration for IBM Concert Installation

Source: https://www.ibm.com/docs/en/concert/2.1_topic=kubernetes-installing-upgrading-in-air-gapped-environment

This is an example configuration snippet from a `params.ini` file used for installing IBM Concert, Data Apps, and Workflows on a Kubernetes cluster. It defines parameters such as image registry prefixes, namespaces, scale configurations, and storage classes. These settings are environment-specific and essential for a successful deployment.

```ini
# INSTALL_EKS: Set as True if installing on EKS
INSTALL_EKS=
# This example is to install Hub, Concert, Data Apps and Workflows on a Kubernetes cluster.
REG_USER=cp

IMAGE_REGISTRY_PREFIX=<private-registry-url>/cp


# The parameters are for Hub deployment.
#namespace for Hub
HUB_NS=
HUB_IMAGE_REGISTRY_SUFFIX=/solis-hub
SCALE_CONFIG_HUB=level_1
# storage class for Hub
STORAGE_CLASS_HUB=

# The parameters are for Concert deployment.
INSTALL_CONCERT=true
# namespace for Concert
CONCERT_NS=
CONCERT_IMAGE_REGISTRY_SUFFIX=/concert
SCALE_CONFIG_CONCERT=level_1
#storage class for Concert
STORAGE_CLASS_CONCERT=

# The parameters are for DataApps deployment.
INSTALL_DATAAPPS=true
# namespace for Data Apps
DATAAPPS_NS=
DATAAPPS_IMAGE_REGISTRY_SUFFIX=/concert
SCALE_CONFIG_DATAAPPS=level_1
#storage class for Dataapps
STORAGE_CLASS_DATAAPPS=

# The parameters are for Workflows deployment.
INSTALL_WORKFLOWS=true
#namespace for Workflows
WORKFLOWS_NS=
WORKFLOWS_IMAGE_REGISTRY_SUFFIX=/concert  
```

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

### Run Concert Setup Script

Source: https://www.ibm.com/docs/en/concert/2.0_topic=dccwtv-installing-concert-concert-workflows-in-air-gapped-environment-without-image-registry

Executes the `setup` script for IBM Concert and Concert Workflows, accepting the license, specifying user credentials, and providing the registry password. This prepares the machine for deployment.

```shell
./ibm-concert/bin/setup --license_acceptance=y --username=<user> --password=<password> --registry_password=${IBM_REGISTRY_PASSWORD}
```

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

### Run IBM Concert Data Apps Setup Script

Source: https://www.ibm.com/docs/en/concert/2.0_topic=cluster-installing-concert-data-apps-ocp-without-cpfs

Executes the setup script for Concert Data Apps deployment on a VM. This script requires acceptance of the license agreement and specifies user credentials for the installation. It also integrates with the IBM registry password.

```bash
$INSTALL_DIR/bin/setup --license_acceptance=y --username=<user> --password=<password> --registry_password=${IBM_REGISTRY_PASSWORD}
```

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

### deploy-k8s Installation Options

Source: https://www.ibm.com/docs/en/concert/1_topic=workflows-installing-concert-add-ocp

Provides a detailed usage guide for the `deploy-k8s` script, outlining required and optional parameters for installing and configuring IBM Concert Workflows. This includes options for license acceptance, instance address, user credentials, API keys, and namespace configuration.

```shell
Usage: deploy-k8s --license-acceptance=y --instance-address=CW_ROUTE --concert-user=CONCERT_USER --concert-url=CONCERT_URL --c-api-key=CONCERT_API_KEY [OPTIONS]
    -----
    Installs and configures the IBM Concert Workflows 1.1.5.2 and registers it in the IBM Concert.

    Required Options:
    ------
    --license-acceptance=y                  license acceptance. For license details please check ../licenses/LICENSE   
    --instance-address=CW_ROUTE             route name to IBM Concert Workflows application               
    --concert-user=CONCERT_USER             user used to install IBM Concert
    --concert-url=CONCERT_URL               unique URL of your IBM Concert
    --c-api-key=CONCERT_API_KEY             IBM Concert API key

    Optional Options:
    ------
    --namespace=CW_NAMESPACE            target namespace name where IBM Concert Workflows will be deployed (default: concert-workflows)
    --registry=IMAGE_REGISTRY           registry to pull the images from (default: cp.icr.io)
    --registry-user=REGISTRY_USER       user which is used to access the images registry (default value cp)
    --registry-password=REGISTRY_PWD    registry password - if unset then the env variable IBM_REG_PASS is used
```

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

### Setup Installation Script for IBM Concert

Source: https://www.ibm.com/docs/en/concert/2.0_topic=dccwcdak-installing-concert-concert-workflows-concert-data-apps-ocp

This command executes the installation setup script for IBM Concert. It requires acceptance of the license, username, password, and registry entitlement key as parameters. The INSTALL_DIR variable should point to the installation directory.

```bash
$INSTALL_DIR/bin/setup --license_acceptance=y --username=<user> --password=<password> --registry_password=<registry_entitlement_key>
```

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

### Install IBM Concert Workflows Setup Script

Source: https://www.ibm.com/docs/en/concert/2.0_topic=kubernetes-installing-concert-concert-workflows-eks

This snippet shows how to run the installation setup script for IBM Concert Workflows. It requires setting environment variables for user credentials and registry passwords, and accepts license acceptance. The script installs the software with the provided configuration.

```shell
export CONCERT_USER="admin"
export CONCERT_PASSWORD=<concert-password>
export IBM_REGISTRY_PASSWORD=<ibm-registry-password>
$INSTALL_DIR/bin/setup --license_acceptance=y --username=${CONCERT_USER} --password=${CONCERT_PASSWORD} --registry_password=${IBM_REGISTRY_PASSWORD}
```

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

### Disable NM Cloud Setup and Install Kernel Modules (Bash)

Source: https://www.ibm.com/docs/en/concert/2.1_topic=vm-installing

Disables the NM Cloud Setup service and timer, installs the `kernel-modules-extra` and `vim` packages, and reboots the system. This is a prerequisite for ensuring proper operation on RHEL 10.

```bash
sudo su -
systemctl disable nm-cloud-setup.service nm-cloud-setup.timer
dnf install -y kernel-modules-extra
dnf install -y vim
systemctl reboot
```

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

### Example `params.ini` Configuration

Source: https://www.ibm.com/docs/en/concert/2.0_topic=cluster-upgrading-concert-workflows-ocp

Provides an example of a partially filled `params.ini` file, demonstrating how to set key parameters for the Hub and Workflows components. This includes registry details, namespaces, and scaling configurations.

```ini
# INSTALL_EKS: Set as True if installing on EKS
INSTALL_EKS=false
# This example is to install Hub, Concert, Data Apps and Workflows on a Kubernetes cluster.
REG_USER=cp

IMAGE_REGISTRY_PREFIX=cp.icr.io/cp


# The parameters are for Hub deployment.
#namespace for Hub
HUB_NS=[PROVIDE SOLIS HUB NAMESPACE]
HUB_IMAGE_REGISTRY_SUFFIX=/solis-hub
SCALE_CONFIG_HUB=level_1

```

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

### Run Concert Data Apps Setup Script

Source: https://www.ibm.com/docs/en/concert/1_topic=apps-installing-concert-data-vm

Executes the setup script for Concert Data Apps. Requires license acceptance and configuration of registry, runtime, Concert URL, and API key. The log file is saved in the local storage directory.

```bash
./ibm-dataapps-std/bin/setup \
--license_acceptance=y \
--registry=${CONCERT_REGISTRY} \
--runtime=${DOCKER_EXE} \
--concert_url=<CONCERT_URL> \
--customer_api_key=<CONCERT_API_KEY>
```

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

### Run IBM Concert Setup Script

Source: https://www.ibm.com/docs/en/concert/2.0_topic=cluster-installing-concert-in-air-gapped-environment-kubernetes

Executes the 'bin/setup' script to prepare the machine for IBM Concert deployment on an OCP cluster. Requires acceptance of license, username, password, and registry password (entitlement key).

```bash
$INSTALL_DIR/bin/setup --license_acceptance=y --username=<user> --password=<password> --registry_password=<your_entitlement_key>
```

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

### VM Configuration Example

Source: https://www.ibm.com/docs/en/concert/2.1_topic=clusters-discovering-java-applications-vm

Provides examples of VM configurations for an IBM EN Concert workflow. It shows how to specify target hosts, credentials, whether to use Concert vault, SSH port, and Apache Tomcat settings (file-based or manual configuration).

```json
[
    {
        "target": "test1.ibm.com",
        "cred": "ibmconcert/ubuntu_service_account",
        "isConcertVault": true,
        "port": 22,

        "tomcat": {
            "fileBased": true
        }
    },{
        "target": "test2.ibm.com",
        "cred": "ibmconcert/rhel_service_account",
        "isConcertVault": true,
        "port": 22,

        "tomcat": {
            "fileBased": false,
            "username": "manager",
            "password": "manager",
            "port": "8080"
        }
    }
]
```

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

### Retrieve Concert Instance Details

Source: https://www.ibm.com/docs/en/concert/1_topic=environment-installing-concert-software-cpfs-managed-ocp

Fetches and displays the details of the installed Concert instance. This command is used after the installation and setup process is complete to verify the deployment and obtain configuration information.

```bash
./ibm-concert-manage.sh get-concert-instance-details
```

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

### Copy Sample Configuration File for IBM Concert

Source: https://www.ibm.com/docs/en/concert/2.0_topic=cluster-installing-concert-in-air-gapped-environment-kubernetes

Copies the sample parameters file 'concert-k8s-quick-start-params.ini' to 'params.ini' within the installation directory's configuration path. This file is essential for configuring the Concert deployment.

```bash
cp $INSTALL_DIR/etc/sample-params/concert-k8s-quick-start-params.ini $INSTALL_DIR/etc/params.ini
```

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

### Example params.ini Configuration

Source: https://www.ibm.com/docs/en/concert/2.0_topic=kubernetes-installing-concert-concert-workflows-eks

Illustrates key-value pairs within the `params.ini` file used for configuring Concert Workflows installation on EKS. This file defines parameters such as installation flags, namespaces, image registries, and storage classes.

```ini
# INSTALL_EKS: Set as True if installing on EKS
INSTALL_EKS=
# This example is to install Hub, Concert, Data Apps and Workflows on a Kubernetes cluster.
REG_USER=cp

IMAGE_REGISTRY_PREFIX=cp.stg.icr.io/cp


# The parameters are for Hub deployment.
#namespace for Hub
HUB_NS=
HUB_IMAGE_REGISTRY_SUFFIX=/solis-hub
SCALE_CONFIG_HUB=level_1
# storage class for Hub
STORAGE_CLASS_HUB=

# The parameters are for Concert deployment.
INSTALL_CONCERT=true
# namespace for Concert
CONCERT_NS=
CONCERT_IMAGE_REGISTRY_SUFFIX=/concert
SCALE_CONFIG_CONCERT=level_1
#storage class for Concert
STORAGE_CLASS_CONCERT=


# The parameters are for Workflows deployment.
INSTALL_WORKFLOWS=true
#namespace for Workflows
WORKFLOWS_NS=
WORKFLOWS_IMAGE_REGISTRY_SUFFIX=/concert 

```

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

### Configure Installation Parameters in params.ini

Source: https://www.ibm.com/docs/en/concert/2.0_topic=vm-installing-concert-concert-data-apps

Illustrates key-value pairs within the `params.ini` file that configure the installation, such as container runtime, registry details, and installation flags for Concert and Data Apps.

```properties
DOCKER_EXE=<podman|docker>

INSTALL_VM=true
INSTALL_CONCERT=true
IMAGE_REGISTRY_PREFIX=cp.icr.io/cp
HUB_IMAGE_REGISTRY_SUFFIX=/solis-hub
CONCERT_IMAGE_REGISTRY_SUFFIX=/concert

INSTALL_DATAAPPS=true
DATAAPPS_IMAGE_REGISTRY_SUFFIX=/concert
```

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

### Install OS Utilities for Private Registry (Bash)

Source: https://www.ibm.com/docs/en/concert/2.1_topic=kubernetes-installing-upgrading-in-air-gapped-environment

Installs necessary operating system utilities required for setting up a private Docker registry. This command is typically run on a Linux-based system before executing registry setup scripts.

```bash
yum install -y httpd-tools ca-certificates bind-utils
```

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

### Copy Sample Configuration for Concert Data Apps VM

Source: https://www.ibm.com/docs/en/concert/2.0_topic=vm-installing-concert-data-apps

Copies the sample `params.ini` file for a quick-start VM deployment to the main configuration file location. This file contains essential parameters for the installation. Overwrite confirmation may be required.

```bash
cp $INSTALL_DIR/etc/sample-params/dataapps-vm-quick-start-params.ini $INSTALL_DIR/etc/params.ini
```