Skip to content
|
You are browsing the Kong Gateway documentation archive. This documentation is no longer actively maintained.
See the latest Kong Gateway documentation.
Kong Gateway Enterprise [ARCHIVE]
1.3-x

PermalinkEnable a Plugin

PermalinkIntroduction

This guide walks through enabling a Plugin on Kong Enterprise via Kong Manager, by showing an example configuration of the Rate Limiting Advanced Plugin, the Kong Enterprise version of the popular Kong Rate Limiting Plugin. To learn more about Rate Limiting Advanced, or see how to configure this Plugin via the command line, checkout the Rate Limiting Advanced documentation.

PermalinkPrerequisites

PermalinkHow to Enable a Plugin in Kong Manager

  1. Choose the desired Workspace in Kong Manager and navigate to the Plugins tab under API Gateway.

    Plugins Tab

  2. Click the Add New Plugin button to open the Plugins page, which lists all the Kong Enterprise bundled Plugins available.

    Scroll to the Traffic Control section and select Rate Limiting EE.

    Rate Limiting EE

    This will open the Plugin Configuration form for Rate Limiting EE.

    Configuration Form
    Note that the Plugin will automatically be enabled when the form is submitted. Toggle the This plugin is Enabled button at the top of the form to configure the Plugin without enabling it.

    Toggle Enable

  3. Define the Plugin as global or scoped.

    Global will apply the Plugin to every Service and Route in the Workspace.
    Scoped will apply the Plugin to one Service, Route, and/or Consumer.

    To use this option, select the Scoped radio button and select the desired Service, Route, or Consumer from the dropdown.

    Connect test-service

  4. Fill out the configuration form.

    For Rate Limiting EE the following fields are required:
    -config.limit
    -config.sync_rate
    -config.window_size
    More information on these fields can be found in the Rate Limiting Advanced documentation

    For this example set the required fields to the following: 
       config.limit = 10
   config.sync_rate = 10
   config.window_size = 60

  5. Click the Create button at the bottom of the form to save and enable the Plugin. If it is successful, the page will automatically redirect to the Plugin Overview, with the Rate Limiting Plugin listed.

    Plugin Overview

    If the Plugin is scoped to a Service, Route, or Consumer, the Plugin will also be listed on that object’s Overview page.

    Service Overview