gwctl

gwctl is a command-line tool for managing and inspecting Kubernetes Gateway API resources. It is a perfect companion for viewing, describing, and analyzing a Gateway API installation managed by Airlock Microgateway.

Notice

gwctl is still in an early development stage.

  • Use the tool primarily for read-only operations.

Prerequisites

  • The Kubernetes Gateway API CRDs are deployed in the cluster.
  • You have a valid kubeconfig and can access the cluster with kubectl.
  • gwctl version 0.2.0 or newer is installed.

Installation

macOS and Linux (Homebrew)

Install gwctl using Homebrew:

1

brew install gwctl

Windows

Download a suitable binary from the gwctl release artifacts on GitHub.

Basic usage examples

Get help and overview

For a quick overview of available commands and options:

1

gwctl help

List Gateways

To list Gateway resources, including key status information:

1

gwctl get gateway -A -o wide

Example output:

1
2

NAMESPACE   NAME        CLASS                   ADDRESSES    PORTS        PROGRAMMED  AGE    POLICIES  HTTPROUTES
example-ns  mygateway   airlock-microgateway    100.126.1.2  80,443,8443  True        4h28m  0         3

List HTTPRoutes

To list HTTPRoute resources:

1

gwctl get httproute -A -o wide

Example output:

1
2
3
4

NAMESPACE   NAME         HOSTNAMES  PARENT REFS  ACCEPTED  RESOLVED  AGE  POLICIES
example-ns  backend      None       1            True      True      30m  3
example-ns  backend-tls  None       2            True      True      30m  3
example-ns  example-rt   None       1            True      True      30m  1

Further information