Registering a portal service
Define one or more Portal services in your API Connect on-premises cloud.
Before you begin
- Creating an availability zone
- Registering a gateway service
- Configuring an email server for notifications
- Setting up notifications
Note:
When you create or register a Developer Portal
service, the Portal subsystem checks that the Portal web endpoint is accessible. However sometimes,
for example due to the complexity of public and private networks, the endpoint cannot be reached.
The following example shows the errors that you might see in the
portal-www
pod,
admin container logs, if the endpoint cannot be reached:
An error occurred contacting the provided portal web endpoint: example.com
The provided Portal web endpoint example.com returned HTTP status code 504
In this
instance, you can disable the Portal web endpoint check so that the Developer Portal
service can be created successfully. To disable the endpoint check, complete one of the following updates depending on your platform:
- On Kubernetes and OpenShift (with no apiconnectcluster)
- Add the following section to the Portal custom resource (CR) template:
spec: template: - containers: - env: - name: PORTAL_SKIP_WEB_ENDPOINT_VALIDATION value: "true" name: admin name: www
- On IBM® Cloud Pak for Integration (deployed through apiconnectcluster)
- Add the following section to the Apiconnectcluster custom resource (CR)
template:
spec: template: - containers: - env: - name: PORTAL_SKIP_WEB_ENDPOINT_VALIDATION value: "true" name: admin name: ptl-www
- On VMware
- In your
apicup
project, create a file called ptl-extra-values.yaml (or edit the file if one already exists), and add the following section:
Run the following commands:spec: template: - containers: - env: - name: PORTAL_SKIP_WEB_ENDPOINT_VALIDATION value: "true" name: admin name: www
apicup subsys set <ptl_subsys> extra-values-file <path-to-ptl-extra-values-yaml-file>
apicup subsys install <ptl_subsys>
About this task
One of the following roles is required to register and manage Portal services:
- Administrator
- Topology Administrator
- Owner
- A custom role with the
Topology:Manage
permission
Important: It's not recommended to have more than 100 sites per Developer Portal
service. Note that it's not necessary to have a Portal site for every Catalog, for example Catalogs
that are only for API Developers don't need a Portal site, as the APIs can be tested by using
credentials from the API Manager. If more than 100 sites are required, you should configure additional Developer Portal
services.
Procedure
Complete the following steps to configure the Portal services for your cloud:
Field | Description |
---|---|
Title (required) | Enter a descriptive title for the portal service. This title will display on the screen. |
Name (required) | This field is auto-populated by the system and used as the internal field name. |
Summary (optional) | Enter a brief description. |
Management endpoint on the portal service: Endpoint (required) | Enter the IP address, fully-qualified host name, service, or ingress name. Used for
communication with API Manager.
|
Management endpoint on the portal service: TLS client profile (optional) | Select the TLS Client Profile that will be used to communicate with the portal service. The
profile applies to the Management Endpoint. Note: TLS protocol version 1.3
is not supported.
|
Management endpoint on the portal service: Use
in-cluster communication switch |
If you want to use in-cluster communication between the management and
portal subsystems, then enable this switch. For more information about this option, see In-cluster
or external communication between subsystems. If you are not sure, then leave this switch
disabled (the default). |
Portal website URL (required) | The URL that will be used for public access to the portal.
|