-
Notifications
You must be signed in to change notification settings - Fork 133
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: at670475 <[email protected]>
- Loading branch information
Showing
1 changed file
with
75 additions
and
64 deletions.
There are no files selected for viewing
139 changes: 75 additions & 64 deletions
139
docs/user-guide/api-mediation/api-catalog-configuration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,84 +1,95 @@ | ||
| <!-- omit in toc --> | ||
| # Advanced API Catalog features configuration | ||
|
|
||
| As a system programmer who wants to configure advanced API Catalog features of the API Mediation Layer, you can customize API Catalog parameters by modifying the file `<Zowe install directory>/components/api-catalog/bin/start.sh`. | ||
| As a system programmer who wants to configure advanced API Catalog features of the API Mediation Layer, you can customize API Catalog parameters by modifying the `zowe.yaml` file. | ||
|
|
||
| - [API ML configuration](#api-ml-configuration) | ||
| **Note:** Restart Zowe to apply changes to the parameter. | ||
|
|
||
| Follow the procedures in the following sections to customize API Catalog parameters according to your preferences: | ||
|
|
||
| - [Hide service information](#hide-service-information) | ||
| - [API Catalog branding](#api-catalog-branding) | ||
| <!-- TODO This document should be updated to reflect the settings that can be updated in zowe.yaml --> | ||
|
|
||
| ## API ML configuration | ||
| ## Hide service information | ||
|
|
||
| 1. Open the file `zowe.yaml`. | ||
| 2. Configure the following properties: | ||
|
|
||
| * **apiml.catalog.hide.serviceInfo** | ||
| * **apiml.catalog.hide.serviceInfo** | ||
|
|
||
| This parameter is used to hide the instance URL value of all services registered to the API ML in the API Catalog. This customization can be useful when the service owner does not want to expose sensitive information such as the hostname. | ||
| This parameter is used to hide the instance URL value of all services registered to the API ML in the API Catalog. This customization can be useful when the service owner does not want to expose sensitive information such as the hostname. | ||
|
|
||
| Set the value of the `*apiml.catalog.hide.serviceInfo` parameter to `true` to hide the instance URL for all services registered to the API Catalog. | ||
| Set the value of the `*apiml.catalog.hide.serviceInfo` parameter to `true` to hide the instance URL for all services registered to the API Catalog. | ||
|
|
||
| In your Zowe YAML configuration (typically `zowe.yaml`), set this parameter by defining `configs.apiml.catalog.hide.serviceInfo`. | ||
| In your Zowe YAML configuration (typically `zowe.yaml`), set this parameter by defining `configs.apiml.catalog.hide.serviceInfo`. | ||
|
|
||
| Follow this example to define this parameter globally. | ||
| Follow this example to define this parameter globally. | ||
|
|
||
| **Example:** | ||
| **Example:** | ||
|
|
||
| ```yaml | ||
| configs: | ||
| apiml: | ||
| catalog: | ||
| hide: | ||
| serviceInfo: true | ||
| ``` | ||
| ```yaml | ||
| configs: | ||
| apiml: | ||
| catalog: | ||
| hide: | ||
| serviceInfo: true | ||
| ``` | ||
| An alternative is to define this parameter only for a high availability instance on lpar1. | ||
| An alternative is to define this parameter only for a high availability instance on lpar1. | ||
| **Example:** | ||
| **Example:** | ||
| ```yaml | ||
| haInstances: | ||
| lpar1: | ||
| configs: | ||
| apiml: | ||
| catalog: | ||
| hide: | ||
| serviceInfo: true | ||
| ``` | ||
| ```yaml | ||
| haInstances: | ||
| lpar1: | ||
| configs: | ||
| apiml: | ||
| catalog: | ||
| hide: | ||
| serviceInfo: true | ||
| ``` | ||
| 3. Restart Zowe. | ||
| ## API Catalog branding | ||
| It is possible to customize the logotype and selected style options directly in `zowe.yaml`. The following properties can be set under `apiml.catalog.customStyles`: | ||
|
|
||
| - **logo** | ||
| Specifies the location of the logo that will replace the default Zowe logo in the API Catalog header. The supported image formats are: `svg`, `png` and `jpg/jpeg`. | ||
| - **titlesColor** | ||
| Specifies the title color. | ||
| - **fontFamily** | ||
| Specifies the font family to use across the API Catalog. | ||
| - **headerColor** | ||
| Specifies the HTML color of the header element in the API Catalog home page | ||
| - **backgroundColor** | ||
| Specifies the HTML color of the main background across the API Catalog | ||
| - **textColor** | ||
| Specifies the HTML color of the main text across the API Catalog | ||
| - **docLink** | ||
| Specifies a custom link to be displayed in the header. Use this property to refer to applicable documentation. The format is `<link_name>|<link_url>` | ||
| **Example:** `docLink: Custom Documentation|https://somedoc.com` | ||
|
|
||
| Follow this example to define this parameter globally. | ||
|
|
||
| **Example:** | ||
|
|
||
| ```yaml | ||
| configs: | ||
| apiml: | ||
| catalog: | ||
| customStyles: | ||
| logo: /path/to/logo.png | ||
| titlesColor: #F7190E | ||
| fontFamily: Roboto | ||
| headerColor: grey | ||
| backgroundColor: #FFFFFF | ||
| textColor: blue | ||
| docLink: Custom Documentation|https://somedoc.com | ||
| ``` | ||
| It is possible to customize the logotype and selected style options directly in `zowe.yaml`. | ||
|
|
||
| 1. Open the file `zowe.yaml`. | ||
| 2. Configure the following properties by setting them under `ZWE_configs_apiml_catalog_customStyles`: | ||
|
|
||
| - **logo** | ||
| Specifies the location of the logo that will replace the default Zowe logo in the API Catalog header. The supported image formats are: `svg`, `png` and `jpg/jpeg`. | ||
| - **titlesColor** | ||
| Specifies the title color. | ||
| - **fontFamily** | ||
| Specifies the font family to use across the API Catalog. | ||
| - **headerColor** | ||
| Specifies the HTML color of the header element in the API Catalog home page | ||
| - **backgroundColor** | ||
| Specifies the HTML color of the main background across the API Catalog | ||
| - **textColor** | ||
| Specifies the HTML color of the main text across the API Catalog | ||
| - **docLink** | ||
| Specifies a custom link to be displayed in the header. Use this property to refer to applicable documentation. The format is `<link_name>|<link_url>` | ||
| **Example:** `docLink: Custom Documentation|https://somedoc.com` | ||
|
|
||
| Follow this example to define this parameter globally. | ||
|
|
||
| **Example:** | ||
|
|
||
| ```yaml | ||
| configs: | ||
| apiml: | ||
| catalog: | ||
| customStyles: | ||
| logo: /path/to/logo.png | ||
| titlesColor: #F7190E | ||
| fontFamily: Roboto | ||
| headerColor: grey | ||
| backgroundColor: #FFFFFF | ||
| textColor: blue | ||
| docLink: Custom Documentation|https://somedoc.com | ||
| ``` | ||
|
|
||
| Properties in the example that are not set default to Zowe API Catalog css values. | ||
| Properties in the example that are not set default to Zowe API Catalog css values. | ||
| 3. Restart Zowe. |