What's new in documentation

This topic describes the documentation changes in this release.

API Gateway

API Gateway Installation Guide

  • Updated the system requirements with the latest details on supported versions.
  • Added new topics on configuring API Management in multiple datacenters:
    • Multi-datacenter deployment architecture
    • Multi-datacenter configuration
    • Multi-datacenter failover scenarios
  • Updated the Apache Cassandra topics with support for Cassandra version 2.2.8 and the native Datastax client (replacing the Hector client used in previous versions).
  • The section on upgrading from Cassandra version 2.2.5 to Cassandra 2.2.8 has moved from the topic on installing Cassandra to the API Gateway Upgrade Guide.
  • Updated the topic on the setup-cassandra script with automatic backup of cassandra.yaml, and for use with remote Cassandra deployments.
  • Restructured the Cassandra topics, adding separate new topics for:
    • Cassandra deployment architecture
    • Manage Cassandra on UNIX/Linux and Windows
  • Restructured the topic on Docker containers, adding separate new topics for:
    • Docker deployment architecture
    • Run pre-built Docker images (for development and test only)
    • Generate Docker images for HA production environments
    • Customize your API Management Docker environment
  • Updated the post-installation topic with details on running API Gateway Analytics as a service on Windows.
  • Updated the topic on API Gateway Analytics configuration with clarification on the characters supported by the username and password provided to the configureserver script.
  • Updated the topic on system requirements with support for the MariaDB database.

API Gateway Upgrade Guide

  • Added a note that the latest available service pack must be installed before starting the upgrade.
  • Restructured the content to make it clearer which topics apply to upgrades from 7.3.x and 7.4.x versions, and which topics apply to upgrades from version 7.5.x versions.
  • Added information on the Apache Cassandra port changes when upgrading from API Gateway 7.5.x versions.
  • Added information on how to upgrade Apache Cassandra from version 2.2.5 to 2.2.8. This is an optional step that you can perform after upgrading from API Gateway 7.5.x versions.
  • Added information on zero downtime upgrade sample scripts.

API Gateway Policy Developer Guide

  • Added information on enabling team development in Policy Studio preferences. Team development is disabled by default.
  • Updated information on creating Policy Studio projects with changes for team development templates.
  • Reference information on all Policy Studio filters removed from this guide and added to a new guide API Gateway Policy Developer Filter Reference.

API Gateway Policy Developer Filter Reference

  • This is a new guide that contains reference information for all Policy Studio filters. This information was previously available in the API Gateway Policy Developer Guide.
  • Added information on configuring SSL/TLS protocols for the Connect to URL and Connection filters.
  • Updated the topic on configuring database connections with support for the MariaDB database.

API Gateway OAuth User Guide

  • Added information on configuring SSL/TLS protocols for the Get OAuth Access Token filter and the Refresh an OAuth Client Access Token filter.

API Gateway DevOps Deployment Guide

  • Additional information and clarifications added to team development topics. This includes information on when you should use team development, and how to enable team development in Policy Studio preferences, as team development is disabled by default.
  • Added information on the new projupgrade tool. This tool enables you to upgrade API Gateway projects from earlier versions (7.5.1 or later).

API Gateway Administrator Guide

  • All screen shots updated to reflect the new branding in API Gateway Manager.
  • Added information on how to check the status of API Gateway groups and instances, and check the installed version number of API Gateway instances in API Gateway Manager.
  • Added information on how to find your installed version and service pack, and list installed patches.
  • Added new topic on zero downtime settings in Policy Studio.
  • Added information on how to perform a zero downtime deployment and zero downtime shutdown in a in a multi-node API Gateway environment with a load balancer.
  • Added new topic on open traffic event log settings in Policy Studio.
  • Added information on using and configuring open traffic event logging to forward and consolidate API Gateway log, event, and trace information for analysis in external analytics and observability systems.
  • Updated relevant sections to reflect that administrator passwords are encrypted using PBKDF2 with HmacSha256 for better security.
  • The topic on Apache Cassandra settings has been updated to reflect the new Datastax client.
  • Removed outdated information on JVM memory from the topic on API Gateway performance tuning.

API Gateway Appliance Installation and Administration Guide

  • All screen shots updated to reflect the new branding in the Web Administration Interface.
  • Updated information on how to upgrade the Appliance Platform and how to upgrade API Gateway on the appliance.
  • Added information on the legal warning and the root password warning that are displayed on the Appliance Console Menu.
  • Updated information on logging in as the default administrator user, as you are now prompted to change the password the first time you log in.
  • Removed information on the API Gateway virtual appliance ISO format. This format has been replaced by the OVA format. The ISO format is still available, but is only supported for factory resets on a physical appliance.
  • Added information on upgrading the Apache Cassandra version on the appliance.

API Gateway Developer Guide

  • Added information on the CheckboxGroupAttribute element to the Declarative UI reference.
  • Updated or removed information on the jabber and restJabber code samples as these samples are no longer included in the code samples supplied with API Gateway.

API Gateway Authentication and Authorization Integration Guide

  • Added a section how to integrate API Gateway with RSA Access Manager 6.2.
  • Added a section how to integrate API Gateway with products supporting LDAP protocol, such as IBM Security Directory Server 6.4.0.
  • Added sections on Oracle Access Manager (OAM) integration and Oracle Entitlements Server (OES) integration

API Gateway Kerberos Integration Guide

  • Added a section how to configure API Gateway for how to configure API Gateway for unconstrained credential delegation.
  • Added information how to use Key Property Store (KPS) to store passwords for both Kerberos clients and Kerberos services.

API Gateway Key Property Store User Guide

  • The topic on the kpsadmin tool has been restructured and expanded with new sections on running kpsadmin in scriptable command mode and on re-encrypting KPS data.
  • Added support for the MariaDB database

API Manager

API Manager User Guide

  • Added a new topic on configuring cloud application connectors for API Builder application APIs. This describes how to configure connectors in Policy Studio and how to import API Builder application APIs in API Manager.
  • The topic on API Manager monitoring includes an updated prerequisites section. This describes the metrics database requirements and the necessary configuration steps.
  • Screenshots have been updated to reflect the new product branding in the API Manager web console.
  • The topic on API management workflow has been updated to include RAML import.
  • The topic on registering REST APIs in API Manager has been updated to clarify that importing RAML files with references to external files is not supported.
  • The sections on rebranding the API Manager user interface have been removed from the topic on customizing API Manager
  • The topic on configuring API Manager in Policy Studio includes a new section on customizing the default API Manager routing policy for all APIs.

API Portal

API Portal Installation and Upgrade Guide

  • Added instructions how to deploy API Portal to Docker containers.
  • Updated the instructions how to upgrade an API Portal virtual appliance installation or Red Hat Enterprise Linux (RHEL) software installation to v7.5.3.
  • Amended the instructions on how to install a new API Portal software installation.
  • Added a new topic on how to update the API Portal hostname for secure connections on a virtual appliance installation.
  • Added instructions on how to secure the connection from API Portal to a remote MySQL database using TLS on a software installation.
  • Added information how to install API Portal service packs.

API Portal Administrator Guide

  • All screenshots updated to reflect the new branding in API Portal.
  • Added a new section on how to configure API Portal for single sign-on (SSO).
  • Added a new section how to localize your API Portal to another language than the default English.
  • Added information how to enable the client SDK generator in API Portal.

API Portal User Guide

  • All screen shots updated to reflect the new branding and layout in API Portal.
  • The guide has been extensively restructured to reflect the relevance of each feature, with more information added on the steps how to use the features.
  • Added information on how to generate and download a client SDK for an API.

Related Links