APIIDA API Gateway Manager

Release Notes Winter 20

Details on upgrading to Winter 20 can be found here: https://apiida.atlassian.net/wiki/pages/createpage.action?spaceKey=ASD&title=Upgrade%20to%20Winter%2020

Features and Enhancements

CI/CD - Continuous Integration and Continuous Deployment

  • The APIIDA API Gateway Manager now supports RESTful APIs to manage the Gateway Manager and the connected gateways.

    • A new /migrate endpoint allows a safe way to migrate (one or more) resources (like Services) to any connected target, including a list of targets. All necessary steps, like changing variables, intelligent mapping and creating the folder structure will be done automatically.

    • Additional endpoints help to administer the Gateway Manager, like create/remove existing nodes.

  • Define Migration Pipelines, including pre- and post-steps for every migration, like sending a webhook to an already existing test-tool. With this, a fully automated flow for a CI/CD pipeline can be established.

    • Define standard pipeline for every environment or for every migration

    • Define pre- and post-steps for a migration

    • Use adminTools functionality, like disabling/enabling a cluster in the migration process

  • A new Command Line Interface (CLI) to manage the Gateway Manager and performing migrations, can be used for existing CI/CD tools, like Jenkins.

More information about the new API interface is documented here: https://apiida.atlassian.net/wiki/spaces/AAGM/pages/897417221

Venafi Trusted Protection Platform integration

  • Integration to the Venafi Platform automatic Machine Identity Protections. Migrate new or updated certificates from the Venafi Platform directly to all managed gateways. Changes can be automatically detected and updated on the gateways. This integration can be used for Private Keys, as well as for Trusted Certificates.

Admin Tools

  • Support for Admin Tools from the APIIDA API Service Manager. With this, the Gateway Manager can change the following settings, directly on the gateway

    • Cache settings for a node or a service

    • Remove/Add a cluster from a load balancer

    • Show status from backend systems

Authentication

  • Authenticate against a LDAP directory, like MS Active Directory

  • Fallback to local authentication is automatically activated, in case of connection issues to the LDAP directory

Migration

  • Intelligent Mapping of IDs: Mapping of IDs will be done automatically between source and target gateway. If the IDs doesn’t match, the Gateway Manager automatically maps by name.

  • Migrate more services in each migration step to save time.

  • Migrate services and resources to more the one target at once to save time

  • Migrate services or resources to whole environment (or multiple environments)

  • If a variable will be changed in the migration process, the original value of this variable will be shown

  • One-Click-Migration: If the migration overview step isn’t necessary, the option “Execute Migration with Default Settings” can be chosen for a One-Click-Migration

  • Save a migration (including custom mappings and actions) for future use and add a link or description to it. This can also be used for templating a migration

  • Repeat saved migrations for future use

  • Central Migration overview for all migrations, that happened in the past

Gateway Explorer

  • Multi migrate services, additionally to resources, to a target gateway, cluster or environment

  • Migrate more the one resource at once by selecting them

  • Quick selection for resources by name or path

  • Every migration from the Gateway Explorer will use the standard migration flow (including the Migration Overview page)

  • Migration for Resources will be shown in the migration history as well

APIIDA API Gateway Manager gateway integration

  • New and updated APIIDA Assertions with version 2.1, with the following additions:

    • Easier setup by using JDBC connection instead of custom connection setting

    • API to send Logs and Audits to the Gateway Manager. With this, the Gateway Manager can show logs and audit information in the node details

    • Show the gateway version in the APIIDA Discovery API

Installation instruction changed, please check the updated manual: https://apiida.atlassian.net/wiki/spaces/AAGM/pages/7760740363

Miscellaneous

  • Quick Health Check: Show only subset of services from selected cluster

  • Show actual values for metrics in Slack messages

  • A new indicator, that appears on every node if metrics API is not available

  • Include private gateways: These gateways are only available for a specific user. This ca be use for example for local gateways on developer machines.

  • Define retention time for Metrics in the settings. Older metrics will be automatically deleted.

Bugfixes

The following bugs have been fixed in Winter 20:

  • Show all names instead of IDs in the migration overview or on the result page after a migration

  • Target ID in migration overview isn’t missing anymore

  • Edit of Dashboard don’t lead to an edit mode for all pages anymore

  • Add new Widgets automatically saves changes on the dashboard

  • Variables for a Service, that is part of a Solution, are now used for migrations of the Solution as well

  • Many other minor bugfixes

Known Issues

  • APIIDA API Gateway Manager don’t enforce valid git tag names. Invalid tag names won’t be set.