3 minute read
Upgrade YAML configurations made with a Technical Preview release
YAML configuration upgrade is supported in a fully automated way. However, upgrade support to YAML configurations created using a technical preview release, can be performed following these criteria:
- Technical preview releases can be upgraded with manual steps, as described in following sections.
- Any YAML configuration created before API Gateway March 21 update cannot be upgraded.
- The service pack update (
update_apigw.sh) script does not support YAML configuration upgrade prior to API Gateway May 21 update.
Upgrade Technical Preview releases
To upgrade configurations made with a Technical Preview release, perform the following steps:
- Change directory to your configuration root directory.
- Create a file named
- Add the following content to your recently created
--- version: 0.0.0
You are now ready to run the
yamles upgrade command. For more information, see Upgrade YAML configuration.
There is no support for YAML configurations in Policy Studio.
API Gateway Manager web UI
Deployment of YAML configurations via API Gateway Manager web UI is not supported.
- Support of Team development using
yamles importcommand, where you must import each project one at a time.
- No explicit support for project dependencies.
- No explicit support to look for merge conflicts. You must use
_fragment.yamldirectives to manage it.
For more information, see Team development with YAML configuration.
Support of ES Explorer is limited to viewing and editing YAML configurations.
When an entity store is edited via ES Explorer or the entity store API, some fields in other entities might get reordered, creating more
diffs than what was really modified.
It is not yet possible to import or export YAML configuration fragments in ES Explorer, this can only be done using the
The YAML format supports API Manager. However, is not possible to run
setup-apimanager on an API Gateway instance that has a YAML configuration deployed to it. To workaround this limitation:
setup-apimanagerafter deploying an XML federated configuration to your group.
When API Manager is setup, you can create a new project in Policy Studio by downloading the current configuration from the running API Gateway.
If the configuration is downloaded to
~/apiprojects/apimanageryou can convert this XML federated configuration to YAML and build a
yamles fed2yaml federated:file:/home/user/apiprojects/configs.xml -o ~/yamlconfig --targz ~/yamlconfig.tar.gz
yamlconfig.tar.gzto the API Manager enabled instance using
NoteThe format of API Manager data stored in Cassandra is the same regardless of whether a YAML configuration or an XML federated configuration is deployed.
YAML configuration for Node manager is not supported.
API Gateway Analytics
YAML configuration for Analytics is not supported.
You can update the deployment archive package properties by choosing
option 22 of the
managedomain script. For more information, see Updating Deployment Archive Properties.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.