A CLI utility helper for creating Kusk Gateway API resources from your OpenAPI specification document.

• Usage
  • Flags
  • Example
• Installation
• Updating
• Uninstallation
• Contributing
• License

(Back to top)

Take a look at the http-bin example spec

kgw api generate -i ./examples/httpbin-spec.yaml --name httpbin-api --upstream.service httpbin --upstream.port 8080

The output should contain the following x-kusk extension at the top level

...
x-kusk:
  cors: {}
  path:
    rewrite:
      pattern: ""
      substitution: ""
  upstream:
    service:
	name: httpbin
	namespace: default
	port: 8080

(Back to top)

brew install kubeshop/kusk/kgw

go install github.com/kubeshop/kgw@latest

To install a particular version: replace latest with the version number

You can get a list of the available kgw versions from our releases page

This will install kgw into /usr/local/bin/kgw

bash < <(curl -sSLf https://raw.githubusercontent.com/kubeshop/kgw/main/scripts/install.sh)

git clone [email protected]:kubeshop/kgw.git && \
cd kgw && \
go install

If you don't like automatic scripts you can always use the manual install:

1. Download binary with version of your choice (recent one is recommended)
2. Upack it (tar -zxvf kgw_0.1.0_Linux_arm64.tar.gz)
3. Move it to a location in the PATH. For example mv kgw_0.1.0_Linux_arm64/kgw /usr/local/bin/kgw

For Windows, download the binary from here, unpack the binary and add it to %PATH%.

(Back to top)

brew upgrade kubeshop/kusk/kgw

go install github.com/kubeshop/kgw@$VERSION

Insde of the kgw repository directory

git pull && go install

(Back to top)

Your contributions are always welcome! Please have a look at the contribution guidelines first.

(Back to top)

MIT. Please have a look at the LICENSE for more details.