Upload and Deploy Gateway Bundles

You can upload and deploy Gateway bundles as part of the bundle management workflow. You can also undeploy, redeploy, delete, view details for, and update your Gateway bundles.
Typically, this workflow is intended for Portal Admins.

Upload a Gateway Bundle to API Portal

Prerequisites:
Ensure that you have the metadata, bundle, and delete bundle files ready. Maximum size per file is 15 MB.
Follow these steps:
  1. Log in to
    Layer7 API Developer Portal
    as Portal Admin.
  2. From the menu bar, select
    Manage
    ,
    Gateway Bundles
    .
  3. Select
    Add Bundle
    .
  4. Drag and drop the files into the uploader window, or click the uploader window and select and upload your files.
  5. Select
    Save
    . The files are uploaded and are listed on the page.
  • The bundle name must be unique. Do not change the bundle file name. The combination of group name, name, and version must be unique.
  • You can update a Gateway bundle by uploading a new build of the bundle to
    Layer7 API Developer Portal
    . For more information, see Update a Gateway Bundle.
  • You cannot import the same policy twice. If encapsulated assertions with the same attributes already exist in
    Layer7 API Developer Portal
    , an error message is shown.
  • For bundles of the encapsulated assertion type (the
    l7template
    field value must equal "true" in the metadata file),
    Layer7 API Developer Portal
    creates a policy template so that different APIs can reuse the policy.
  • Layer7 API Developer Portal
    does not support the Service bundle type, and
    Layer7 API Developer Portal
    rejects the upload of this bundle type.

Deploy a Gateway Bundle to a Proxy

Follow these steps:
  1. From the
    Gateway Bundles
    page, select the bundle that you want to deploy.
  2. Select the
    Gateway Bundle Deployments
    tab. The cards show the deployment status of the bundle on all proxies.
  3. Select the proxy for which you would like to deploy the Gateway bundle, and then select
    Deploy
    .

Undeploy and Redeploy a Gateway Bundle

Prerequisites:
Before undeploying a bundle from a proxy, ensure that:
  • No API referencing the bundle's policy template is currently deployed, or
  • Any API recently detached from the policy template has been redeployed, i.e. no legacy policy template reference remains on the proxy.
The following scenarios will result in an error:
  • The bundle is undeployed while a deployed API is still associated with the policy template. The API throws an error when requests are made to this API.
  • An API is detached from the policy template, but has not been redeployed to the specific on-demand proxy. Although you are able to undeploy the bundle, the proxy will throw an error.
Follow these steps:
  1. From the
    Gateway Bundles
    page, select the bundle that you want to undeploy or redeploy.
  2. Select the
    Gateway Bundle Deployments
    tab. The cards show the deployment status of the bundle on all proxies.
  3. Select the proxy for which you would like to undeploy or redeploy the Gateway bundle, and then select
    Undeploy
    or
    Redeploy
    .

Delete a Gateway Bundle

Prerequisites:
  • The bundle is not deployed to a proxy. If it is, undeploy the bundle from all proxies.
  • No API is referencing the bundle's policy template. If it is, disassociate the API from the policy template. For more information, see Associate and Deploy Policy Templates.
Follow these steps:
  1. From the
    Gateway Bundles
    page, select the bundle that you want to delete.
  2. Select
    Actions
    ,
    Delete Bundle
    .

View the Gateway Bundle Details

As a Portal Admin, you can view the list of Gateway bundles that have been imported into
Layer7 API Developer Portal
, along with these details:
Metadata
View the bundle's details by selecting the
Metadata
tab. Details include bundle type, extracted policy template, APIs consuming the bundle, date of creation, group name, and bundle description.
You can download and view the bundle's metadata file to resolve any possible conflict of subsequent bundle version uploads. To download the metadata file, go to
Metadata > Assets > Download
.
Deployments
View bundle deployment details by selecting the
Gateway Bundle Deployments
tab. The cards show the last updated time (when the bundle was deployed), the bundle version and build that is currently deployed, and the deployment state of the bundle:
  • Deployed
    - the bundle is deployed to the proxy.
  • Not Deployed
    - the bundle has not been deployed to the proxy.
  • Pending Deployment
    - the deployment of the bundle to the proxy is pending.
  • Pending Undeployment
    - the undeployment of the bundle to the proxy is pending.
Click
More Info
to view deployment errors. The deployment shows the proxy's Restman service response.
APIs
View the list of APIs referencing the bundle by selecting the
APIs
tab. This is particularly useful before undeploying or redeploying a bundle. You can filter APIs referencing the bundle by API name, the proxies to which it is deployed, and the API state.
The APIs tab only shows for a Gateway bundle of the Encapsulated Assertion type.

Update a Gateway Bundle

You can update a Gateway bundle version by uploading a new build of the bundle to
Layer7 API Developer Portal
.
Prerequisites:
  • The bundle is of the encapsulated assertion type and the l7template field value must equal to
    "true"
    in the metadata file.
  • The <versionbuild> in the filename is different from the previous version.
  • The <versionmajor> and <versionminor> in the filename are identical to the previous version. See Manage Policy with Gateway Bundles for more information on bundle naming standards.
  • The groupName, name, and moduleName are identical to the previous version.
The following restrictions apply:
  • If you upload a new version instead of a new build of a Gateway bundle, it is treated as a different bundle and an in-place update will not be possible.
  • Uploading a new build of a bundle’s version overwrites the older build, but does not do so automatically on the proxy. The older build will still be deployed until you choose to perform bundle update on your selected proxy.
  • Updating a bundle to the latest build on a proxy automatically redeploys the bundle on the selected proxy. This process cannot be reverted.
  • Upon redeployment, APIs referencing the policy template associated with the bundle will be automatically updated.
Follow these steps:
  1. Upload a new build of your specified Gateway bundle version. For upload instructions, see Upload a Gateway Bundle to API Portal.
    If the prerequisites are not met, a validation error will appear.
  2. From the list of Gateway bundles, click the bundle that you want to update.
  3. Select the
    Gateway Bundle Deployments
    tab. The cards show the registered proxies. If a proxy is still using an older build of the bundle, an
    Update
    option appears in the proxy card, along with version information.
  4. Click
    Update
    . Confirm your selection when prompted.
    Click
    More Info
    to view any deployment error. The deployment shows the proxy's Restman service response.