bootstrap

Documentation

Index

• Constants
• Variables
• func ArtifactFactoryForSettings(ctx context.Context, settings *v1.Settings, ...) (factory.ResourceClientFactory, error)
• func ConfigFactoryForSettings(params ConfigFactoryParams, resourceCrd crd.Crd) (factory.ResourceClientFactory, error)
• func ConsulClientForSettings(ctx context.Context, settings *v1.Settings) (*api.Client, error)
• func GetWriteNamespace(settings *v1.Settings) string
• func KubeServiceClientForSettings(ctx context.Context, settings *v1.Settings, ...) (skkube.ServiceClient, error)
• func NewVaultSecretClientFactory(client *api.Client, pathPrefix, rootKey string) factory.ResourceClientFactory
• func SecretFactoryForSettings(ctx context.Context, settings *v1.Settings, ...) (factory.ResourceClientFactory, error)
• func ValidateBootstrap(ctx context.Context, settings *v1.Settings, filterName string, ...) error
• func VaultClientForSettings(vaultSettings *v1.Settings_VaultSecrets) (*api.Client, error)
• type ConfigFactoryParams
  • func NewConfigFactoryParams(settings *v1.Settings, sharedCache memory.InMemoryResourceCache, ...) ConfigFactoryParams
• type Consul
• type ControlPlane
• type GrpcService
• type Opts
• type ProxyDebugServer
• type ValidationServer

Constants

const DefaultPathPrefix = "secret"

The DefaultPathPrefix may be overridden to allow for non-standard vault mount paths

const DefaultRootKey = "gloo"

used for vault and consul key-value storage

Variables

var DefaultQueryOptions = &consulapi.QueryOptions{RequireConsistent: true, AllowStale: false}

default query options for consul

Functions

func ArtifactFactoryForSettings

func ArtifactFactoryForSettings(ctx context.Context,
	settings *v1.Settings,
	sharedCache memory.InMemoryResourceCache,
	cfg **rest.Config,
	clientset *kubernetes.Interface,
	kubeCoreCache *cache.KubeCoreCache,
	consulClient *consulapi.Client,
	pluralName string) (factory.ResourceClientFactory, error)

sharedCach OR resourceCrd+cfg must be non-nil

func ConfigFactoryForSettings

func ConfigFactoryForSettings(params ConfigFactoryParams, resourceCrd crd.Crd) (factory.ResourceClientFactory, error)

sharedCache, resourceCrd+cfg OR consulClient must be non-nil

func ConsulClientForSettings

func ConsulClientForSettings(ctx context.Context, settings *v1.Settings) (*api.Client, error)

func GetWriteNamespace

func GetWriteNamespace(settings *v1.Settings) string

func KubeServiceClientForSettings

func KubeServiceClientForSettings(ctx context.Context,
	settings *v1.Settings,
	sharedCache memory.InMemoryResourceCache,
	cfg **rest.Config,
	clientset *kubernetes.Interface,
	kubeCoreCache *cache.KubeCoreCache) (skkube.ServiceClient, error)

func NewVaultSecretClientFactory

func NewVaultSecretClientFactory(client *api.Client, pathPrefix, rootKey string) factory.ResourceClientFactory

NewVaultSecretClientFactory consumes a vault client along with a set of basic configurations for retrieving info with the client

func SecretFactoryForSettings

func SecretFactoryForSettings(ctx context.Context,
	settings *v1.Settings,
	sharedCache memory.InMemoryResourceCache,
	cfg **rest.Config,
	clientset *kubernetes.Interface,
	kubeCoreCache *cache.KubeCoreCache,
	vaultClient *vaultapi.Client,
	pluralName string) (factory.ResourceClientFactory, error)

sharedCache OR resourceCrd+cfg must be non-nil

func ValidateBootstrap

func ValidateBootstrap(
	ctx context.Context,
	settings *v1.Settings,
	filterName string,
	msg proto.Message,
) error

func VaultClientForSettings

func VaultClientForSettings(vaultSettings *v1.Settings_VaultSecrets) (*api.Client, error)

Types

type ConfigFactoryParams

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

func NewConfigFactoryParams

func NewConfigFactoryParams(settings *v1.Settings,
	sharedCache memory.InMemoryResourceCache,
	cache kube.SharedCache,
	cfg **rest.Config,
	consulClient *consulapi.Client) ConfigFactoryParams

type Consul

type Consul struct {
	ConsulWatcher      consul.ConsulWatcher
	DnsServer          string
	DnsPollingInterval *time.Duration
}

type ControlPlane

type ControlPlane struct {
	*GrpcService
	SnapshotCache cache.SnapshotCache
	XDSServer     server.Server
}

type GrpcService

type GrpcService struct {
	Ctx             context.Context
	BindAddr        net.Addr
	GrpcServer      *grpc.Server
	StartGrpcServer bool
}

type Opts

type Opts struct {
	WriteNamespace               string
	StatusReporterNamespace      string
	WatchNamespaces              []string
	Upstreams                    factory.ResourceClientFactory
	KubeServiceClient            skkube.ServiceClient
	UpstreamGroups               factory.ResourceClientFactory
	Proxies                      factory.ResourceClientFactory
	Secrets                      factory.ResourceClientFactory
	Artifacts                    factory.ResourceClientFactory
	AuthConfigs                  factory.ResourceClientFactory
	RateLimitConfigs             factory.ResourceClientFactory
	GraphQLApis                  factory.ResourceClientFactory
	VirtualServices              factory.ResourceClientFactory
	RouteTables                  factory.ResourceClientFactory
	Gateways                     factory.ResourceClientFactory
	MatchableHttpGateways        factory.ResourceClientFactory
	VirtualHostOptions           factory.ResourceClientFactory
	RouteOptions                 factory.ResourceClientFactory
	KubeClient                   kubernetes.Interface
	Consul                       Consul
	WatchOpts                    clients.WatchOpts
	DevMode                      bool
	ControlPlane                 ControlPlane
	ValidationServer             ValidationServer
	ProxyDebugServer             ProxyDebugServer
	Settings                     *v1.Settings
	KubeCoreCache                corecache.KubeCoreCache
	ValidationOpts               *gwtranslator.ValidationOpts
	ReadGatwaysFromAllNamespaces bool
	GatewayControllerEnabled     bool
	ProxyCleanup                 func()
}

type ProxyDebugServer

type ProxyDebugServer struct {
	*GrpcService
	Server debug.ProxyEndpointServer
}

ProxyDebugServer returns proxies to callers outside the gloo pod - this is only necessary for UI/debugging purposes.

type ValidationServer

type ValidationServer struct {
	*GrpcService
	Server validation.ValidationServer
}

ValidationServer validates proxies generated by controllors outside the gloo pod