Tutorial: Configuring the Cloud

This tutorial shows you how to create a basic cloud configuration, with available gateway, analytics and developer portal services.

Before You Begin

This task can be completed by users who are assigned one of the following roles:

Cloud Owner
Cloud Administrator

You must run the Install Assist installation program to configure the Default Availability Zone that contains the Management service. See Installing API Connect into a Kubernetes environment and Deploying the Management OVA file.

You will need the following information to complete this tutorial.

The IP address or FQDN of the gateway, and the port assigned to accept API requests from clients.
The IP address or FQDN of the gateway, and the port assigned to communicate with the API Management server. This cannot be the same as the port for API requests.
The FQDN of the Developer Portal service to accept requests from clients. This value was set using the InstallAssist command:
```
apicup subsys set ptl portal-www <portal>.<hostname>.<domainname>
```
.
The FQDN of the Developer Portal to communicate with the API Management server. This value was set using the InstallAssist command:
```
apicup subsys set ptl portal-admin <padmin>.<hostname>.<domainname>
```
.
The FQDN of the Analytics service to accept requests from clients. This value was set using the InstallAssist command:
```
apicup subsys set analyt analytics-client <ac>.<hostname>.<domainname>
```
.
The address, port and optional login credentials for an SMTP email server.

Note: The port for the portal-www, portal-admin, and analytics-client services is 443, and isn't configurable.

About this tutorial

In this tutorial you are going to complete the following lessons:

Initial Cloud Manager Console login
Configure an Email Server
Register a Gateway Service
Register a Portal Service
Register an Analytics Service
Configure a Default Gateway Service

Initial Cloud Manager Console login

Take the following steps to log in to the Cloud Manager user interface for the first time.

In a web browser, enter the management service URL. For example, https://ManagementService.domain/admin where ManagementService.domain is the fully qualified host name or IP address of the Management service.
Enter the Cloud Administrator user name and password. The default values are admin for the user name and 7iron-hide for the password.
You are immediately required to change the admin password, as well as provide an email address for the cloud administrator. Enter the necessary information.
Note: If you forget your password and request a password reset, the notification email is sent to this email address. This action will use the email server set in the Notifications section of the cloud Settings. This tutorial shows you how to set this configuration.
Click Save.
Log in using the new password.

Configure an Email Server

Take the following steps to configure an email server. This configuration allows you to recover the admin password or receive other important notifications.

Click Resources icon or the Manage Resources tile.
Click Notifications.
Click Create.
Enter the appropriate values in the fields These values vary depending on your site.
Click Save.
Click the Home icon.

Register a Gateway Service

Take the following steps to register a gateway service.

Click the Configure Topology tile.
Click Register Service.
Click DataPower Gateway (v5 compatible).
Take the following steps.
1. Enter gateway_service in the Title field.
2. In the Management Endpoint section, enter the URL of the address and port assigned to the management endpoint in the Endpoint field. This is the port used by the API Management server to connect to the gateway.
3. Leave the remaining values as given to set TLS profiles.
4. In the API Invocation Endpoint section, enter the URL of the gateway address and port assigned to accept API requests from clients in the API Endpoint Base field.
5. Do not change the defaults in the Server Name Indication (SNI) fields. Note that your topology may require specific values in these fields.
6. Optionally enter a hex value in the OAuth Shared Secret field. This must be a 64-bit hex value that begins with "0x". Providing a shared secret value here enables gateways in a cluster to read the OAuth tokens generated by any member of the cluster using the same secret.
7. Click Save.

Register a Portal Service

Take the following steps to register a portal service.

Click Register Service.
Click Portal.
Take the following steps.
1. Enter portal_service in the Title field.
2. In the Management Endpoint section, enter the URL of the portal address and port assigned to communicate with the management server in the Endpoint field.
3. Enter the URL of the portal address and port assigned to accept requests from clients in the Portal Website URL field.
4. Use the reconfigured profile in the TLS Client Profile field.
5. Click Save.

Register an Analytics Service

Take the following steps to register an analytics service.

Click Register Service
Click Analytics.
Take the following steps.
1. Enter analytics_service in the Title field.
2. In the Management Endpoint section, enter the URL of the analytics server address and port assigned to accept requests from clients in the Endpoint field.
3. Select Analytics client TLS client profile in the TLS Client Profile field.
4. Click Save.
Click Associate Analytics Service corresponding to the gateway service listing.
Select analytics_service_1. Click Associate.

Configure a Default Gateway Service

Take the following steps to configure a default gateway service for every catalog in the cloud.

Click Settings icon .
Click Catalog Defaults.
Click Edit.
Select an available gateway service.
Click Save.

What you did in this tutorial

Set new Cloud Manager Console login password
Configured a Gateway Service
Configured a Developer Portal Service
Configured an Analytics Service
Configured a Notifications Email Server
Configured a Catalog Default Gateway Service