- Created by Kirstin Seidel-Gebert, last modified on Oct 10, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 10 Next »
Migration Notes
The following bugfixes and features are subject to migration. Please perform the necessary migration tasks.
API Management | Note |
---|---|
7.5.0 | API Management 7.5.0 features a new policy Caching Resources Policy. To use this policy, you have to import the following configuration file: Import this file as described on API Management Backup and Restore. |
Release Notes of the API Management Version 7
API Management 7.5.0 (08.10.2019)
Contains:
Elasticsearch 5.6.14
MySQL 5.7.25
Keycloak(-Gatekeeper): 5.0.0
Kibana 5.6.14
Migration Notes
API Management 7.5.0 features a new policy Caching Resources Policy. To use this policy, you have to import the following configuration file:
Import this file as described on API Management Backup and Restore.
Bug | Description |
---|---|
GW-186 | UI: Swagger file could not be stored - field has to many bytes |
GW-196 | Docker: UI not working with keystore password containing & |
GW-210 | Policies: Caching Policy throws NullPointerException |
GW-229 | Policies: Caching Resources Policy doesn't cache |
New Feature | Description |
GW-60 | Gateway: Support xUML Services with HTML UI in the catalog |
GW-138 | Gateway: Caching Policy |
GW-185 | Elasticsearch: Save source ip of a request in elasticsearch |
Improvement | Description |
GW-39 | UI: API definition: export Swagger YAML or WSDL file |
GW-43 | UI: Delete plan improvement |
GW-151 | Plugins: Support more than one Bridge in API Catalog Plugin |
GW-155 | Elasticsearch: Rate Limiting Policy support for cluster mode |
GW-182 | Docker: Extend validity of generated self-signed-certificates to 3 years |
GW-191 | Docker: Remove unneeded .p12 file while creating self-signed-certificates |
GW-192 | Plugins: JWT Policy: Support signature verification with JWK(S) |
GW-198 | Docker: Check if all needed files are present before startup |
GW-199 | Plugins: Added source request header for Simple Header Policy |
GW-219 | Docker: Shrink/Squash docker images |
GW-226 | UI: Fix Cancel Buttons |
GW-231 | Docker: Set fix database values for keycloak |
API Management 7.4.0 (24.06.2019)
Contains:
Elasticsearch 5.6.14
MySQL 5.7.25
Keycloak(-Gatekeeper): 5.0.0
Kibana 5.6.14
Bug | Description | Documenation Links |
---|---|---|
GW-112 | Gateway: Swagger "execute" fails: NetworkError when attempting to fetch resource | |
GW-123 | Plugins: API-Catalog: Show which url you are going to import | |
GW-173 | Docker: "$PWD" does not work on windows powershell and command prompt | |
GW-175 | Plugins: API Catalog is unable to load definition file | |
GW-176 | Gateway: Rate Limiting Policy fails | |
GW-178 | UI: IE11: Swagger UI Button Rendering | |
GW-193 | Gateway: Gateway error messages are broken | |
New Feature | Description | |
GW-179 | Docker: Add kibana and keycloak-gatekeeper as proxy | |
Improvement | Description | |
GW-152 | Docker: Gateway should trust valid certificates | |
GW-162 | Elasticsearch: Refactor DefaultEs(ES)ClientFactory because it is duplicate code | |
GW-169 | Docker: Find a better way to create self-signed certificates | Installing API Management |
GW-171 | Docker: Certificate Handling | |
GW-172 | Docker: Add configuration files for distributed setups to api-mgmt.zip | |
GW-181 | Gateway: LDAPS: SocketException: Connection Reset in SSL | |
GW-183 | Gateway: New default (true) for self-signed certificates flag (SELF_SIGNED) | Installing API Management |
GW-184 | Docker: Make it possible to disallow older TLS Versions | Advanced API Management Settings > Security Settings |
API Management 7.3.0 (2019/01/31)
Contains:
Elasticsearch 5.6.14
MySQL 5.7.25
Keycloak 4.8.3.Final
Migration Notes 7.2.0 -> 7.3.0
If starting with a clean installation, there is nothing to do. If updating an installation of API Management, follow the steps listed on Updating API Management and pay attention to the following changes:
- The version of the used underlying MySQL database has changed from 5.7.24 to 5.7.25.
- Perform a database backup.
- Carefully follow the update instructions on Updating API Management , step 3.
The Docker settings file .env has changed:
Old New To Do BRIDGE_URL=bridge.host.com:port
BRIDGE_URL=bridge.host.com
BRIDGE_Port=port
Remove the port from variable BRIDGE_URL
, add the new variableBRIDGE_Port
and provide the port there.KEYCLOAK_ADMIN_USERNAME
Newly added. You only need to set these for a clean install, otherwise leave blank or comment out. KEYCLOAK_ADMIN_PASSWORD
- The structure in which the certificates must be present in the API Management installation has changed.
You need to create this folder structure in your instance of API Management and move your certificates there. See the Installing API Management, Step 3 for instructions. - The docker image for Elasticsearch has changed.
There is nothing to do for your. Refer to the Elasticsearch pages for more information on the new version.
Bug | Description | Documentation Links |
---|---|---|
GW-88 | Github: cache clear issue | |
GW-125 | Support a second gateway | |
GW-133 | Policies: Rate Limiting Policy: Seems to fail under load | |
GW-148 | Docker: Login page is broken if self registration is disabled | |
GW-149 | Docker: The current docker-compose.yml does not work out of the box with Docker for Windows | |
GW-154 | WSDL file is not loaded via the gateway | Troubleshooting API Management |
GW-159 | Docker: Endpoint is not correctly displayed in API Mgmt UI | |
GW-168 | Elasticsearch: Recreation of a plan after delete fails | |
New Feature | Description | Documentation Links |
GW-121 | Improve docker logging and set log rotation for docker logs | API Management Logging |
GW-127 | Docker: Make elasticsearch host configurable in docker-compose and expose ports | |
Improvement | Description | Documentation Links |
GW-10 | Redirect to login after session timeout | |
GW-100 | UI: Open links from Catalog to Bridge Service in a new tab | |
GW-120 | UI: Improve the configuration | |
GW-129 | Docker: Make aliases in keystore or/and key- and truststores configurable in docker-compose or .env | |
GW-130 | Docker: Support HTTPS for Elasticsearch (multiple host setup) | |
GW-131 | Docker: Upgrade to Keycloak 4.5.0 or newer | |
GW-134 | Docker: How-to support distributed (several hosts) set-up | |
GW-143 | Docker: Switch to official oss-elasticsearch docker images without X-Pack | see migration notes above this table |
GW-158 | UI: Change documentation URL on about page | |
GW-164 | UI: Fix metrics tooltip in UI | |
GW-165 | Docker: Add project name to docker-compose |
API Management 7.2.0 (2018/11/01)
Migration Notes 7.1.0 -> 7.2.0
If starting with a clean installation, there is nothing to do. If updating an installation of API Management, follow the steps listed on Updating API Management and pay attention to the following changes:
The Docker settings file .env has changed:
New To Do ELASTICSEARCH_JAVA_MEMORY
Newly added. You need to provide the amount of memory that Elasticsearch can allocate.
Refer to Installing API Management > Step 2: Configure the Installation Settings for more information on this variable.The docker image for Elasticsearch has changed from 5.6.9 to 5.6.12. Refer to the Elasticsearch pages for more information on the new version.
To store files in the elasticsearch_data volume, the old Elasticsearch container uses a user with id 100; the new container uses a user elasticsearch with id 1000.
You need to change the ownership for your Elasticsearch data volume, default name apimgmt_elasticsearch_data. You can lookup the name of the volume withdocker volume ls
.
To change the owner, use the following command:docker run --rm -v apimgmt_elasticsearch_data:/usr/share/elasticsearch/data alpine ash -c "chown -R 1000.1000 /usr/share/elasticsearch/data"
Bug | Description | Documentation Links |
---|---|---|
GW-128 | Docker: Switch to official elasticsearch docker images | Installing API Management |
GW-135 | Connection was closed on exception with runtime |
API Management 7.1.0 (2018/09/19)
API Management 7.1.0 (2018/09/19)
Improvement | Description |
---|---|
GW-117 | Manager-UI: Scheer PAS corporate design |
API Management 7.0.0 (2018/08/29)
Bug | Description |
---|---|
GW-24 | Manager-UI: Swaggerui - Update to 3.17.4 |
GW-89 | Manager-UI: GW: order of the tabs in org details page changes |
GW-91 | Manager-UI: Client/API/Plan details page misses link for tab |
GW-93 | Filter of all APIs/Organizations |
GW-94 | Manager-UI: SwaggerUI does not always work, random errors or wrong URL |
GW-96 | Manager-UI: API Catalog: show the selected categories |
GW-98 | Manager-UI: REST API: moreInfo should point to our documentation |
GW-103 | API Import takes first only if more than one E2ERestPortType is exposed on the same port |
GW-104 | Manager-UI: Sometimes a Browser authentication opens |
GW-118 | https endpoints run into cert error from vertex |
New Feature | Description |
GW-5 | API Management: Docker Images |
GW-46 | CORS Policy |
GW-85 | Automatically update plugins |
Improvement | Description |
GW-81 | Manager-UI: API Management UI problems |
GW-82 | Manager-UI: UI: standardization of upper and lower case writing |
GW-83 | Manager-UI: Change the order of the main menu: Organizations, Clients, APIs, Administration |
GW-84 | Bridge API 2.7.1 changes |
GW-90 | Manager-UI: Last (text) corrections - hopefully |
GW-102 | Update apiman 1.5.0 |
GW-113 | Manager-UI: Create api-mgmt.zip package |
- No labels