api

Documentation

Index

• Constants
• func RegisterRoute(container *restful.Container, cfg *gatewayconfig.GatewayConfiguration, ...) error
• type Auth
• type Components
• type Empty
• type GroupVersion
• type Registry
• type SysInfo
• type UserInfo

Constants

const GroupName = "gateway.tkestack.io"

GroupName is the api group name for gateway.

const Version = "v1"

Version is the api version for gateway.

Functions

func RegisterRoute

func RegisterRoute(container *restful.Container, cfg *gatewayconfig.GatewayConfiguration, oauthConfig *oauth2.Config, oidcHTTPClient *http.Client, oidcAuthenticator *oidc.Authenticator, headerRequest bool) error

RegisterRoute is used to register prefix path routing matches for all configured backend components.

Types

type Auth

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

type Components

type Components struct {
	Platform *GroupVersion `json:"platform,omitempty"`
	Business *GroupVersion `json:"business,omitempty"`
	Monitor  *GroupVersion `json:"monitor,omitempty"`
	Notify   *GroupVersion `json:"notify,omitempty"`
	Auth     *GroupVersion `json:"auth,omitempty"`
	Registry *GroupVersion `json:"registry,omitempty"`
}

Components contains the service address of each module in TKE

type Empty

type Empty struct {
}

Empty defines a data structure containing nothing.

type GroupVersion

type GroupVersion struct {
	GroupName string `json:"groupName"`
	Version   string `json:"version"`
}

type Registry

type Registry struct {
	DefaultTenant string `json:"defaultTenant,omitempty"`
	DomainSuffix  string `json:"domainSuffix,omitempty"`
}

type SysInfo

type SysInfo struct {
	Components Components `json:"components"`
	Registry   *Registry  `json:"registry,omitempty"`
	Auth       *Auth      `json:"auth,omitempty"`
}

type UserInfo

type UserInfo struct {
	Name   string              `json:"name"`
	UID    string              `json:"uid"`
	Groups []string            `json:"groups"`
	Extra  map[string][]string `json:"extra"`
}

UserInfo defines a data structure containing user information.