Before you install an app

Before you install an app, review the information provided here.

The details for each of the following items are provided in the installation and configuration procedures:
  • Verify that there is at least one Edge Gateway available. The Edge Gateway must be configured before you can run any apps. If configured, you can see the Edge Gateway listed in the Apps tab. If no Edge Gateway is listed or if the status is not online, see your administrator or the Edge Gateway Deployment Guide.
    Note: You can install an app without an available Edge Gateway, but you cannot configure and run it.
  • Each app must be associated with a single Edge Gateway. If you have multiple Edge Gateways, you need to know your organization's policy as to which Edge Gateway to use for each app. For example, if your organization uses a private repository for custom apps that are not available in the default repository, quay.io, you need to associate that app to the Edge Gateway configured for that repository.
  • Make sure you have access to apps. This can be access to the IBM Security App Exchange or to a location in your environment where apps have been downloaded.
  • If you have an integration server in your environment that is used to deploy apps, it is important that you do not run the same app in the integration server and from an Edge Gateway. The same app deployed using the Apps tab and deployed from the integration server can cause conflicts and unexpected behavior. If you install an app that is already running on an integration server, remove the app from the integration server (using the pip uninstall command).
    Note: You can download apps that support the Edge Gateway Kubernetes-based container environment. The Orchestration & Automation application prevents you from installing non-container-based apps.
  • After installing an app, you might need to define specific variables in the app's configuration file, called app.config. The File Annotations field displays the comments and any variables to be defined in the app.config file. Additionally, read the app's documentation to determine what else, if anything, needs to be configured.
  • If an app contains account credentials, such as a user name and password, the credentials are stored in the app.config file by default. Optionally, you can store all passwords in secrets for additional security. A secret contains the password but is stored in the container environment where it is not easily accessible. The secret name is entered in the app.config file instead of the password. By default, the secret for the API key account assigned to the app is also stored in a secret. Edge Gateway must be version 1.3 or later.