IBM Maximo Visual Inspection

IBM Maximo Visual Inspection is a machine-learning application for video and image analysis. IBM Maximo Visual Inspection offers built-in deep learning models that learn to analyze images and video streams for classification and object detection.

Overview

IBM Maximo Visual Inspection includes tools and interfaces for anyone with limited skills in deep learning technologies. You can use IBM Maximo Visual Inspection to label images and videos that can be used to train and manage a model. The model can then be validated and deployed in customized solutions that demand image classification and object detection.

IBM Maximo Visual Inspection is available from the suite catalog or directly at the following URL:
https://<workspace_id>.visualinspection.<mas_domain>

For more information, see the IBM Maximo Visual Inspection documentation.

Deploy IBM Maximo Visual Inspection

By deploying and activating the Maximo Visual Inspection application, you make it available for use in Maximo Application Suite.

The following steps are specific to the Maximo Visual Inspection application and are part of the overarching application deployment process. You must complete the pre-deployment, deployment, and post-deployment steps before you activate the application. By default, the application is not available to any users until it is activated and you grant users access.

Pre deployment

Before you deploy Maximo Visual Inspection, you must create and apply YAML files. These files contain information that relates to security constraints and access permissions, such as cluster roles and cluster role bindings. Applying these files ensures that you can view important information in the Maximo Visual Inspection user interface, such as graphical processing unit (GPU) usage statistics.

Creating and applying YAML files

To create and apply the YAML files that relate to security constraints, cluster roles, and cluster role bindings, complete the following steps in a command shell on your OpenShift cluster:

Use the oc login command to connect as the cluster administrator.

Create a file that is called customscc.yaml and populate it with the following text:

allowHostDirVolumePlugin: false
allowHostIPC: false
allowHostNetwork: false
allowHostPID: false
allowHostPorts: false
allowPrivilegeEscalation: false
allowPrivilegedContainer: false
allowedCapabilities:
- CHOWN
- DAC_OVERRIDE
- FOWNER
- FSETID
- KILL
- SETGID
- SETUID
- SETPCAP
- NET_BIND_SERVICE
- NET_RAW
- SYS_CHROOT
allowedUnsafeSysctls: null
apiVersion: security.openshift.io/v1
defaultAddCapabilities: null
fsGroup:
  type: MustRunAs
  ranges:
  - max: 65535
    min: 1
groups: []
kind: SecurityContextConstraints
metadata:
  annotations:
    kubernetes.io/description: "This policy is the most restrictive for IBM Maximo Visual Inspection." 
  name: ibm-mas-visualinspection-scc
readOnlyRootFilesystem: false
requiredDropCapabilities: 
- ALL
runAsUser:
  type: MustRunAsRange
  uidRangeMax: 65535
  uidRangeMin: 0
seLinuxContext:
  type: RunAsAny
seccompProfiles: null
supplementalGroups:
  type: MustRunAs
  ranges:
  - max: 65535
    min: 1
users: []
volumes:
- configMap
- downwardAPI
- emptyDir
- persistentVolumeClaim
- projected
- secret

Go to the Maximo Visual Inspection project by taking the following steps:
a. To view the list of projects that you can access, run the following command: oc get projects
b. Identify the Maximo Visual Inspection project in the list and run the following command to go to the project: oc project <MVI_project_name>

Create a file that is called clusterrole.yaml and populate it with the following text:

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: ibm-mas-visualinspection-clusterrole
rules:
- apiGroups:
  - 'security.openshift.io'
  resources:
  - 'securitycontextconstraints'
  resourceNames:
  - 'ibm-mas-visualinspection-scc'
  verbs:
  - use
- apiGroups:
  - ""
  resources:
  - nodes
  - pods
  verbs:
  - list
- apiGroups:
  - ""
  resources:
  - persistentvolumes
  verbs:
  - get
  - list
  - update
  - watch

Run the following command to retrieve the namespace that is associated with the Maximo Visual Inspection project that you retrieved earlier: oc get namespace|grep <MVI_project_name>

Create a file that is called clusterrole_binding.yaml and populate it with the following text, including the namespace that you retrieved in the previous step:

kind: ClusterRoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
 name: ibm-mas-visualinspection-clusterrolebinding
subjects:
- kind: ServiceAccount
  name: ibm-mas-visualinspection-operator
  namespace: <MVI_deployment_namespace>
roleRef:
  kind: ClusterRole
  name: ibm-mas-visualinspection-clusterrole
  apiGroup: rbac.authorization.k8s.io

Run the following commands to apply the files that you created:

oc apply -f customscc.yaml
oc apply -f clusterrole.yaml
oc apply -f clusterrole_binding.yaml

Deploying Maximo Visual Inspection

As part of deploying Maximo Visual Inspection, you must specify configuration details for the persistent volume claim (PVC) that is created automatically when you complete deployment. The following deployment steps are completed in Maximo Application Suite.

On the Suite administration catalog page, click the Visual Inspection card.
Optional: Select the number of IBM Maximo Visual Inspection Edge licenses that you want. By using IBM Maximo Visual Inspection Edge, you can call models that were trained in Maximo Visual Inspection to complete inspections from edge devices.
Click Continue. Note: If insufficient AppPoints are available to deploy this application, you can still complete the application configuration. The application automatically deploys when the required number of AppPoints are available.
Select how you want to keep the application up to date by choosing one of the following options:
- 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 and choose the version that you want to manually deploy. If you want to deploy Maximo Application Suite version 8.5.0, complete the remaining steps in this procedure. If you want to deploy an earlier version, complete the deployment steps for that version.
Optional: On the Deploy application page, configure the IBM Maximo Visual Inspection Edge add-on. For more information, see the Configure Visual Inspection Edge topic.
On the Deploy application page, click Show advanced settings, and then turn off the System managed toggle.
Specify the following details for the PVC that is created automatically when you deploy Maximo Visual Inspection:
- A storage class that supports the ReadWriteMany access mode and is supported by your cloud vendor.
  - If the storage class that you specify does not support ReadWriteMany access mode, or the class name does not exactly match an available OpenShift storage class name, the deployment fails.
  - The default storage class is ibmc-file-gold, which is suitable for deployments to IBM Cloud, but might not be supported by other cloud vendors.
  - To see a list of available storage classes, use the following command in the OpenShift console: oc get sc
- The required storage size. For example, to specify 100 gibibytes of storage, which is the recommended minimum, enter 100Gi.
Apply the changes and begin the deployment.

From the application's Overview tab, you can monitor the deployment status. If the deployment fails, delete and redeploy the application. Deployment is complete when the "Application -> Ready" card displays a green checkmark and the Activate button is displayed.

Post deployment

The Maximo Visual Inspection application requires no post deployment steps.

Activating Maximo Visual Inspection

A deployed application is not immediately available. Before you can grant users access and start working with the application, you must activate the application. You can activate the application after the deployment is complete.

To activate an application, from the application's Overview tab, click Activate. If the application deployment is not complete, the Activate button is disabled.

Activated applications are available from the suite catalog and at fixed URLs.

Note: Activating the application does not automatically grant your users access to the application.

Post activation

After you deploy and activate Maximo Visual Inspection, you can complete the following tasks:

Set up version 1.8 of the GPU operator in Openshift.
Grant users access to Maximo Visual Inspection.
Train and work with models.
Optional: Configure the IBM® Maximo® Visual Inspection Edge add-on.

For other getting started steps in Maximo Visual Inspection, review the Maximo Visual Inspection Getting Started steps.

Setting up version 1.8 of the GPU operator in Openshift

Maximo Visual Inspection relies on graphical processing units (GPUs) for creating and running models. GPUs enable Maximo Visual Inspection and other workloads to complete deep learning tasks such as model training, model validation, or model inference. You can add GPUs to nodes within your Kubernetes deployments and schedule GPUs in a similar way to how you schedule CPU, memory, or storage.

Note: You can set up a GPU-accelerated node before or after deployment.

Maximo Visual Inspection uses NVIDIA GPUs. For more information about hardware requirements, see "Application-specific requirements" in Maximo Application Suite system requirements.

IBM®, Red Hat®, and NVIDIA support GPUs for workloads like Maximo Visual Inspection. Both Red Hat® OpenShift® and the NVIDIA GPU must be configured correctly.

For more information about configuring the NVIDIA GPU Operator in OpenShift, see the NVIDIA documentation

Note: OpenShift 3.x is not supported.

Granting users access to Maximo Visual Inspection

Activating the application makes it available but does not automatically grant your users access to the application. Administrators who have user management administration rights can grant users access to the application. Maximo Visual Inspection users require premium entitlement.

Training and working with models.

As an application administrator, train and work with models.

Configuring the IBM® Maximo® Visual Inspection Edge add-on

Optionally, you can configure the IBM® Maximo® Visual Inspection Edge add-on. For more information, see the Configure Visual Inspection Edge topic.

Update Maximo Visual Inspection

If you have Maximo Visual Inspection version 8.4.0 or any earlier version, you cannot update to Maximo Visual Inspection version 8.5.0. To get Maximo Visual Inspection version 8.5.0, complete the following steps:

Back up your data.
Delete the earlier version of Maximo Visual Inspection.
Install Maximo Visual Inspection version 8.5.0.
Import your data.

Administer applications