gloogateway

Documentation

Index

• func ValidateContext(context *Context, manifestValidator func(string, string) error) error
• func ValidateGlooGatewayContext(context *Context) error
• type AwsOptions
• type Clients
  • func (c *Clients) GatewayClient() gatewayv1.GatewayClient
  • func (c *Clients) RateLimitConfigClient() v1alpha1.RateLimitConfigClient
  • func (c *Clients) RouteOptionClient() gatewayv1.RouteOptionClient
  • func (c *Clients) ServiceClient() skkube.ServiceClient
  • func (c *Clients) UpstreamClient() v1.UpstreamClient
  • func (c *Clients) VirtualHostOptionClient() gatewayv1.VirtualHostOptionClient
  • func (c *Clients) VirtualServiceClient() gatewayv1.VirtualServiceClient
• type Context
• type ResourceClients
  • func NewResourceClients(ctx context.Context, clusterCtx *cluster.Context) (ResourceClients, error)

Functions

func ValidateContext

func ValidateContext(context *Context, manifestValidator func(string, string) error) error

ValidateContext returns an error if the provided Context is invalid This accepts a manifestValidator so that it can be used by Gloo Gateway Enterprise

func ValidateGlooGatewayContext

func ValidateGlooGatewayContext(context *Context) error

ValidateGlooGatewayContext returns an error if the provided Context is invalid

Types

type AwsOptions

type AwsOptions struct {
	// corresponds to the `settings.aws.enableServiceAccountCredentials` helm value
	EnableServiceAccountCredentials bool

	// corresponds to the `settings.aws.stsCredentialsRegion` helm value
	StsCredentialsRegion string
}

AWS options that the installation was configured with

type Clients

type Clients struct {
	// contains filtered or unexported fields
}

func (*Clients) GatewayClient

func (c *Clients) GatewayClient() gatewayv1.GatewayClient

func (*Clients) RateLimitConfigClient

func (c *Clients) RateLimitConfigClient() v1alpha1.RateLimitConfigClient

func (*Clients) RouteOptionClient

func (c *Clients) RouteOptionClient() gatewayv1.RouteOptionClient

func (*Clients) ServiceClient

func (c *Clients) ServiceClient() skkube.ServiceClient

func (*Clients) UpstreamClient

func (c *Clients) UpstreamClient() v1.UpstreamClient

func (*Clients) VirtualHostOptionClient

func (c *Clients) VirtualHostOptionClient() gatewayv1.VirtualHostOptionClient

func (*Clients) VirtualServiceClient

func (c *Clients) VirtualServiceClient() gatewayv1.VirtualServiceClient

type Context

type Context struct {
	InstallNamespace string

	// ProfileValuesManifestFile points to the file that contains the set of Helm values for a given profile
	// This is intended to represent a set of "production recommendations" and is defined as a standalone
	// file, to guarantee that tests specify a file that contains these values
	// For a test to define Helm values that are unique to the test, use ValuesManifestFile
	ProfileValuesManifestFile string

	// ValuesManifestFile points to the file that contains the set of Helm values that are unique to this test
	ValuesManifestFile string

	// whether or not the K8s Gateway controller is enabled
	K8sGatewayEnabled bool

	// whether or not the installation is an enterprise installation
	IsEnterprise bool

	// whether or not the validation webhook is configured to always accept resources,
	// i.e. if this is set to true, the webhook will accept regardless of errors found during validation
	ValidationAlwaysAccept bool

	// is populated if the installation has any AWS options configured (via `settings.aws.*` Helm values)
	AwsOptions *AwsOptions

	// TestAssetDir is the directory holding the test assets. Must be relative to RootDir.
	TestAssetDir string

	// Helm chart name
	HelmChartName string

	// Name of the helm index file name
	HelmRepoIndexFileName string

	// Install a released version of Gloo. This is the value of the github tag that may have a leading 'v'
	ReleasedVersion string

	// The version of the Helm chart. Calculated from either the chart or the released version. It will not have a leading 'v'
	ChartVersion string

	// The path to the local helm chart used for testing. Based on the TestAssertDir and relative to RootDir.
	ChartUri string
}

Context contains the set of properties for a given installation of Gloo Gateway

type ResourceClients

type ResourceClients interface {
	RouteOptionClient() gatewayv1.RouteOptionClient
	VirtualHostOptionClient() gatewayv1.VirtualHostOptionClient
	ServiceClient() skkube.ServiceClient
	UpstreamClient() v1.UpstreamClient
	VirtualServiceClient() gatewayv1.VirtualServiceClient
	RateLimitConfigClient() v1alpha1.RateLimitConfigClient
	GatewayClient() gatewayv1.GatewayClient
}

ResourceClients is a set of clients for interacting with the Edge resources

func NewResourceClients

func NewResourceClients(ctx context.Context, clusterCtx *cluster.Context) (ResourceClients, error)