Skip to content

Commit

Permalink
Update fdx-apim.md
Browse files Browse the repository at this point in the history
review edits
  • Loading branch information
lbadenhop authored Oct 25, 2023
1 parent 1dbd364 commit 241f5cf
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions content/en/docs/deployment/installation/API-Management/fdx-apim.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 1
---
## Configure API Gateway

Once installation is complete following the instructions from [Install API Gateway using your customized YAML file](https://docs.axway.com/bundle/axway-open-docs/page/docs/apim_installation/apigw_containers/deployment_flows/axway_image_deployment/helm_deployment/index.html#install-api-gateway-using-your-customized-yaml-file), mount the FDX policies and configuration files using the below steps.
Once installation is complete, following the instructions at [Install API Gateway using your customized YAML file](https://docs.axway.com/bundle/axway-open-docs/page/docs/apim_installation/apigw_containers/deployment_flows/axway_image_deployment/helm_deployment/index.html#install-api-gateway-using-your-customized-yaml-file), and mount the FDX policies and configuration files using the below steps.

### Download the API Gateway configuration files

Expand Down Expand Up @@ -36,7 +36,7 @@ apigateway-config-fdx-7.7.0.20xxxxxx-BNxx

### Prepare values.yaml for the deployment

As some of the variables are defined in `PS-Projects/FDX-YAML/values.yaml` file you need to update it before deployment. Recommendation is to copy the `PS-Projects/FDX-YAML/values.yaml` to `local_values/FDX-YAML/values.yaml` and then make changes in it.
As some of the variables are defined in `PS-Projects/FDX-YAML/values.yaml` file, you must update it before deployment. it is recommendation to copy the `PS-Projects/FDX-YAML/values.yaml` to `local_values/FDX-YAML/values.yaml` and then make changes in it.

```bash
cp apigateway-config-fdx-7.7.0.20xxxxxx-BNxx/PS-Projects/FDX-YAML/values.yaml local_values/FDX-YAML/values.yaml
Expand All @@ -51,31 +51,31 @@ The following parameters are required for FDX deployment, so update the `local_v
| Environment_Configuration.Service.apimgr.name | Endpoint where API Manager is running. | api-manager-host | api-manager.open-banking.axway.com |
| Environment_Configuration.Service.apimgr.port | Post at which API Manager is running. | 443 | |
| Policies._AMPLIFY_OB_FDX.Mock.Login_Page.PAGE_login.Set_var_demo_apps_enabled.attributeValue | Set to `true` if demo-apps are deployed. | false | |
| Policies._AMPLIFY_OB_FDX.Mock.Login_Page.PAGE_login.Set_demo_apps_url.attributeValue | Endpoint where demo apps are running, if not deploying demo apps component then leave it default. | `https://demo-apps.\<domain-name\>` | `https://demo-apps.open-banking.axway.com` |
| Policies._AMPLIFY_OB_FDX.Mock.Login_Page.PAGE_login.Set_demo_apps_url.attributeValue | Endpoint where demo apps are running. If not deploying demo apps component then keep the default. | `https://demo-apps.\<domain-name\>` | `https://demo-apps.open-banking.axway.com` |

### Mount the FDX Configuration

Make sure that API Gateway pods i.e. anm, apimgr, apitraffic are in running state and then execute following commands:
Make sure that API Gateway pods (i.e., anm, apimgr, apitraffic) are in running state and then execute the following commands:

```bash
cd apigateway-config-fdx-7.7.0.20xxxxxx-BNxx/sample
./mount_config.sh -p FDX
cd -
```

Above script deploys YAML archive and other configuration files from `merge` directory to `gw-external-config` volume mount in K8S cluster. Before building the YAML archive it replaces `apigateway-config-fdx-7.7.0.20xxxxxx-BNxx/PS-Projects/FDX-YAML/values.yaml` with `local_values/FDX-YAML/values.yaml` which contains the actual values for the target environment.
The above script deploys YAML archive and other configuration files from `merge` directory to `gw-external-config` volume mount in K8S cluster. Before building the YAML archive, it replaces `apigateway-config-fdx-7.7.0.20xxxxxx-BNxx/PS-Projects/FDX-YAML/values.yaml` with `local_values/FDX-YAML/values.yaml`, which contains the actual values for the target environment.

## Configure API Manager

To configure API Manager i.e. to create Organizations, APIs, applications and import KPS data use the `open-banking-fdx-apim-config` helm chart. During installation it creates Organizations, sample applications and FDX APIs. It also imports data in the KPS tables.
To configure API Manager (i.e., to create Organizations, APIs, applications and import KPS data), use the `open-banking-fdx-apim-config` helm chart. During installation it creates Organizations, sample applications and FDX APIs. It also imports data in the KPS tables.

### Change apiadmin user password

Log in to API Manager UI to change the default password of `apiadmin` user. It is required for successful execution of below steps.
Log in to the API Manager UI to change the default password of `apiadmin` user. It is required for successful execution of the below steps.

### Fetch the Helm chart to examine the values file

To be able to view the Helm `values.yaml` file you can run a `helm fetch` command on the added repository:
Run a `helm fetch` command on the added repository to view the Helm `values.yaml` file:

```bash
helm fetch axway/open-banking-fdx-apim-config --untar
Expand All @@ -91,7 +91,7 @@ Customize the `open-banking-fdx-apim-config/values.yaml` file as follows.
|:------------- |:------------------------------------- |:-------------- |
| global.domainName | Set the domainname for all ingress. | None |
| global.env | Set the default environment. | prod |
| global.dockerRegistry.url | URL fot the docker registry. | None |
| global.dockerRegistry.url | URL for the docker registry. | None |
| global.dockerRegistry.username | Login name to pull Docker images from the Axway Repository. | None |
| global.dockerRegistry.token | Password token to pull Docker images from the Axway Repository. | None |
| anm.admin.username | API Gateway admin username | admin |
Expand Down Expand Up @@ -140,23 +140,23 @@ Customize the `open-banking-fdx-apim-config/values.yaml` file as follows.
```

3. Check API Manager `https://api-manager.<domain-name>`:
* Refresh or login again.
* Refresh or log in again.
* Make sure that Open Banking APIs are in the API Catalog.
* Make sure that Default apps are in Client applications.

4. Check KPS data in API Gateway Manager `https://api-gateway-manager.<domain-name>`:
* Login and go to Settings - Key Property Stores.
* Log in and go to *Settings - Key Property Stores*.
* Make sure that `Configuration` and `Error` tables are not emplty.

## Post deployment

This post deployment step is only applicable if you have changed the default ports, client ids, client secrets etc. during the [Cloudentity](/docs/deployment/installation/cloudentity/acp) or [Consent Apps](/docs/deployment/installation/cloudentity/consent-apps) deployment.
This post deployment step is only applicable if you have changed the default ports, client ids, client secrets, etc. during the [Cloudentity](/docs/deployment/installation/cloudentity/acp) or [Consent Apps](/docs/deployment/installation/cloudentity/consent-apps) deployment.

### Update KPS configuration

In case you need to update some configurations in the `cfg` KPS table, use the bbelow steps:
To update configurations in the `cfg` KPS table:

1. Get the KPS configuration table data file from the helmchart:
1. Get the KPS configuration table data file from the Helm chart:
* Configuration table KPS data file is `open-banking-fdx-apim-config/files/kps/amplify_configuration.json`.
* Update it with the values specific to your deployment.

Expand All @@ -167,5 +167,5 @@ In case you need to update some configurations in the `cfg` KPS table, use the b
```
3. Verify the insertion in the KPS table:
* Log into the API Gateway Manager UI and go on Settings - Key Property Stores.
* Click on AMPLIFY/Configuration and make sure that data is updated.
* Log in to the API Gateway Manager UI and go to *Settings - Key Property Stores*.
* Click on AMPLIFY/Configuration and make sure that the data is updated.

0 comments on commit 241f5cf

Please sign in to comment.