config

Documentation

Overview

Package config is the internal version of the API.

Index

• Constants
• Variables
• func GatewayConfigurationPathRefs(gc *GatewayConfiguration) []*string
• type Auth
  • func (in *Auth) DeepCopy() *Auth
  • func (in *Auth) DeepCopyInto(out *Auth)
• type Component
  • func (in *Component) DeepCopy() *Component
  • func (in *Component) DeepCopyInto(out *Component)
• type Components
  • func (in *Components) DeepCopy() *Components
  • func (in *Components) DeepCopyInto(out *Components)
• type ConsoleConfig
  • func (in *ConsoleConfig) DeepCopy() *ConsoleConfig
  • func (in *ConsoleConfig) DeepCopyInto(out *ConsoleConfig)
• type FrontProxyComponent
  • func (in *FrontProxyComponent) DeepCopy() *FrontProxyComponent
  • func (in *FrontProxyComponent) DeepCopyInto(out *FrontProxyComponent)
• type GatewayConfiguration
  • func (in *GatewayConfiguration) DeepCopy() *GatewayConfiguration
  • func (in *GatewayConfiguration) DeepCopyInto(out *GatewayConfiguration)
  • func (in *GatewayConfiguration) DeepCopyObject() runtime.Object
• type PassthroughComponent
  • func (in *PassthroughComponent) DeepCopy() *PassthroughComponent
  • func (in *PassthroughComponent) DeepCopyInto(out *PassthroughComponent)
• type Registry
  • func (in *Registry) DeepCopy() *Registry
  • func (in *Registry) DeepCopyInto(out *Registry)

Constants

const GroupName = "gateway.config.tkestack.io"

GroupName is the group name used in this package

Variables

var (
	// SchemeBuilder is the scheme builder with scheme init functions to run for this API package
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func GatewayConfigurationPathRefs

func GatewayConfigurationPathRefs(gc *GatewayConfiguration) []*string

GatewayConfigurationPathRefs returns pointers to all of the GatewayConfiguration fields that contain filepaths. You might use this, for example, to resolve all relative paths against some common root before passing the configuration to the application. This method must be kept up to date as new fields are added.

Types

type Auth

type Auth struct {
	DefaultTenant string
}

func (*Auth) DeepCopy

func (in *Auth) DeepCopy() *Auth

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Auth.

func (*Auth) DeepCopyInto

func (in *Auth) DeepCopyInto(out *Auth)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Component

type Component struct {
	// address indicates the access address of the backend component. If it is deployed
	// in the cluster, it can be the address and port of the service.
	Address string
	// frontProxy indicates that the access credentials are resolved
	// before the proxy to the backend service, and the user identity is passed to the
	// backend through the header.
	FrontProxy *FrontProxyComponent
	// passthrough indicates that the credentials are passed directly
	// when the proxy requests to the backend service.
	Passthrough *PassthroughComponent
}

func (*Component) DeepCopy

func (in *Component) DeepCopy() *Component

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Component.

func (*Component) DeepCopyInto

func (in *Component) DeepCopyInto(out *Component)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Components

type Components struct {
	// platform is used to specify the access information of the `tke-platform-api`
	// backend service.
	// +optional
	Platform *Component
	// business is used to specify the access information of the `tke-business-api`
	// backend service.
	// +optional
	Business *Component
	// notify is used to specify the access information of the `tke-notify-api`
	// backend service.
	// +optional
	Notify *Component
	// monitor is used to specify the access information of the `tke-monitor-api`
	// backend service.
	// +optional
	Monitor *Component
	// auth is used to specify the access information of the `tke-auth`
	// backend service.
	// +optional
	Auth *Component
	// registry is used to specify the access information of the `tke-registry`
	// backend service.
	// +optional
	Registry *Component
	// logagent is used to specify the access information of the `tke-logagent-api`
	// backend service.
	// +optional
	LogAgent *Component
	// audit is used to specify the access information of the `tke-audit-api`
	// backend service.
	// +optional
	Audit *Component
	// application is used to specify the access information of the `tke-application-api`
	// backend service.
	// +optional
	Application *Component
	// mesh is used to specify the access information of the `tke-mesh-api`
	// backend service.
	// +optional
	Mesh *Component
}

func (*Components) DeepCopy

func (in *Components) DeepCopy() *Components

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Components.

func (*Components) DeepCopyInto

func (in *Components) DeepCopyInto(out *Components)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConsoleConfig

type ConsoleConfig struct {
	Title        string
	LogoDir      string
	CustomConfig string
}

func (*ConsoleConfig) DeepCopy

func (in *ConsoleConfig) DeepCopy() *ConsoleConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConsoleConfig.

func (*ConsoleConfig) DeepCopyInto

func (in *ConsoleConfig) DeepCopyInto(out *ConsoleConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FrontProxyComponent

type FrontProxyComponent struct {
	// caFile is the path to a PEM-encoded certificate bundle. Trusted root certificates
	// for server.
	// +optional
	CAFile string
	// clientCertFile is the path to a PEM-encoded certificate bundle. If the authentication
	// is in `FrontProxy` mode, you must develop a trusted client access certificate for
	// the backend service.
	ClientCertFile string
	// clientKeyFile is the path to a PEM-encoded private key bundle. If the authentication
	// is in `FrontProxy` mode, you must develop a trusted client access private key for
	// the backend service.
	ClientKeyFile string
	// usernameHeader is request header to inspect for username.
	// X-Remote-User is suggested.
	UsernameHeader string
	// groupsHeader is request header to inspect for groups.
	// X-Remote-Groups is suggested.
	GroupsHeader string
	// extraPrefixHeader is request header prefixes to inspect.
	// X-Remote-Extra- is suggested.
	ExtraPrefixHeader string
}

func (*FrontProxyComponent) DeepCopy

func (in *FrontProxyComponent) DeepCopy() *FrontProxyComponent

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FrontProxyComponent.

func (*FrontProxyComponent) DeepCopyInto

func (in *FrontProxyComponent) DeepCopyInto(out *FrontProxyComponent)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GatewayConfiguration

type GatewayConfiguration struct {
	metav1.TypeMeta

	// disableOIDCProxy, by default, the gateway server will proxy access requests to
	// the OIDC server. This switch is used to disable this feature.
	DisableOIDCProxy bool
	// components is used to wrap all the backend component settings in the TKE.
	Components Components

	Registry      *Registry
	Auth          *Auth
	ConsoleConfig *ConsoleConfig
}

GatewayConfiguration contains the configuration for the Gateway

func (*GatewayConfiguration) DeepCopy

func (in *GatewayConfiguration) DeepCopy() *GatewayConfiguration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayConfiguration.

func (*GatewayConfiguration) DeepCopyInto

func (in *GatewayConfiguration) DeepCopyInto(out *GatewayConfiguration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GatewayConfiguration) DeepCopyObject

func (in *GatewayConfiguration) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PassthroughComponent

type PassthroughComponent struct {
	// caFile is the path to a PEM-encoded certificate bundle. Trusted root certificates
	// for server.
	// +optional
	CAFile string
}

func (*PassthroughComponent) DeepCopy

func (in *PassthroughComponent) DeepCopy() *PassthroughComponent

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PassthroughComponent.

func (*PassthroughComponent) DeepCopyInto

func (in *PassthroughComponent) DeepCopyInto(out *PassthroughComponent)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Registry

type Registry struct {
	DefaultTenant string
	// +optional
	DomainSuffix string
}

func (*Registry) DeepCopy

func (in *Registry) DeepCopy() *Registry

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Registry.

func (*Registry) DeepCopyInto

func (in *Registry) DeepCopyInto(out *Registry)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.