Installing IEAM
Follow the steps in this section to deploy the following components:
- IBM Cloud Platform Common Services.
- IBM Edge Application Manager Management Hub operator.
- IBM Edge Application Manager exchange API.
- IBM Edge Application Manager agbot.
- IBM Edge Application Manager Cloud Sync Service (CSS).
- IBM Edge Application Manager Secure Device Onboarding (SDO).
- IBM Edge Application Manager Secrets manager (Vault).
- IBM Edge Application Manager user interface.
You must install and configure a management hub before you start the IBM Edge Application Manager (IEAM) node tasks.
Upgrading IEAM
If you are upgrading from a previous version, see Upgrades.
Before you begin
Ensure that you have an appropriately sized and supported Red Hat® OpenShift® Container Platform installation, including an appropriate storage class installed and working in your cluster.
For more information about:
-
Provisioning an IBM Cloud managed OpenShift Container Platform cluster, see Red Hat® OpenShift® Container Platform on IBM® Cloud.
-
Creating your own managed OpenShift Container Platform cluster, see OpenShift Container Platform Documentation.
Browser installation process
Notes:
-
By default, a local development secrets manager and development databases are provisioned as part of operator deployment. For more information about connecting to your own provisioned databases and other configuration options, see Configuration.
-
You are responsible for backing up and restoring all persistent data; see backup and recovery.
Complete the following steps to install IEAM:
-
Log in through the OpenShift Container Platform UI with cluster admin privileges.
-
Click Storage to navigate to the Storage Classes page and confirm that a supported default storage class is defined. For example, ibmc-block-gold.
For more information about using a non-default storage class, see [Configure IEAM](configuration.html).
-
Create the IBM Operator Catalog Source, which provides the capability to install the IEAM Management Hub bundle.
-
Select (+) Import YAML to import, then copy and paste the following into the editor:
apiVersion: operators.coreos.com/v1alpha1 kind: CatalogSource metadata: name: ibm-operator-catalog namespace: openshift-marketplace spec: displayName: ibm-operator-catalog publisher: IBM Content sourceType: grpc image: icr.io/cpopen/ibm-operator-catalog updateStrategy: registryPoll: interval: 45m
-
Click Create.
-
-
Create the IBM Common Services Operator Catalog Source, which provides the suite of Common Service operators that IEAM Management Hub also installs.
-
Select (+) Import YAML to import, then copy and paste the following into the editor:
apiVersion: operators.coreos.com/v1alpha1 kind: CatalogSource metadata: name: opencloud-operators namespace: openshift-marketplace spec: displayName: IBMCS Operators publisher: IBM sourceType: grpc image: quay.io/opencloudio/ibm-common-service-catalog:latest updateStrategy: registryPoll: interval: 45m
-
Click Create.
-
-
Click Projects and complete the Create Project fields to create the project where you want to install the operator; for example, Name=ibm-edge, which is a default namespace often referenced in IEAM documentation.
-
Define an image pull secret called ibm-entitlement-key to authenticate to the IBM Entitled Registry.
Note: Ensure that this resource is created in the same project that was created in the previous step.
-
Click Workloads, then Secrets. From the Create drop-down, select Image Pull Secret.
-
Complete these required fields, fill in Password with your My IBM Key.
- Secret Name: ibm-entitlement-key
- Authentication Type: Image Registry Credentials
- Registry Server Address: cp.icr.io
- Username: cp
- Password: MY IBM Key value goes here
-
Click Create.
-
-
Navigate to the OperatorHub page and search for IEAM Management Hub.
-
Click the IEAM Management Hub card and click Install to install the operator.
Notes:
-
Ensure that the Installed Namespace (project) matches the one you created in Step 5.
-
This is the only project that the IEAM Management Hub operator watches after it is installed.
-
-
Navigate to Installed Operators and ensure the Project in the dropdown refers to the project you created in Step 5 (ibm-edge).
-
Click EamHub in the Provided APIs column and click Create EamHub.
-
Under the License drop down, select the accept checkbox, then click Create to accept the license. This creates the *EamHub Custom Resource, which defines and configures your management hub.
For more information about customization options, see Configuration.
The operator deploys the defined workloads in the project that you specified in Step 5 and the IBM Cloud Platform Common Services workloads in the ibm-common-services project.
What's Next
Follow the steps in post installation to continue setting up your new management hub.