Maximo Application Suite
Customer-managed

Deploying

By deploying and activating the application, you make it available for use in .

Before you begin

Before you deploy , ensure that the following dependencies are prepared and available for use:
  1. Install
  2. Install on .
S3 Compatible Object Storage

supports the S3 Compatible Object Storage and ensures that you have the S3 Compatible object Storage that is prepared and setup for deployment.

For example, you can use , AWS object storage, Ceph® Object Storage on 4 cluster with Rook-ceph Operator or Container Storage operator.

Note: If you choose to use Container Storage, ensure that you have its independent entitlement separate from .

For more information, see Container Storage 4.5 installation with Object Storage Gateway.

After you install Ceph Object Storage, create an S3 user account and get the access key and secret access key of this user account.

Show the Ceph Object Storage endpoint by creating an route for rook-ceph-rgw service by setting tls.termination as edge and getting the route host for Ceph Object Storage.

About this task

The following steps are specific to the application and are part of the overarching application deployment process. You must complete the predeployment and deployment steps before you activate the application, and then you must complete the post-activation steps. By default, the application is not available to any users until you activate the application and then grant users access.

Beginning with 8.2, CouchDB is embedded and automatically deployed with . You do not have to manually install it.
Configuration parameters

The following parameters are configurable:

  • URL, for example, https://<mycouchdb>.<mydomain.com>
  • Username
  • Password
Required by
  • at the Application scope.

Procedure

  1. In the Suite catalog, on the Applications tab, click the Assist tile.
    On the catalog, verify the information. Click Continue.
    Note: If there are insufficient AppPoints available to deploy this application, you can still click Continue to complete the application configuration. The application automatically deploys when the required number of AppPoints are available.
    For more information, see Upgrade methods.
  2. Select how you want to keep the application up to date:
    • Click Channel subscription to subscribe to the upgrade channel. When new versions become available, they are added to the channel and updated in your suite instance either automatically or after manual approval. If you want to manually approve upgrades, turn off the Automatic approval toggle.
    • Click Manual to manually select the upgrades that you want to install, then choose Deploy <version_number>.
    Attention: From 8.10, the manual deployment for applications and using installation script for are discontinued. To upgrade and its applications, you must run a conversion script to use a subscription method, and subscribe to the latest channel. For more information, see Converting from manual deployment to channel subscription.
    1. Select an update method.
      Turn the Automatic approval option to On to subscribe to automatic updates. When new application updates are available, they are added to the channel and updated in your instance automatically.
      Turn the Automatic approval option to Off to subscribe to manual updates. When new application updates are available, you receive a notification, and you can manually approve the updates.
    2. Subscribe to a channel by selecting a version from the drop-down list.
      For example, select 8.x.x or 8.x channel.
    3. Click Subscibe to channel <version>.
  3. On the Object storage tile, in the Dependencies section, select Configure and enter the object storage information for your prepared Ceph Object Storage.
    1. Enter the Ceph Object Storage S3 route URL, for example https://ceph-s3-rook-ceph.apps.test.os.yourcompany.com. Or, the AWS S3 URL, for example https://s3.{region}.amazonaws.com
    2. Enter the username, which is the S3-compatible ceph object storage access Key ID.
      To create an AWS S3 account, complete the following steps:
      1. Log in to the AWS console, for example at https://us-east-1.console.aws.amazon.com/.
      2. Select Service > IAM > User.
      3. In the User page, select the Security credentials tab.
      4. Click Create access key to generate an S3 Access key ID and Secret access key.
    3. Enter the password, which is the S3-compatible ceph object storage secret key.
    4. Optionally, upload a certificate.
  4. Click Show advanced settings to configure Apache CouchDB and Redis.
    CouchDB
    By default, embeds CouchDB when it is deployed. You can specify the following parameters:
    • Replica - The default value is 3.
    • Storage class - The Apache CouchDB Storage Class that can be used from the . For example, use the existing ocs-storagecluster-cephfs or portworx-couchdb-sc storage class in the cluster.
    • Storage Size - Storage size for CouchDB, for example, 20 Gi.
    Redis Server
    You can specify the following parameters:
    • Storage Size - Enter the expected disk size. The disk size must be 30 Gi or more.
    • Storage Class - Enter an existing storage class from the cluster. The storage class can be used to dynamically provision a persistent volume with access mode RWO, for example, "ocs-storagecluster-cephfs", as the storage class name for the embedded Redis server for .
  5. Click Deploy and then Begin deployment. The estimated time and configuration time that are listed represent the estimated time that it takes to configure and deploy the application. The times include both front-end configuration work and back-end processing and configuration. You can track the deployment process on the details page.
  6. Validate the deployment from the deployment status on the Assist Details page.
    You can also check the Assist Deployment Status by using the client command line to log in to your cluster
    oc login <OCP_cluster> 
    
    oc get assistapp -n {{Assist_project}}
    NAME         VERSION            STATUS   AGE
    masdev       8.5.0              Ready    73d
    
    The Assist operator uses the Ready condition reason code of the CR to indicate progress. The following reason codes are used:
    Ready
    The Assist app/workspace/backup/restore Operator CR is up to date and ready to use.
    InvalidConfiguration
    One or more configuration are not available or incorrect, refer to fail message for details.
    AssistTooOld
    Migration install of the existing Assist is not supported.
    AssistorCouchDBNotReady
    Assist is not ready or No embedded CouchDB for Backup/Restore.
    CertificateNotReady
    Certificates Secret is not yet available.
    Note:

    Horizontal Pod Autoscale (HPA) is enabled by default during the Assist deployment, and based on the resource (CPU and Memory) utilization for assist pods. Assist automatically scales in or out the internal components.

    If you want to manually scale in or out your pods numbers for each deployment, you need to disable HPA by setting the settings.common.podautoscale to false in the AssistApp CR Spec.

What to do next

Activate . For more information, see Activating.