Release v3.2.0 (#56)

* updated to release 3.2.0 * fixed namespace * updated api list * added release notes for v3.2.0 * update formatting * Update _index.md fix markdown * Update fdx-apim.md fix markdown * Update obb-apim.md fix markdown * Update backend-services.md fix markdown * Update _index.md fix markdown * Update acp.md fix markdown * Update _index.md fix markdown * Update api-management.md review edit * Update component.md review edit * Update obb-api-list.md review edits * Update _index.md review edits * Update _index.md review edit * Update _index.md review edits * Update fdx-apim.md review edits * Update obb-apim.md review edits * Update acp.md Review edits * Update consent-apps.md review edits * Update agents.md review edits * Update agents.md Edit * Update prerequisites.md review edits * Update upgrade.md review edit * Update prerequisites.md * Update _index.md * Update obb-apim.md * Update obb-apim.md * Update _index.md * Update _index.md fix markdown * Update obb-apim.md fix markdown * Update _index.md review edit --------- Co-authored-by: lbadenhop <[email protected]>
Axway · Oct 26, 2023 · 70a4185 · 70a4185
1 parent 125f43f
commit 70a4185
Show file tree

Hide file tree

Showing 26 changed files with 883 additions and 861 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,5 @@ resources/
 node_modules/
 tech-doc-hugo
 .DS_Store
+package-lock.json
+build.sh
diff --git a/content/en/docs/Configuration/Certificate Management/server-certificates.md b/content/en/docs/Configuration/Certificate Management/server-certificates.md
@@ -14,7 +14,7 @@ Server certificate are required for all of the following ingresses:
 
 | Ingress Name                              | External address                       | NAMESPACE                      |
 |-------------------------------------------|----------------------------------------|--------------------------------|
-| acp                                       | acp.`<domain-name>`                    | open-banking-acp               |
+| acp                                       | acp.`<domain-name>`                    | open-banking-cloudentity       |
 | apimanager                                | api-manager.`<domain-name>`            | open-banking-apim              |
 | gatewaymanager                            | api-gateway-manager.`<domain-name>`    | open-banking-apim              |
 | traffic                                   | api.`<domain-name>`                    | open-banking-apim              |

diff --git a/content/en/docs/Configuration/api-management.md b/content/en/docs/Configuration/api-management.md
@@ -84,9 +84,10 @@ For Open Finance Brazil deployment policy container name is - #AMPLIFY-OB.
 ![apim-policy-studio-apis](/Images/apim-policy-studio-api-containers.png)
 
 If you decide to change one of them, you can use Policy Studio directly for the development environment only.
-For other environments, you need to export the Policy Studio projects and build new APIM Docker images to use instead of the standard ones.
+<!-- For other environments, you export the Policy Studio projects and build new APIM Docker images to use instead of the standard ones. -->
+For other environments, you must update the FDX-YAML policy project, which is part of apigateway-config-fdx-7.7.0.20xxxxxx-BNxx.tar.gz, and deploy the configuration as detailed in [Mount the FDX Configuration](/docs/deployment/installation/api-management/fdx-apim/#mount-the-fdx-configuration).
 
-{{% alert title="Note" color="primary" %}} If you make changes to any of the policies in this container then those changes will be overridden by future upgrades {{% /alert %}}
+{{% alert title="Note" color="primary" %}} If you make changes to any of the policies in this container then those changes will be overridden by future upgrades. {{% /alert %}}
 
 ### Certificates
 

diff --git a/content/en/docs/Overview/Integration/Financial-Data-Exchange-Integration/_index.md b/content/en/docs/Overview/Integration/Financial-Data-Exchange-Integration/_index.md
@@ -17,7 +17,7 @@ The flow is summarized as follows:
 
 All APIs that provide access to data are implemented in the same manner. The consent/data access pattern relating to Account Information is therefore representative regardless of the specific resource (checking accounts, credit cards, loans, and so on).
 
-![FDX Wrokflow](/Images/FDX_Workflow.png)
+![FDX Wrokflow](/Images/FDX_Workflow_0.png)
 
 ### Steps
 

diff --git a/content/en/docs/Overview/Technical/component.md b/content/en/docs/Overview/Technical/component.md
@@ -7,7 +7,7 @@ date: 2021-06-30
 
 The diagram below shows a component view of the Amplify Open Banking solution.
 
-![Component View](/Images/Component_View_0.svg)
+![Component View](/Images/Component_View_v320.svg)
 
 The table below provides details of each of the components listed above. The list includes the name of the solution building block to which the component relates.
 
@@ -24,16 +24,17 @@ The table below provides details of each of the components listed above. The lis
 | API Manager | API Management | Management tool for API Management infrastructure. | Mandatory | |
 | API Traffic | API Management | Responsible for receiving and executing all requests from API consumers. | Mandatory | We recommend adapting the minimum sizing according to the estimated volumes per month. This will allow the pod autoscaler to adapt the number of pods during the peak load.<br><br>To support peak load and SLAs multiple replicas must be used. In addition, the Horizontal Pod Autoscaler (HPA) must be activated (by default this is disabled).<br><br>The configuration of this component ensures each replica is spread across different nodes (anti-affinity node), which reduces IOPS.<br><br>These pods require multiple services and ingress as they have multiple listeners.
 | APIMCLI | API Management | Job that configures all API objects in the API Manager including users, settings, APIs, organizations, applications and so on. | Mandatory | This job is executed after each upgrade to ensure the API Manager is up-to-date.<br><br>All configurations are externalized in a Kubernetes config map to allow the API configuration to be updated by the installer as required.<br><br>API descriptions in both US English and Portuguese (for Brazil deployments) are available by default. |
-| Cassandra | API Management | Data store for API Manager configuration, throttling, and additional data. | Mandatory | 3 nodes are required in production that must be spread on different availability zones.<br><br>Supports Cassandra 3.11.11 only and blocks usage of managed databases in all cloud providers |
+| Cassandra | API Management | Data store for API Manager configuration, throttling, and additional data. | Mandatory | 3 nodes are required in production that must be spread on different availability zones.<br><br>Supports Cassandra 3.11.11 only and blocks usage of managed databases in all cloud providers. |
 | Discovery Agent | Amplify Agents | Discovery Agent discovers the API from API Manager and makes it available in Amplify | Mandatory |  |
 | Traceability Agent | Amplify Agents | Traceability Agent uses the API Gateway events to extract the transaction information and send it to the Amplify platform Observability module | Mandatory | |
 | open-banking-backend (multiple applications) | API Builder | The purpose of these applications is:<br><ul><li>Provide a mock backend for use in your developer experience if you want.| Conditional | The backend services provided by the open-banking-backend component are created using API Builder and are designed to be reconfigured for use with  your backend services to provide the data required for Open Banking.<br><br>You can swap these out for an application with equivalent functionality if you want. However, if this course of action is taken then the benefit of providing an application that is designed to be compliant with the relevant standards/OpenAPI specification is lost. |
 | MySQL Backend Services | Utilities | Provides storage for mock backend services. | Conditional | Provides storage for backend services where the API Builder applications are using the default configuration. This does not need to be deployed if the backend services APIs are integrated with the Core Banking Applications. |
 | Cloudentity | Identity Management<br><br>Consent Management | Cloudentity that provides:<br><ul><li>Authorization Server</li><li>Token endpoint</li><li>Management and configuration UI</li></ul> | Mandatory | Cloudentity is required to provide:<br><ul><li>Compliance with the Brazil FAPI Security Profile.</li><li>Integration with Consent Management to support Open Banking Brazil standards.</li><li>Integration with external IDPs already implemented by customers.</li></ul> |
-| acp-seed | Identity Management | Job to implement the default configuration for Cloudentity. | Mandatory | This is required as it it creates the configuration that connects Cloudentity and the API Portal. |
-| bank | Consent Management | Open banking sandbox to use with demo applications. | Optional | This only provides demo capabilities, therefore it is not required for production. |
-| consent admin | Consent Management | Consent administration demo application | Optional | This only provides demo capabilities, therefore it is not recommended to use this component in production. For Production you can take one of two courses of action:<br><ul><li>Use the provided template and enhance it for production usage</li><li>Develop your own web component and call Cloudentity APIs to perform consent operations.</li></ul> |
-| consent self-service | Consent Management | Consent self-service demo application | Optional | This only provides demo capabilities, therefore it is not recommended to use this component in production. For Production you can take one of two courses of action:<br><ul><li>Use the provided template and enhance it for production usage</li><li>Develop your own web component and call Cloudentity APIs to perform consent operations.</li></ul> |
-| consent page | Consent Management | Consent confirmation demo page | Optional | This only provides demo capabilities, therefore it is not recommended to use this component in production. For Production you can take one of two courses of action:<br><ul><li>Use the provided template and enhance it for production usage</li><li>Develop your own web component and call Cloudentity APIs to perform consent operations.</li></ul> |
-| Hazelcast | Identity Management<br><br>Consent Management | In-memory data grid that supports the operation of Cloudentity. | Mandatory   | |
-| CockroachDB | Identity Management<br><br>Consent Management | Backend storage for Cloudentity. | Mandatory | |
+| acp-cockroachdb-init | Identity Management <br></br> Consent Management | Job to initialize the default configuration for Cloudentity. | Mandatory |  |
+| CockroachDB | Identity Management<br><br>Consent Management | Cloudentity uses CockroachDB to store various types of data, such as users added to Cloudentity Identity Pools, configuration of client applications connected to a workspace, information about consent grants, and many more. | Mandatory |  |
+| Redis | Identity Management | The Cloudentity platform uses Redis to store a variety of data types that are well-suited for key-value storage. This includes security tokens such as access tokens, which grant users access to protected resources, and identity tokens, which provide information about the user’s identity. | Mandatory |  |
+| TimescaleDB | Identity Management | Cloudentity uses TimescaleDB to store audit and analytics/metrics data because it is a powerful and efficient tool for handling large amounts of time-series data.  | Optional |  |
+| consent admin | Consent Management | Consent administration demo application | Optional | This only provides demo capabilities, therefore it is not recommended to use this component in production. For Production you can take one of two courses of action:<br><ul><li>Use the provided template and enhance it for production usage.</li><li>Develop your own web component and call Cloudentity APIs to perform consent operations.</li></ul> |
+| consent self-service | Consent Management | Consent self-service demo application | Optional | This only provides demo capabilities, therefore it is not recommended to use this component in production. For Production you can take one of two courses of action:<br><ul><li>Use the provided template and enhance it for production usage.</li><li>Develop your own web component and call Cloudentity APIs to perform consent operations.</li></ul> |
+| consent page | Consent Management | Consent confirmation demo page | Optional | This only provides demo capabilities, therefore it is not recommended to use this component in production. For Production you can take one of two courses of action:<br><ul><li>Use the provided template and enhance it for production usage.</li><li>Develop your own web component and call Cloudentity APIs to perform consent operations.</li></ul> |
+| acp-import | Identity Management <br></br> Consent Management | Job to implement the default configuration for Cloudentity. | Optional | It creates the configuration for the target specification. If not used, then Cloudentity must to be configured manually. |