v1

package

Documentation

Overview

Package v1 is the v1 version of the API. +groupName=gateway.config.tkestack.io

Index

Constants

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

GroupName is the group name use in this package.

Variables

View Source
var (
	// SchemeBuilder collects functions that add things to a scheme.
	SchemeBuilder runtime.SchemeBuilder

	// AddToScheme applies all the stored functions to the scheme.
	AddToScheme = localSchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_config_Auth_To_v1_Auth

func Convert_config_Auth_To_v1_Auth(in *config.Auth, out *Auth, s conversion.Scope) error

Convert_config_Auth_To_v1_Auth is an autogenerated conversion function.

func Convert_config_Component_To_v1_Component

func Convert_config_Component_To_v1_Component(in *config.Component, out *Component, s conversion.Scope) error

Convert_config_Component_To_v1_Component is an autogenerated conversion function.

func Convert_config_Components_To_v1_Components

func Convert_config_Components_To_v1_Components(in *config.Components, out *Components, s conversion.Scope) error

Convert_config_Components_To_v1_Components is an autogenerated conversion function.

func Convert_config_FrontProxyComponent_To_v1_FrontProxyComponent

func Convert_config_FrontProxyComponent_To_v1_FrontProxyComponent(in *config.FrontProxyComponent, out *FrontProxyComponent, s conversion.Scope) error

Convert_config_FrontProxyComponent_To_v1_FrontProxyComponent is an autogenerated conversion function.

func Convert_config_GatewayConfiguration_To_v1_GatewayConfiguration

func Convert_config_GatewayConfiguration_To_v1_GatewayConfiguration(in *config.GatewayConfiguration, out *GatewayConfiguration, s conversion.Scope) error

Convert_config_GatewayConfiguration_To_v1_GatewayConfiguration is an autogenerated conversion function.

func Convert_config_PassthroughComponent_To_v1_PassthroughComponent

func Convert_config_PassthroughComponent_To_v1_PassthroughComponent(in *config.PassthroughComponent, out *PassthroughComponent, s conversion.Scope) error

Convert_config_PassthroughComponent_To_v1_PassthroughComponent is an autogenerated conversion function.

func Convert_config_Registry_To_v1_Registry

func Convert_config_Registry_To_v1_Registry(in *config.Registry, out *Registry, s conversion.Scope) error

Convert_config_Registry_To_v1_Registry is an autogenerated conversion function.

func Convert_v1_Auth_To_config_Auth

func Convert_v1_Auth_To_config_Auth(in *Auth, out *config.Auth, s conversion.Scope) error

Convert_v1_Auth_To_config_Auth is an autogenerated conversion function.

func Convert_v1_Component_To_config_Component

func Convert_v1_Component_To_config_Component(in *Component, out *config.Component, s conversion.Scope) error

Convert_v1_Component_To_config_Component is an autogenerated conversion function.

func Convert_v1_Components_To_config_Components

func Convert_v1_Components_To_config_Components(in *Components, out *config.Components, s conversion.Scope) error

Convert_v1_Components_To_config_Components is an autogenerated conversion function.

func Convert_v1_FrontProxyComponent_To_config_FrontProxyComponent

func Convert_v1_FrontProxyComponent_To_config_FrontProxyComponent(in *FrontProxyComponent, out *config.FrontProxyComponent, s conversion.Scope) error

Convert_v1_FrontProxyComponent_To_config_FrontProxyComponent is an autogenerated conversion function.

func Convert_v1_GatewayConfiguration_To_config_GatewayConfiguration

func Convert_v1_GatewayConfiguration_To_config_GatewayConfiguration(in *GatewayConfiguration, out *config.GatewayConfiguration, s conversion.Scope) error

Convert_v1_GatewayConfiguration_To_config_GatewayConfiguration is an autogenerated conversion function.

func Convert_v1_PassthroughComponent_To_config_PassthroughComponent

func Convert_v1_PassthroughComponent_To_config_PassthroughComponent(in *PassthroughComponent, out *config.PassthroughComponent, s conversion.Scope) error

Convert_v1_PassthroughComponent_To_config_PassthroughComponent is an autogenerated conversion function.

func Convert_v1_Registry_To_config_Registry

func Convert_v1_Registry_To_config_Registry(in *Registry, out *config.Registry, s conversion.Scope) error

Convert_v1_Registry_To_config_Registry is an autogenerated conversion function.

func RegisterConversions

func RegisterConversions(s *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a LocalGroup qualified GroupResource

func SetDefaults_GatewayConfiguration

func SetDefaults_GatewayConfiguration(obj *GatewayConfiguration)

func SetObjectDefaults_GatewayConfiguration

func SetObjectDefaults_GatewayConfiguration(in *GatewayConfiguration)

Types

type Auth

type Auth struct {
	DefaultTenant string `json:"defaultTenant"`
}

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 `json:"address"`
	// 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 `json:"frontProxy"`
	// passthrough indicates that the credentials are passed directly
	// when the proxy requests to the backend service.
	Passthrough *PassthroughComponent `json:"passthrough"`
}

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 `json:"platform,omitempty"`
	// business is used to specify the access information of the `tke-business-api`
	// backend service.
	// +optional
	Business *Component `json:"business,omitempty"`
	// notify is used to specify the access information of the `tke-notify-api`
	// backend service.
	// +optional
	Notify *Component `json:"notify,omitempty"`
	// monitor is used to specify the access information of the `tke-monitor-api`
	// backend service.
	// +optional
	Monitor *Component `json:"monitor,omitempty"`
	// auth is used to specify the access information of the `tke-auth`
	// backend service.
	// +optional
	Auth *Component `json:"auth,omitempty"`
	// registry is used to specify the access information of the `tke-registry`
	// backend service.
	// +optional
	Registry *Component `json:"registry,omitempty"`
	// logagent is used to specify the access information of the `tke-logagent-api`
	// backend service.
	// +optional
	LogAgent *Component `json:"logagent,omitempty"`
	// audit is used to specify the access information of the `tke-audit-api`
	// backend service.
	// +optional
	Audit *Component `json:"audit,omitempty"`
	// application is used to specify the access information of the `tke-application-api`
	// backend service.
	// +optional
	Application *Component `json:"application,omitempty"`
	// mesh is used to specify the access information of the `tke-mesh-api`
	// backend service.
	// +optional
	Mesh *Component `json:"mesh,omitempty"`
}

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 FrontProxyComponent

type FrontProxyComponent struct {
	// caFile is the path to a PEM-encoded certificate bundle. Trusted root certificates
	// for server.
	// +optional
	CAFile string `json:"caFile,omitempty"`
	// 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 `json:"clientCertFile"`
	// 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 `json:"clientKeyFile"`
	// usernameHeader is request header to inspect for username.
	// X-Remote-User is suggested.
	UsernameHeader string `json:"usernameHeader"`
	// groupsHeader is request header to inspect for groups.
	// X-Remote-Groups is suggested.
	GroupsHeader string `json:"groupsHeader"`
	// extraPrefixHeader is request header prefixes to inspect.
	// X-Remote-Extra- is suggested.
	ExtraPrefixHeader string `json:"extraPrefixHeader"`
}

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 `json:"disableOIDCProxy"`
	// components is used to wrap all the backend component settings in the TKE.
	Components Components `json:"components"`
	Registry   *Registry  `json:"registry,omitempty"`
	Auth       *Auth      `json:"auth,omitempty"`
}

GatewayConfiguration contains the configuration for the Gateway

func (*GatewayConfiguration) DeepCopy

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 `json:"caFile,omitempty"`
}

func (*PassthroughComponent) DeepCopy

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 `json:"defaultTenant"`
	// +optional
	DomainSuffix string `json:"domainSuffix"`
}

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.

Jump to

Keyboard shortcuts

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