options

Documentation

Index

• Constants
• Variables
• type Add
• type ApiKeyAuth
• type AuthConfig
• type AwsDestinationSpec
• type AwsSecret
• type AzureSecret
• type Check
• type CheckCRD
• type Cluster
• type Create
• type Dashboard
• type Delegate
• type DelegateSelector
• type Delete
• type Destination
• type DestinationSpec
• type Edit
• type ExtraOptions
• type Get
• type GetProxy
• type HeaderSecret
• type HelmInstall
• type HelmUninstall
• type InputAuthConfig
• type InputAwsEc2Spec
• type InputAwsSpec
• type InputAzureSpec
• type InputConsulSpec
• type InputGrpcServiceSpec
• type InputKubeSpec
• type InputMapStringString
  • func (m *InputMapStringString) MustMap() map[string]string
• type InputRestServiceSpec
• type InputRoute
• type InputServiceSpec
• type InputStaticSpec
• type InputUpstream
• type InputUpstreamGroup
• type InputVirtualService
• type Install
• type Istio
• type Knative
• type OIDCAuth
• type OIDCSettings
• type OpaAuth
• type Options
• type PrefixRewrite
  • func (p *PrefixRewrite) Set(s string) error
  • func (p *PrefixRewrite) String() string
  • func (p *PrefixRewrite) Type() string
• type Proxy
• type RateLimit
• type Register
• type Remove
• type RemoveRoute
• type RestDestinationSpec
• type Route
• type RouteMatchers
• type RoutePlugins
• type Secret
• type Selector
• type TlsSecret
  • func (t *TlsSecret) ReadFiles() (*gloov1.TlsSecret, error)
• type Top
• type Uninstall
• type Upgrade
• type UseTls
  • func (u *UseTls) Set(s string) error
  • func (u *UseTls) String() string
  • func (u *UseTls) Type() string
• type Vault

Constants

const (
	UpstreamType_Aws    = "aws"
	UpstreamType_AwsEc2 = "ec2"
	UpstreamType_Azure  = "azure"
	UpstreamType_Consul = "consul"
	UpstreamType_Kube   = "kube"
	UpstreamType_Static = "static"
)

const (
	ServiceType_Rest = "rest"
	ServiceType_Grpc = "grpc"
)

Variables

var RateLimit_TimeUnits = func() []string {
	var vals []string
	for _, name := range rltypes.RateLimit_Unit_name {
		vals = append(vals, name)
	}
	sort.Strings(vals)
	return vals
}()

var UpstreamTypes = []string{
	UpstreamType_Aws,
	UpstreamType_AwsEc2,
	UpstreamType_Azure,
	UpstreamType_Consul,
	UpstreamType_Kube,
	UpstreamType_Static,
}

Types

type Add

type Add struct {
	Route  InputRoute
	DryRun bool // print resource as a kubernetes style yaml and exit without writing to storage
}

type ApiKeyAuth

type ApiKeyAuth struct {
	Enable          bool
	Labels          []string
	SecretNamespace string
	SecretName      string
}

type AuthConfig

type AuthConfig struct {
	Name      string
	Namespace string
}

type AwsDestinationSpec

type AwsDestinationSpec struct {
	LogicalName            string
	ResponseTransformation bool
	UnwrapAsAlb            bool
	UnwrapAsAPIGateway     bool
}

type AwsSecret

type AwsSecret struct {
	AccessKey    string
	SecretKey    string
	SessionToken string
}

type AzureSecret

type AzureSecret struct {
	ApiKeys InputMapStringString
}

type Check

type Check struct {
	// The maximum length of time alloted to `glooctl check`. A value of zero means no timeout.
	CheckTimeout time.Duration
}

type CheckCRD

type CheckCRD struct {
	Version    string
	LocalChart string
	ShowYaml   bool
}

type Cluster

type Cluster struct {
	FederationNamespace string
	Register            Register
	Deregister          Register
}

type Create

type Create struct {
	VirtualService     InputVirtualService
	InputUpstream      InputUpstream
	InputUpstreamGroup InputUpstreamGroup
	InputSecret        Secret
	AuthConfig         InputAuthConfig
	DryRun             bool  // print resource as a kubernetes style yaml and exit without writing to storage
	Vault              Vault // use vault as secrets backend
}

type Dashboard

type Dashboard struct {
}

type Delegate

type Delegate struct {
	Single   core.ResourceRef
	Selector DelegateSelector
}

type DelegateSelector

type DelegateSelector struct {
	Labels     map[string]string
	Namespaces []string
}

type Delete

type Delete struct {
	Selector InputMapStringString
	All      bool
}

type Destination

type Destination struct {
	Upstream        core.ResourceRef
	Delegate        Delegate
	DestinationSpec DestinationSpec
}

type DestinationSpec

type DestinationSpec struct {
	Aws  AwsDestinationSpec
	Rest RestDestinationSpec
}

type Edit

type Edit struct {
}

type ExtraOptions

type ExtraOptions struct {
	RateLimit  RateLimit
	OIDCAuth   OIDCAuth
	ApiKeyAuth ApiKeyAuth
	OpaAuth    OpaAuth
}

type Get

type Get struct {
	Proxy    GetProxy
	Selector InputMapStringString
}

type GetProxy

type GetProxy struct {

	// Namespace represents the namespace to search for the Proxy.
	// An empty string is interpreted as all namespaces
	Namespace string

	// K8sGatewaySource is true if the GetProxy request should consider Proxy resources
	// that were generated by the K8s Gateway Translation
	K8sGatewaySource bool

	// EdgeGatewaySource is true if the GetProxy request should consider Proxy resources
	// that were generated by the Edge Gateway Translation
	EdgeGatewaySource bool

	// All is true if the GetProxy request should consider all Proxy resources, in all namespaces
	All bool
}

type HeaderSecret

type HeaderSecret struct {
	Headers InputMapStringString
}

type HelmInstall

type HelmInstall struct {
	CreateNamespace         bool
	Namespace               string
	HelmChartOverride       string
	HelmChartValueFileNames []string
	HelmReleaseName         string
}

type HelmUninstall

type HelmUninstall struct {
	Namespace       string
	HelmReleaseName string
	DeleteCrds      bool
	DeleteNamespace bool
	DeleteAll       bool
}

type InputAuthConfig

type InputAuthConfig struct {
	OIDCAuth   OIDCAuth
	ApiKeyAuth ApiKeyAuth
	OpaAuth    OpaAuth
}

type InputAwsEc2Spec

type InputAwsEc2Spec struct {
	Region          string
	Secret          core.ResourceRef
	Role            string
	PublicIp        bool
	Port            uint32
	KeyFilters      []string
	KeyValueFilters InputMapStringString
}

type InputAwsSpec

type InputAwsSpec struct {
	Region string
	Secret core.ResourceRef
}

type InputAzureSpec

type InputAzureSpec struct {
	FunctionAppName string
	Secret          core.ResourceRef
}

type InputConsulSpec

type InputConsulSpec struct {
	// The name of the Consul Service
	ServiceName string
	// The list of service tags Gloo should search for on a service instance
	// before deciding whether or not to include the instance as part of this
	// upstream
	ServiceTags []string
}

type InputGrpcServiceSpec

type InputGrpcServiceSpec struct {
	// inline from a file
	Descriptors []byte
}

type InputKubeSpec

type InputKubeSpec struct {
	// The name of the Kubernetes Service
	ServiceName string
	// The namespace where the Service lives
	ServiceNamespace string
	// The port exposed by the Kubernetes Service
	ServicePort uint32
	// Allows finer-grained filtering of pods for the Upstream. Gloo will select pods based on their labels if
	// any are provided here.
	// (see [Kubernetes labels and selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)
	Selector InputMapStringString
}

type InputMapStringString

type InputMapStringString struct {
	Entries []string `json:"values"`
}

func (*InputMapStringString) MustMap

func (m *InputMapStringString) MustMap() map[string]string

type InputRestServiceSpec

type InputRestServiceSpec struct {
	SwaggerUrl       string
	SwaggerDocInline string
}

type InputRoute

type InputRoute struct {
	InsertIndex uint32
	Matcher     RouteMatchers
	Destination Destination
	// TODO: multi destination
	// Destinations []Destination
	UpstreamGroup         core.ResourceRef
	Plugins               RoutePlugins
	AddToRouteTable       bool // add the route to a route table rather than a virtual service
	ClusterScopedVsClient bool
}

type InputServiceSpec

type InputServiceSpec struct {
	ServiceType          string
	InputRestServiceSpec InputRestServiceSpec
	InputGrpcServiceSpec InputGrpcServiceSpec
}

type InputStaticSpec

type InputStaticSpec struct {
	Hosts []string
	// Attempt to use outbound TLS
	// If not explicitly set, Gloo will automatically set this to true for port 443
	UseTls UseTls
}

type InputUpstream

type InputUpstream struct {
	UpstreamType string
	Aws          InputAwsSpec
	AwsEc2       InputAwsEc2Spec
	Azure        InputAzureSpec
	Consul       InputConsulSpec
	Kube         InputKubeSpec
	Static       InputStaticSpec

	// An optional Service Spec describing the service listening on this upstream
	ServiceSpec InputServiceSpec
}

type InputUpstreamGroup

type InputUpstreamGroup struct {
	WeightedDestinations InputMapStringString
}

type InputVirtualService

type InputVirtualService struct {
	Domains     []string
	DisplayName string
	RateLimit   RateLimit
	AuthConfig  AuthConfig
}

type Install

type Install struct {
	Gloo        HelmInstall
	Federation  HelmInstall
	Knative     Knative
	LicenseKey  string
	WithGlooFed bool
	DryRun      bool
	Version     string
}

type Istio

type Istio struct {
	Upstream              string // upstream for which we are changing the istio mTLS settings
	IncludeUpstreams      bool   // whether or not to modify upstreams when uninstalling mTLS
	Namespace             string // namespace in which istio is installed
	IstioMetaMeshId       string // IstioMetaMeshId sets ISTIO_META_MESH_ID env var
	IstioMetaClusterId    string // IstioMetaClusterId sets ISTIO_META_CLUSTER_ID env var
	IstioDiscoveryAddress string // IstioDiscoveryAddress sets discoveryAddress field within PROXY_CONFIG env var
}

type Knative

type Knative struct {
	InstallKnativeVersion         string `json:"version"`
	InstallKnative                bool   `json:"-"`
	SkipGlooInstall               bool   `json:"-"`
	InstallKnativeMonitoring      bool   `json:"monitoring"`
	InstallKnativeEventing        bool   `json:"eventing"`
	InstallKnativeEventingVersion string `json:"eventingVersion"`
}

type OIDCAuth

type OIDCAuth struct {
	Enable bool

	// Include all options from the vhost extension
	extauth.OAuth
}

type OIDCSettings

type OIDCSettings struct {
	ExtAuthServerUpstreamRef core.ResourceRef
}

type OpaAuth

type OpaAuth struct {
	Enable bool

	Query   string
	Modules []string
}

type Options

type Options struct {
	Metadata  core.Metadata
	Top       Top
	Install   Install
	Uninstall Uninstall
	Proxy     Proxy
	Upgrade   Upgrade
	Create    Create
	Delete    Delete
	Edit      Edit
	Route     Route
	Get       Get
	Add       Add
	Istio     Istio
	Remove    Remove
	Cluster   Cluster
	Check     Check
	CheckCRD  CheckCRD
}

type PrefixRewrite

type PrefixRewrite struct {
	Value *string
}

func (*PrefixRewrite) Set

func (p *PrefixRewrite) Set(s string) error

func (*PrefixRewrite) String

func (p *PrefixRewrite) String() string

func (*PrefixRewrite) Type

func (p *PrefixRewrite) Type() string

type Proxy

type Proxy struct {
	LocalCluster     bool
	LocalClusterName string
	Name             string
	Port             string
	FollowLogs       bool
	DebugLogs        bool
}

type RateLimit

type RateLimit struct {
	Enable              bool
	TimeUnit            string
	RequestsPerTimeUnit uint32
}

type Register

type Register struct {
	RemoteKubeConfig           string
	RemoteContext              string
	ClusterName                string
	LocalClusterDomainOverride string
	RemoteNamespace            string
}

type Remove

type Remove struct {
	Route RemoveRoute
}

type RemoveRoute

type RemoveRoute struct {
	RemoveIndex uint32
}

type RestDestinationSpec

type RestDestinationSpec struct {
	FunctionName string
	Parameters   InputMapStringString
}

type Route

type Route struct {
}

type RouteMatchers

type RouteMatchers struct {
	PathPrefix            string
	PathExact             string
	PathRegex             string
	Methods               []string
	HeaderMatcher         InputMapStringString
	QueryParameterMatcher InputMapStringString
}

type RoutePlugins

type RoutePlugins struct {
	PrefixRewrite PrefixRewrite
}

type Secret

type Secret struct {
	TlsSecret    TlsSecret
	AwsSecret    AwsSecret
	AzureSecret  AzureSecret
	HeaderSecret HeaderSecret
}

type Selector

type Selector struct {
	// Allows finer-grained filtering of pods for the Upstream. Gloo will select pods based on their labels if
	// any are provided here.
	// (see [Kubernetes labels and selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)
	SelectorKeyValuePairs []string
}

type TlsSecret

type TlsSecret struct {
	RootCaFilename     string
	PrivateKeyFilename string
	CertChainFilename  string
	OCSPStapleFilename string
	// non-user facing value for test purposes
	// if set, Read() will just return the filenames
	Mock bool
}

func (*TlsSecret) ReadFiles

func (t *TlsSecret) ReadFiles() (*gloov1.TlsSecret, error)

ReadFiles provides a way to sidestep file io during testing It reads the files and returns a TlsSecret object which holds the file contents

type Top

type Top struct {
	contextoptions.ContextAccessible
	CheckName          []string
	Output             printTypes.OutputType
	Ctx                context.Context
	Zip                bool
	PodSelector        string   // label selector for pod scanning
	ResourceNamespaces []string // namespaces in which to check custom resources
}

type Uninstall

type Uninstall struct {
	GlooUninstall HelmUninstall
}

type Upgrade

type Upgrade struct {
	ReleaseTag   string
	DownloadPath string
}

type UseTls

type UseTls struct {
	Value *bool
}

func (*UseTls) Set

func (u *UseTls) Set(s string) error

func (*UseTls) String

func (u *UseTls) String() string

methods to implement pflag Value interface https://github.com/spf13/pflag/blob/d5e0c0615acee7028e1e2740a11102313be88de1/flag.go#L187

func (*UseTls) Type

func (u *UseTls) Type() string

type Vault

type Vault struct {
	// enable vault secret clients
	UseVault bool

	// https://learn.hashicorp.com/tutorials/vault/getting-started-secrets-engines
	// PathPrefix tells Vault which secrets engine to which it should route traffic.
	PathPrefix string

	// Secrets are persisted using a resource client constructed in solo-kit
	// https://github.com/solo-io/solo-kit/blob/1d799ae290c2f516f01fc4ad20272d7d2d5db1e7/pkg/api/v1/clients/vault/resource_client.go#L311
	// The RootKey is used to configure the path for the particular Gloo installation
	// This ensures that you can run multiple instances of Gloo against the same Consul cluster
	RootKey string
	Client  func() (*vaultapi.Client, error)
}