gloo/

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/solo-io/gloo

README ¶

Gloo

Build

All make targets are currently defined in the Makefile at the root of the repository.

The VERSION env variable determines the name of the tag for the image.

You may either inject the version yourself:

VERSION=<version name> make gloo-docker -B

Or rely on the auto-generated version:

make gloo-docker -B

Release

During a Gloo Edge release, the gloo image is published to the Google Cloud Registry and the Quay repository.

Components

xDS Server

Gloo sends Envoy dynamic configuration via the xDS protocol. The Gloo xDS package contains relevant code for serving dynamic configuration.

Testing

Tests are run using Ginkgo.

make test is the entrypoint for running the unit tests in the TEST_PKG

To run all tests in this project:

TEST_PKG=projects/gloo make test

To run a specific subset of tests, read the Ginkgo docs around focusing tests

TEST_PKG=projects/gloo/pkg make test

Directories ¶

Path	Synopsis
api
external/solo/ratelimit
cli
cmd
cmd/docs
pkg/argsutils
pkg/cmd
pkg/cmd/add
pkg/cmd/check
pkg/cmd/check-crds
pkg/cmd/check/internal
pkg/cmd/create
pkg/cmd/create/authconfig
pkg/cmd/create/secret
pkg/cmd/dashboard
pkg/cmd/debug
pkg/cmd/del
pkg/cmd/demo
pkg/cmd/edit
pkg/cmd/edit/options
pkg/cmd/edit/route
pkg/cmd/edit/route/options
pkg/cmd/edit/route/ratelimit
pkg/cmd/edit/settings
pkg/cmd/edit/settings/ratelimit
pkg/cmd/edit/upstream
pkg/cmd/edit/virtualservice
pkg/cmd/federation
pkg/cmd/federation/list
pkg/cmd/federation/register
pkg/cmd/gateway
pkg/cmd/get
pkg/cmd/initpluginmanager
pkg/cmd/install
pkg/cmd/install/kubegateway
pkg/cmd/install/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/cmd/istio
pkg/cmd/istio/sidecars
pkg/cmd/options
pkg/cmd/options/contextoptions
pkg/cmd/plugin
pkg/cmd/plugin/list
pkg/cmd/remove
pkg/cmd/route
pkg/cmd/upgrade
pkg/cmd/version
pkg/cmd/version/mocks Package mock_version is a generated GoMock package.	Package mock_version is a generated GoMock package.
pkg/cmdutils
pkg/common
pkg/constants
pkg/flagutils
pkg/helpers
pkg/kubegatewayutils
pkg/prerun
pkg/printers
pkg/surveyutils
pkg/testutils
pkg/xdsinspection
cmd
constants
pkg
api/compress
api/config/tap/output_sink/v3
api/converters/kube
api/external/envoy/annotations
api/external/envoy/api/v2/cluster
api/external/envoy/api/v2/core
api/external/envoy/api/v2/route
api/external/envoy/config/common/mutation_rules/v3
api/external/envoy/config/core/v3
api/external/envoy/config/filter/http/gzip/v2
api/external/envoy/config/filter/listener/tls_cipher_inspector/v3
api/external/envoy/config/matching/custom_matchers/server_name/v3
api/external/envoy/config/matching/inputs/cipher_detection_input/v3
api/external/envoy/config/route/v3
api/external/envoy/config/trace/v3
api/external/envoy/extensions/advanced_http
api/external/envoy/extensions/aws
api/external/envoy/extensions/cache/grpc
api/external/envoy/extensions/extauth
api/external/envoy/extensions/filters/http/buffer/v3
api/external/envoy/extensions/filters/http/csrf/v3
api/external/envoy/extensions/filters/http/ext_proc/v3
api/external/envoy/extensions/filters/http/graphql/v2
api/external/envoy/extensions/filters/http/jwt_authn/v3
api/external/envoy/extensions/filters/http/wasm/v3
api/external/envoy/extensions/http_path
api/external/envoy/extensions/jwt
api/external/envoy/extensions/proxylatency
api/external/envoy/extensions/transformation
api/external/envoy/extensions/transformation_ee
api/external/envoy/extensions/transformers/xslt
api/external/envoy/extensions/upstream_wait
api/external/envoy/extensions/waf
api/external/envoy/extensions/wasm/v3
api/external/envoy/extensions/xff_offset
api/external/envoy/type
api/external/envoy/type/matcher/v3
api/external/envoy/type/metadata/v3
api/external/envoy/type/tracing/v3
api/external/envoy/type/v3
api/external/solo/ratelimit
api/external/udpa/annotations
api/grpc/debug
api/grpc/validation
api/grpc/version
api/v1
api/v1/core/matchers
api/v1/core/selectors
api/v1/enterprise
api/v1/enterprise/options/caching
api/v1/enterprise/options/dlp
api/v1/enterprise/options/extauth/v1
api/v1/enterprise/options/extauth/v1/kube/apis/enterprise.gloo.solo.io/v1 Package v1 is the v1 version of the API.	Package v1 is the v1 version of the API.
api/v1/enterprise/options/extauth/v1/kube/client/clientset/versioned This package has the automatically generated clientset.	This package has the automatically generated clientset.
api/v1/enterprise/options/extauth/v1/kube/client/clientset/versioned/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
api/v1/enterprise/options/extauth/v1/kube/client/clientset/versioned/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
api/v1/enterprise/options/extauth/v1/kube/client/clientset/versioned/typed/enterprise.gloo.solo.io/v1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
api/v1/enterprise/options/extauth/v1/kube/client/clientset/versioned/typed/enterprise.gloo.solo.io/v1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
api/v1/enterprise/options/extauth/v1/kube/client/informers/externalversions
api/v1/enterprise/options/extauth/v1/kube/client/informers/externalversions/enterprise.gloo.solo.io
api/v1/enterprise/options/extauth/v1/kube/client/informers/externalversions/enterprise.gloo.solo.io/v1
api/v1/enterprise/options/extauth/v1/kube/client/informers/externalversions/internalinterfaces
api/v1/enterprise/options/extauth/v1/kube/client/listers/enterprise.gloo.solo.io/v1
api/v1/enterprise/options/extproc
api/v1/enterprise/options/gcp
api/v1/enterprise/options/graphql/v1beta1
api/v1/enterprise/options/graphql/v1beta1/kube/apis/enterprise.gloo.solo.io/v1beta1 Package v1beta1 is the v1beta1 version of the API.	Package v1beta1 is the v1beta1 version of the API.
api/v1/enterprise/options/graphql/v1beta1/kube/apis/graphql.gloo.solo.io/v1beta1 Package v1beta1 is the v1beta1 version of the API.	Package v1beta1 is the v1beta1 version of the API.
api/v1/enterprise/options/jwt
api/v1/enterprise/options/ratelimit
api/v1/enterprise/options/rbac
api/v1/enterprise/options/stateful_session
api/v1/enterprise/options/waf
api/v1/filters
api/v1/gloosnapshot
api/v1/gloosnapshot/kube/apis/gloosnapshot.gloo.solo.io/gloosnapshot Package gloosnapshot is the gloosnapshot version of the API.	Package gloosnapshot is the gloosnapshot version of the API.
api/v1/kube/apis/gloo.solo.io/v1 Package v1 is the v1 version of the API.	Package v1 is the v1 version of the API.
api/v1/kube/client/clientset/versioned This package has the automatically generated clientset.	This package has the automatically generated clientset.
api/v1/kube/client/clientset/versioned/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
api/v1/kube/client/clientset/versioned/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
api/v1/kube/client/clientset/versioned/typed/gloo.solo.io/v1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
api/v1/kube/client/clientset/versioned/typed/gloo.solo.io/v1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
api/v1/kube/client/informers/externalversions
api/v1/kube/client/informers/externalversions/gloo.solo.io
api/v1/kube/client/informers/externalversions/gloo.solo.io/v1
api/v1/kube/client/informers/externalversions/internalinterfaces
api/v1/kube/client/listers/gloo.solo.io/v1
api/v1/options
api/v1/options/advanced_http
api/v1/options/als
api/v1/options/aws
api/v1/options/aws/ec2
api/v1/options/azure
api/v1/options/connection_limit
api/v1/options/consul
api/v1/options/cors
api/v1/options/dynamic_forward_proxy
api/v1/options/faultinjection
api/v1/options/graphql
api/v1/options/grpc
api/v1/options/grpc_json
api/v1/options/grpc_web
api/v1/options/hcm
api/v1/options/header_validation
api/v1/options/headers
api/v1/options/healthcheck
api/v1/options/kubernetes
api/v1/options/lbhash
api/v1/options/local_ratelimit
api/v1/options/pipe
api/v1/options/protocol
api/v1/options/protocol_upgrade
api/v1/options/proxy_protocol
api/v1/options/rest
api/v1/options/retries
api/v1/options/router
api/v1/options/shadowing
api/v1/options/static
api/v1/options/stats
api/v1/options/tap
api/v1/options/tcp
api/v1/options/tracing
api/v1/options/transformation
api/v1/options/wasm
api/v1/ssl
bootstrap
bootstrap/clients
bootstrap/clients/vault
bootstrap/clients/vault/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
debug
defaults
discovery
discovery/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
plugins
plugins/als
plugins/aws
plugins/aws/ec2
plugins/aws/ec2/util
plugins/azure
plugins/basicroute
plugins/buffer
plugins/connection_limit
plugins/consul
plugins/consul/mocks Package mock_consul is a generated GoMock package.	Package mock_consul is a generated GoMock package.
plugins/cors
plugins/csrf
plugins/custom_filters
plugins/deprecated_cipher_passthrough
plugins/dynamic_forward_proxy
plugins/enterprise_warning Package enterprise_warning creates the EnterpriseWarning plugin.	Package enterprise_warning creates the EnterpriseWarning plugin.
plugins/extauth
plugins/faultinjection
plugins/grpc
plugins/grpcjson
plugins/grpcweb
plugins/gzip
plugins/hcm
plugins/headers
plugins/healthcheck
plugins/internal/common
plugins/istio_automtls
plugins/istio_integration
plugins/kubernetes
plugins/kubernetes/mocks Package mock_kubernetes is a generated GoMock package.	Package mock_kubernetes is a generated GoMock package.
plugins/kubernetes/serviceconverter
plugins/linkerd
plugins/listener
plugins/loadbalancer
plugins/local_ratelimit
plugins/metadata
plugins/pipe
plugins/pluginutils
plugins/protocoloptions
plugins/proxyprotocol
plugins/ratelimit
plugins/registry Package registry is responsible for managing	Package registry is responsible for managing
plugins/rest
plugins/shadowing
plugins/static
plugins/stats
plugins/tcp
plugins/tls_inspector
plugins/tracing
plugins/transformation
plugins/tunneling
plugins/upstreamconn
plugins/utils
plugins/utils/headers
plugins/utils/httpprotocolhelpers
plugins/utils/httpprotocolvalidation
plugins/utils/transformation
plugins/utils/upgradeconfig
plugins/utils/upstreamproxyprotocol
plugins/utils/validator
plugins/virtualhost
servers/admin
servers/iosnapshot
setup
syncer
syncer/extauth
syncer/ratelimit
syncer/sanitizer
syncer/setup
syncer/stats
syncer/validation
translator
upstreams
upstreams/NoOpUpstreamClient
upstreams/consul
upstreams/consul/mocks Package mock_consul is a generated GoMock package.	Package mock_consul is a generated GoMock package.
upstreams/kubernetes
utils
utils/aws
utils/mocks Package mock_utils is a generated GoMock package.	Package mock_utils is a generated GoMock package.
utils/validation
validation
xds Package server provides an implementation of a streaming xDS server.	Package server provides an implementation of a streaming xDS server.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL