Skip to content

v0.5.0

Compare
Choose a tag to compare
@github-actions github-actions released this 05 Mar 13:09
· 601 commits to main since this release
b240db2

This release includes a lot of fixes and cleanups, along with the new experimental Administration API, aka. Admin API. This is the very first iteration of the API and has limited functionality. For now, only a fraction of what I intended to build is developed, which includes these endpoints. Some or all of them will possibly change in the future.

  • Version returns GatewayD version info.
  • GetGlobalConfig returns global configuration.
  • GetPluginConfig return plugins configuration.
  • GetPlugins returns active plugin information.
  • GetPools returns active pools, their size and capacity.
  • GetProxies returns list of active proxies, along with available and busy connections.
  • GetServers returns list of active servers.

The API is exposed both on gRPC (port 9090) and HTTP (port 8080). The HTTP API includes a gateway to the GRPC endpoints along with a few more endpoints:

  • /v1/GatewayDPluginService/* routes to the gRPC API endpoints mentioned above.
  • /health returns OK status.
  • /version returns GatewayD version. This is like Version endpoint in GRPC, but without version details.
  • /swagger.json returns an OpenAPI v2 specification document in JSON.
  • /swagger-ui/ loads the Swagger UI for swagger.json.

The swagger.json and the Swagger UI endpoints are only available if the GatewayD binary is built with -tags embed_swagger. If is included in the release binary by default. The protobuf file is available at gatewayd/api/v1/api.proto, but it'll be moved to the plugin SDK soon.

The README is updated with the latest information about various components of GatewayD.

What's Changed

Full Changelog: v0.4.5...v0.5.0