Skip to content

Commit

Permalink
Merge branch 'main' into api-reference-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pmalek authored Mar 25, 2024
2 parents d20159f + 4041323 commit 84463a9
Show file tree
Hide file tree
Showing 6 changed files with 102 additions and 90 deletions.
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
**What this PR does / why we need it**:

**Which issue this PR fixes**

Fixes #

**Special notes for your reviewer**:

**PR Readiness Checklist**:

Complete these before marking the PR as `ready to review`:

- [ ] the `CHANGELOG.md` release notes have been updated to reflect significant changes
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,42 @@

<img src="./logo/logo.png" alt="KGO logo" title="Kong Gateway Operator" height="150" width="150" />

Kong Gateway Operator is a [Kubernetes Operator][operator-concept] that can manage your Kong Ingress Controller, Kong Gateway Data Planes, or both together when running on Kubernetes.
Kong Gateway Operator is a [Kubernetes Operator][operator-concept] that can manage
your Kong Ingress Controller, Kong Gateway Data Planes, or both together when running
on Kubernetes.

With Kong Gateway Operator, users can:

* Deploy and configure Kong Gateway services
* Customise deployments using PodTemplateSpec to deploy sidecars, set node affinity and more.
* Upgrade Data Planes using a rolling restart or blue/green deployments
* Deploy and configure Kong Gateway services.
* Customise deployments using PodTemplateSpec to deploy sidecars, set node affinity
and more.
* Upgrade Data Planes using a rolling restart or blue/green deployments.

## Current Features

The following features are considered supported:

- Kong Gateway Deployment & Configuration Management using the [Gateway API][gwapi]
- Creation of [Kong Gateways][konggw] using the `DataPlane` API
- [Kong Gateways][konggw] upgrades, downgrades and autoscaling
- Creation of [Kong Ingress Controller][kic] instances using the `ControlPlane` API
- Hybrid Mode Attachment using the `DataPlane` API
- Configuration and management of `AIGateway`s (experimental feature)
* Kong Gateway Deployment & Configuration Management using the [Gateway API][gwapi]
* Creation of [Kong Gateways][konggw] using the `DataPlane` API
* [Kong Gateways][konggw] upgrades, downgrades and autoscaling
* Creation of [Kong Ingress Controller][kic] instances using the `ControlPlane` API
* Hybrid Mode Attachment using the `DataPlane` API
* Configuration and management of `AIGateway`s (experimental feature)

See our [Features Page](/FEATURES.md) for details on these capabilities.

## Quick Start and documentation

If you are eager to start with the operator, you can visit the quick start [section][docsqs]
of the documentation. Alternatively, the complete [docs][docs] provide a full and detailed
description of how to thoroughly use this project.
of the documentation. Alternatively, the complete [docs][docs] provide a full and
detailed description of how to thoroughly use this project.

## Development

### Prerequisites

In order to build the operator you'll have to have Go installed on your machine.
In order to do so, follow instructions on [its website][go-dev-site].
In order to do so, follow the instructions on its website][go-dev-site].

### Build process

Expand All @@ -46,7 +49,7 @@ make build

This `Makefile` target will take care of everything from generating client side code,
generating Kubernetes manifests, downloading the dependencies and the tools used
in the build process and finally it will build the binary.
in the build process and finally, it will build the binary.

After this step has finished successfully you should see the operator's binary `bin/manager`.

Expand Down
44 changes: 22 additions & 22 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ require (
github.com/google/uuid v1.6.0
github.com/kong/kubernetes-ingress-controller/v3 v3.1.2
github.com/kong/kubernetes-telemetry v0.1.3
github.com/kong/kubernetes-testing-framework v0.45.0
github.com/kong/kubernetes-testing-framework v0.46.0
github.com/kong/semver/v4 v4.0.1
github.com/kr/pretty v0.3.1
github.com/samber/lo v1.39.0
Expand All @@ -39,6 +39,7 @@ require (
github.com/kong/go-kong v0.51.1-0.20240125175037-0c077f5b9ac7 // indirect
github.com/kr/text v0.2.0 // indirect
github.com/mitchellh/mapstructure v1.5.0 // indirect
github.com/moby/docker-image-spec v1.3.1 // indirect
github.com/moby/spdystream v0.2.0 // indirect
github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f // indirect
github.com/onsi/ginkgo/v2 v2.15.0 // indirect
Expand All @@ -47,33 +48,33 @@ require (
github.com/rogpeppe/go-internal v1.12.0 // indirect
github.com/tidwall/gjson v1.17.0 // indirect
github.com/tidwall/match v1.1.1 // indirect
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.47.0 // indirect
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.47.0 // indirect
go.opentelemetry.io/otel v1.22.0 // indirect
go.opentelemetry.io/otel/metric v1.22.0 // indirect
go.opentelemetry.io/otel/trace v1.22.0 // indirect
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.49.0 // indirect
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 // indirect
go.opentelemetry.io/otel v1.24.0 // indirect
go.opentelemetry.io/otel/metric v1.24.0 // indirect
go.opentelemetry.io/otel/trace v1.24.0 // indirect
go4.org/netipx v0.0.0-20230728184502-ec4c8b891b28 // indirect
golang.org/x/mod v0.14.0 // indirect
golang.org/x/tools v0.17.0 // indirect
google.golang.org/genproto/googleapis/api v0.0.0-20240125205218-1f4bbc51befe // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20240125205218-1f4bbc51befe // indirect
google.golang.org/genproto/googleapis/api v0.0.0-20240311132316-a219d84964c2 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20240314234333-6e1732d8331c // indirect
gopkg.in/evanphx/json-patch.v5 v5.6.0 // indirect
k8s.io/apiserver v0.29.3 // indirect
k8s.io/utils v0.0.0-20240102154912-e7106e64919e // indirect
)

require (
cloud.google.com/go/compute v1.23.3 // indirect
cloud.google.com/go/compute v1.24.0 // indirect
cloud.google.com/go/compute/metadata v0.2.3 // indirect
cloud.google.com/go/container v1.30.1 // indirect
cloud.google.com/go/container v1.33.1 // indirect
github.com/evanphx/json-patch/v5 v5.9.0 // indirect
github.com/gammazero/deque v0.2.0 // indirect
github.com/gammazero/workerpool v1.1.3 // indirect
github.com/go-errors/errors v1.4.2 // indirect
github.com/google/certificate-transparency-go v1.1.7 // indirect
github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
github.com/googleapis/enterprise-certificate-proxy v0.3.2 // indirect
github.com/googleapis/gax-go/v2 v2.12.0 // indirect
github.com/googleapis/gax-go/v2 v2.12.3 // indirect
github.com/jmoiron/sqlx v1.3.5 // indirect
github.com/monochromegane/go-gitignore v0.0.0-20200626010858-205db1a8cc00 // indirect
github.com/puzpuzpuz/xsync/v2 v2.5.1 // indirect
Expand All @@ -83,12 +84,11 @@ require (
github.com/zmap/zlint/v3 v3.5.0 // indirect
go.opencensus.io v0.24.0 // indirect
go.starlark.net v0.0.0-20230525235612-a134d8f9ddca // indirect
golang.org/x/crypto v0.19.0 // indirect
golang.org/x/crypto v0.21.0 // indirect
golang.org/x/sync v0.6.0 // indirect
google.golang.org/api v0.162.0 // indirect
google.golang.org/genproto v0.0.0-20240116215550-a9fa1716bcac // indirect
google.golang.org/grpc v1.61.0 // indirect
sigs.k8s.io/kind v0.21.0 // indirect
google.golang.org/api v0.171.0 // indirect
google.golang.org/grpc v1.62.1 // indirect
sigs.k8s.io/kind v0.22.0 // indirect
sigs.k8s.io/kustomize/api v0.16.0
sigs.k8s.io/kustomize/kyaml v0.16.0 // indirect
)
Expand All @@ -99,7 +99,7 @@ require (
github.com/blang/semver/v4 v4.0.0 // indirect
github.com/cespare/xxhash/v2 v2.2.0 // indirect
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
github.com/docker/docker v25.0.3+incompatible // indirect
github.com/docker/docker v26.0.0+incompatible // indirect
github.com/docker/go-connections v0.5.0 // indirect
github.com/docker/go-units v0.5.0 // indirect
github.com/emicklei/go-restful/v3 v3.11.0 // indirect
Expand Down Expand Up @@ -135,10 +135,10 @@ require (
github.com/tidwall/pretty v1.2.1
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.27.0
golang.org/x/net v0.20.0 // indirect
golang.org/x/oauth2 v0.16.0 // indirect
golang.org/x/sys v0.17.0 // indirect
golang.org/x/term v0.17.0 // indirect
golang.org/x/net v0.22.0 // indirect
golang.org/x/oauth2 v0.18.0 // indirect
golang.org/x/sys v0.18.0 // indirect
golang.org/x/term v0.18.0 // indirect
golang.org/x/text v0.14.0 // indirect
golang.org/x/time v0.5.0 // indirect
gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
Expand All @@ -147,7 +147,7 @@ require (
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/yaml.v2 v2.4.0
gopkg.in/yaml.v3 v3.0.1 // indirect
k8s.io/apiextensions-apiserver v0.29.1
k8s.io/apiextensions-apiserver v0.29.3
k8s.io/component-base v0.29.3 // indirect
k8s.io/klog/v2 v2.110.1 // indirect
k8s.io/kube-openapi v0.0.0-20240103051144-eec4567ac022 // indirect
Expand Down
Loading

0 comments on commit 84463a9

Please sign in to comment.