Chapter 2. Adding API Designer as a service to your OpenShift Cluster

Procedure

1. Start the OpenShift 4.x Server.
2. In a web browser, navigate to the OpenShift console in your browser. Log in to the console with your credentials.
3. Click Operators and then click OperatorHub.
4. In the search field, type API Designer.
5. Click API Designer card. The API Designer operator install page opens.

6. Click Install. The Install Operator page opens.

   1. For Installation mode, select a namespace (project) from the list of namespaces on the cluster,

   2. For the Approval Strategy, select Automatic or Manual to configure how OpenShift handles updates to the API Designer Operator.

      • If you select Automatic updates, when a new version of the API Designer operator is available, the OpenShift Operator Lifecycle Manager (OLM) automatically upgrades the running instance of the API Designer without human intervention.
      • If you select Manual updates, when a newer version of an Operator is available, the OLM creates an update request. As a cluster administrator, you must then manually approve that update request to have the API Designer operator updated to the new version.
7. Click Install to make the API Designer Operator available to the specified namespace (project).
8. To verify that the API Designer is installed in the project, click Operators and then click Installed Operators to see the API Designer in the list.

1. In a command window, log in to the OpenShift server:

   oc login -u developer -p developer

2. Create a new project namespace. For example, the following command creates a new project named myproject:

   oc new-project myproject

3. Create a new application based on the API Designer template by running the following command (where myproject is the name of your project):

   oc new-app -n myproject -f https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.0.fuse-sb2-7_10_0-00015-redhat-00001/fuse-apicurito.yml -p ROUTE_HOSTNAME=myhost

   Note: Optionally, you can specify other template parameters by appending additional -p options to the oc new-app command. For example, if you installed the Fuse on OpenShift images and templates in a namespace other than the default openshift namespace, you can set the IMAGE_STREAM_NAMESPACE to specify the namespace in which the Fuse image streams are installed:

   oc new-app -n myproject -f https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.0.fuse-sb2-7_10_0-00015-redhat-00001/fuse-apicurito.yml -p ROUTE_HOSTNAME=myhost -p IMAGE_STREAM_NAMESPACE=othernamespace

4. Obtain the status and the URL of your API Designer deployment by running this command:

   oc status

   If the API Designer is not deployed, run the following command to verify that you installed the correct versions of the apicurito-ui and fuse-apicurito-generator images:

   oc get is -n openshift | grep "apicurito"

5. To access the API Designer from a browser, use the provided URL (for example, https://apicurito.192.168.64.12.nip.io).