serverless-plugin-kong

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

serverless-plugin-kong

★ 10 Open GitHub ↗

A Serverless framework plugin for configuring a Kong cluster.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# serverless-plugin-kong

[Serverless framework](https://www.serverless.com) plugin to configure a Kong API Gateway cluster.

## Installation

```bash
$ npm install @tropos/serverless-plugin-kong
```

## Usage

Add the plugin to `serverless.yml`

```yaml
# serverless.yml

plugins:
  - serverless-plugin-kong
```

Add an event of type `kong` to your functions in `serverless.yml`. Configure the route with the `route` property. The `aws-lambda` plugin will be automatically configured.

```yaml
# serverless.yml

service: example

functions:
  hello:
    handler: handler.hello
    events:
      - kong:
          route:
            methods:
              - GET
            paths:
              - /
            protocols:
              - http
```

Add configuration options to custom section of `serverless.yml`.

```yaml
# serverless.yml
custom:
  kong:
    admin_api_url: http://localhost:8001
    lambda:
      config:
        aws_key: ${env:AWS_ACCESS_KEY_ID, 'asdf'}
        aws_secret: ${env:AWS_SECRET_ACCESS_KEY, 'asdf'}
```

You can add additional plugins to a route by setting the `plugins` property on the event.
```yaml
functions:
  hello:
    handler: handler.hello
    events:
      - kong:
          route:
            methods:
              - GET
            paths:
              - /
            protocols:
              - http

plugins:
            - name: basic-auth
              enabled: true
              config:
                hide_credentials: true
            - name: correlation-id
              enabled: true
```

## Contributing

Pull requests welcome! Please fork the repo and submit your PR.

serverless-plugin-kong

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README