Installing and uninstalling

Before you begin

Before you can install Maximo Visual Inspection Edge, you must ensure that your environment meets the platform, hardware, and software requirements, and that Docker and nvidia-docker2 are installed. For more information on the required platform, hardware, and software, see Planning for Maximo Visual Inspection Edge . The Installing Docker topic contains the instructions to install Docker and nvidia-docker2.

Installing

Complete the following steps to install Maximo Visual Inspection Edge:

1. On your file system, identify where you want to install Maximo Visual Inspection Edge, for example /apps.
2. In the identified location, create a directory. The final directory in the installation path is the installation root directory and must be called vision-edge, for example, /apps/vision-edge. The following instructions use <installation root directory> for this directory.
3. Log in to the repository where you want to download images from, which can be a custom repository or the IBM Cloud® repository. For example, to log into the IBM Cloud repository, run the sudo docker login cp.icr.io command and provide your username and API key. In the following instructions, <docker image repository> refers to the location of the repository that you download Docker images from.
4. Create the required directories and files by running the following command:

   sudo docker run --rm -v <installation root directory>:/opt/ibm/vision-edge -e hostname=$(hostname -f) --privileged -u root <docker image repository>/vision-edge-inception:<release version>

   This command creates the installation root directory and the required sub-directories, templates, properties files, and scripts, including the startedge.sh startup script. For example, to install release 8.4.0 of Maximo Visual Inspection Edge into the /apps/vision-edge directory by using the IBM Cloud Docker image repository, run the following command:

   sudo docker run --rm -v /apps/vision-edge:/opt/ibm/vision-edge -e hostname=$(hostname -f) --privileged -u root cp.icr.io/cp/visualinspection/vision-edge-inception:8.4.0

5. If you want to download Docker images from a custom image repository, edit the <installation root directory>/volume/run/var/config/vision-edge.properties file and update the PULL_REPO property with the location of the custom repository, for example, PULL_REPO=mydockerrepo.com
6. Start the application by running the following command:

   sudo <installation root directory>/startedge.sh

   Accept the license agreement. The startup script generates a self-signed certificate for the server, initializes the database, and starts the controller, CME, and DLE Docker containers. Note: The script also generates a password for the administration user, which is masadmin, and displays this password at the end of the script output. Record the password so that you can log in to the application. The application is now ready for use.

Uninstalling

Complete the following steps to uninstall Maximo Visual Inspection Edge:

1. Remove the service containers by running the following command:

   docker rm -f vision-edge-controller vision-edge-cme vision-edge-dle

   This command also stops any locally deployed models.
2. Remove the root installation directory. For example, if the application is installed in the /opt/ibm/vision-edge directory, run the following command:

   rm -rf /opt/ibm/vision-edge

3. To recover disk space, run the docker rmi command, which removes the deployed Docker images for the current release. For example, to remove all deployed images for the 8.4.0 release, run the following command:

   for deploy_img in $(docker images --format '{{.Repository}}:{{.Tag}}' | egrep 'vision-edge-[a-z]+:8.4.0') ; do echo ${deploy_img} ; echo "Purged image ${deploy_img}." ; done