entity

Documentation

Overview

• Licensed to the Apache Software Foundation (ASF) under one or more
• contributor license agreements. See the NOTICE file distributed with
• this work for additional information regarding copyright ownership.
• The ASF licenses this file to You under the Apache License, Version 2.0
• (the "License"); you may not use this file except in compliance with
• the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

Package entity

@author: xwc1125

Package entity

@author: xwc1125

Package entity

@author: xwc1125

Index

• func BuildRequestOpt(reqId uint32, confToken uint32, opt ReqOpt) []byte
• func BuildRespReqOpt(opt RespReqOpt) []byte
• func NodesFormat(obj interface{}) interface{}
• type Active
• type BaseInfo
  • func (info *BaseInfo) Creating()
  • func (info *BaseInfo) GetBaseInfo() *BaseInfo
  • func (info *BaseInfo) KeyCompat(key string)
  • func (info *BaseInfo) Updating(storedInfo *BaseInfo)
• type Consumer
  • func (c *Consumer) GetPlugins() map[string]interface{}
• type GetBaseInfo
• type GetPlugins
• type GlobalPlugins
  • func (g *GlobalPlugins) GetPlugins() map[string]interface{}
• type HealthChecker
• type Healthy
• type K8sInfo
• type Node
• type Pair
• type Passive
• type PluginConfig
  • func (p *PluginConfig) GetPlugins() map[string]interface{}
• type Proto
• type ReqOpt
• type RequestValidation
• type RespReqOpt
• type Route
  • func (r *Route) GetPlugins() map[string]interface{}
• type SSL
• type SSLClient
• type Script
• type ServerInfo
• type Service
  • func (s *Service) GetPlugins() map[string]interface{}
• type Status
• type StreamRoute
• type SystemConfig
• type Timeout
• type TimeoutValue
• type UnHealthy
• type Upstream
  • func (upstream *Upstream) Parse2NameResponse() (*UpstreamNameResponse, error)
• type UpstreamDef
  • func (u UpstreamDef) GetNodes() []*Node
• type UpstreamKeepalivePool
• type UpstreamNameResponse
• type UpstreamTLS

Functions

func BuildRequestOpt

func BuildRequestOpt(reqId uint32, confToken uint32, opt ReqOpt) []byte

func BuildRespReqOpt

func BuildRespReqOpt(opt RespReqOpt) []byte

func NodesFormat

func NodesFormat(obj interface{}) interface{}

Types

type Active

type Active struct {
	Type                   string       `json:"type,omitempty" comment:"类型：http/https"` // 是使用 HTTP 或 HTTPS 进行主动健康检查，还是只尝试 TCP 连接
	Timeout                TimeoutValue `json:"timeout,omitempty" comment:"超时时间"`
	Concurrency            int          `json:"concurrency,omitempty" comment:"并行数量"`
	Host                   string       `json:"host,omitempty" comment:"主机名"`
	Port                   int          `json:"port,omitempty" comment:"端口"`
	HTTPPath               string       `json:"http_path,omitempty" comment:"请求路径"`
	HTTPSVerifyCertificate bool         `json:"https_verify_certificate,omitempty"`
	Healthy                Healthy      `json:"healthy,omitempty" comment:"健康状态"`
	UnHealthy              UnHealthy    `json:"unhealthy,omitempty" comment:"不健康状态"`
	ReqHeaders             []string     `json:"req_headers,omitempty" comment:"额外的请求头"` // 示例：User-Agent: curl/7.29.0
}

Active 主动检查

type BaseInfo

type BaseInfo struct {
	ID         interface{} `json:"id" comment:"ID"`
	CreateTime int64       `json:"create_time,omitempty" comment:"创建时间"`
	UpdateTime int64       `json:"update_time,omitempty" comment:"更新时间"`
}

func (*BaseInfo) Creating

func (info *BaseInfo) Creating()

func (*BaseInfo) GetBaseInfo

func (info *BaseInfo) GetBaseInfo() *BaseInfo

func (*BaseInfo) KeyCompat

func (info *BaseInfo) KeyCompat(key string)

func (*BaseInfo) Updating

func (info *BaseInfo) Updating(storedInfo *BaseInfo)

type Consumer

type Consumer struct {
	Username   string                 `json:"username"`
	Desc       string                 `json:"desc,omitempty"`
	Plugins    map[string]interface{} `json:"plugins,omitempty"`
	Labels     map[string]string      `json:"labels,omitempty"`
	CreateTime int64                  `json:"create_time,omitempty"`
	UpdateTime int64                  `json:"update_time,omitempty"`
}

swagger:model Consumer

func (*Consumer) GetPlugins

func (c *Consumer) GetPlugins() map[string]interface{}

type GetBaseInfo

type GetBaseInfo interface {
	GetBaseInfo() *BaseInfo
}

type GetPlugins

type GetPlugins interface {
	GetPlugins() map[string]interface{}
}

type GlobalPlugins

type GlobalPlugins struct {
	BaseInfo
	Plugins map[string]interface{} `json:"plugins"`
}

swagger:model GlobalPlugins

func (*GlobalPlugins) GetPlugins

func (g *GlobalPlugins) GetPlugins() map[string]interface{}

type HealthChecker

type HealthChecker struct {
	Active  Active  `json:"active,omitempty"`
	Passive Passive `json:"passive,omitempty"`
}

type Healthy

type Healthy struct {
	Interval     int   `json:"interval,omitempty" comment:"间隔时间:秒"`
	HttpStatuses []int `json:"http_statuses,omitempty" comment:"状态码列表"` // HTTP 状态码列表，当探针在主动健康检查中返回时，视为健康。
	Successes    int   `json:"successes,omitempty" comment:"成功次数"`      // 若达到此值，表示上游服务目标节点是健康的。
}

type K8sInfo

type K8sInfo struct {
	Namespace   string `json:"namespace,omitempty"`
	DeployName  string `json:"deploy_name,omitempty"`
	ServiceName string `json:"service_name,omitempty"`
	Port        int    `json:"port,omitempty"`
	BackendType string `json:"backend_type,omitempty"`
}

type Node

type Node struct {
	Host     string      `json:"host,omitempty"`
	Port     int         `json:"port,omitempty"`
	Weight   int         `json:"weight"`
	Metadata interface{} `json:"metadata,omitempty"`
	Priority int         `json:"priority,omitempty"`
}

type Pair

type Pair struct {
	Name  string
	Value string
}

type Passive

type Passive struct {
	Type      string    `json:"type,omitempty"`
	Healthy   Healthy   `json:"healthy,omitempty"`
	UnHealthy UnHealthy `json:"unhealthy,omitempty"`
}

Passive 被动检查

type PluginConfig

type PluginConfig struct {
	BaseInfo
	Desc    string                 `json:"desc,omitempty" validate:"max=256"`
	Plugins map[string]interface{} `json:"plugins"`
	Labels  map[string]string      `json:"labels,omitempty"`
}

swagger:model GlobalPlugins

func (*PluginConfig) GetPlugins

func (p *PluginConfig) GetPlugins() map[string]interface{}

type Proto

type Proto struct {
	BaseInfo
	Desc    string `json:"desc,omitempty"`
	Content string `json:"content"`
}

swagger:model Proto

type ReqOpt

type ReqOpt struct {
	SrcIP      []byte // 目标IP
	Method     A6.Method
	Path       string // 目标的URL
	Headers    []Pair
	RespHeader []Pair
	Args       []Pair
}

type RequestValidation

type RequestValidation struct {
	Type       string      `json:"type,omitempty"`
	Required   []string    `json:"required,omitempty"`
	Properties interface{} `json:"properties,omitempty"`
}

type RespReqOpt

type RespReqOpt struct {
	Id         uint32
	StatusCode int
	Headers    []Pair
	Token      uint32
}

type Route

type Route struct {
	BaseInfo
	URI             string                 `json:"uri,omitempty" comment:"单个http请求路径"`
	Uris            []string               `json:"uris,omitempty" comment:"多个http请求路径"`
	Name            string                 `json:"name" validate:"max=100" comment:"名称"`
	Desc            string                 `json:"desc,omitempty" validate:"max=256" default:"描述"`
	Priority        int                    `json:"priority,omitempty" comment:"优先级"`
	Methods         []string               `json:"methods,omitempty" comment:"允许的http 方法"`
	Host            string                 `json:"host,omitempty" comment:"单个域名"`
	Hosts           []string               `json:"hosts,omitempty" comment:"多个域名"`
	RemoteAddr      string                 `json:"remote_addr,omitempty" comment:"单个客户端地址"`
	RemoteAddrs     []string               `json:"remote_addrs,omitempty" comment:"多个客户端地址"`
	Vars            []interface{}          `` /* 150-byte string literal not displayed */
	FilterFunc      string                 `json:"filter_func,omitempty" comment:"FilterFunc"`
	Script          interface{}            `json:"script,omitempty" comment:"Script"`
	ScriptID        interface{}            `json:"script_id,omitempty" comment:"ScriptID"` // For debug and optimization(cache), currently same as Route's ID
	Plugins         map[string]interface{} `json:"plugins,omitempty" comment:"插件集"`
	PluginConfigID  interface{}            `json:"plugin_config_id,omitempty" comment:"插件配置ID"`
	Upstream        *UpstreamDef           `json:"upstream,omitempty" comment:"Upstream"`
	ServiceID       interface{}            `json:"service_id,omitempty" comment:"绑定服务ID"`
	UpstreamID      interface{}            `json:"upstream_id,omitempty" comment:"UpstreamID"`
	ServiceProtocol string                 `json:"service_protocol,omitempty" comment:"ServiceProtocol"`
	Labels          map[string]string      `json:"labels,omitempty" comment:"标签"`
	EnableWebsocket bool                   `json:"enable_websocket,omitempty" comment:"是否为websocket"`
	Status          Status                 `json:"status" comment:"状态：1已发布，0待发布"`
}

swagger:model Route

func (*Route) GetPlugins

func (r *Route) GetPlugins() map[string]interface{}

type SSL

type SSL struct {
	BaseInfo
	Cert          string            `json:"cert,omitempty"`
	Key           string            `json:"key,omitempty"`
	Sni           string            `json:"sni,omitempty"`
	Snis          []string          `json:"snis,omitempty"`
	Certs         []string          `json:"certs,omitempty"`
	Keys          []string          `json:"keys,omitempty"`
	ExpTime       int64             `json:"exptime,omitempty"`
	Status        int               `json:"status"`
	ValidityStart int64             `json:"validity_start,omitempty"`
	ValidityEnd   int64             `json:"validity_end,omitempty"`
	Labels        map[string]string `json:"labels,omitempty"`
	Client        *SSLClient        `json:"client,omitempty"`
}

swagger:model SSL

type SSLClient

type SSLClient struct {
	CA    string `json:"ca,omitempty"`
	Depth int    `json:"depth,omitempty"`
}

type Script

type Script struct {
	ID     string      `json:"id"`
	Script interface{} `json:"script,omitempty"`
}

type ServerInfo

type ServerInfo struct {
	BaseInfo
	LastReportTime int64  `json:"last_report_time,omitempty"`
	UpTime         int64  `json:"up_time,omitempty"`
	BootTime       int64  `json:"boot_time,omitempty"`
	EtcdVersion    string `json:"etcd_version,omitempty"`
	Hostname       string `json:"hostname,omitempty"`
	Version        string `json:"version,omitempty"`
}

type Service

type Service struct {
	BaseInfo
	Name            string                 `json:"name,omitempty" comment:"服务名称"`
	Desc            string                 `json:"desc,omitempty" comment:"服务描述"`
	Upstream        *UpstreamDef           `json:"upstream,omitempty" comment:"上游服务"`
	UpstreamID      interface{}            `json:"upstream_id,omitempty" comment:"上游服务ID"`
	Plugins         map[string]interface{} `json:"plugins,omitempty" comment:"插件"`
	Script          string                 `json:"script,omitempty"`
	Labels          map[string]string      `json:"labels,omitempty" comment:"标签"`
	EnableWebsocket bool                   `json:"enable_websocket,omitempty" comment:"是否是websocket"`
	Hosts           []string               `json:"hosts,omitempty" comment:"域名"`
}

swagger:model Service

func (*Service) GetPlugins

func (s *Service) GetPlugins() map[string]interface{}

type Status

type Status uint8

type StreamRoute

type StreamRoute struct {
	BaseInfo
	Desc       string                 `json:"desc,omitempty"`
	RemoteAddr string                 `json:"remote_addr,omitempty"`
	ServerAddr string                 `json:"server_addr,omitempty"`
	ServerPort int                    `json:"server_port,omitempty"`
	SNI        string                 `json:"sni,omitempty"`
	Upstream   *UpstreamDef           `json:"upstream,omitempty"`
	UpstreamID interface{}            `json:"upstream_id,omitempty"`
	Plugins    map[string]interface{} `json:"plugins,omitempty"`
}

swagger:model StreamRoute

type SystemConfig

type SystemConfig struct {
	ConfigName string                 `json:"config_name"`
	Desc       string                 `json:"desc,omitempty"`
	Payload    map[string]interface{} `json:"payload,omitempty"`
	CreateTime int64                  `json:"create_time,omitempty"`
	UpdateTime int64                  `json:"update_time,omitempty"`
}

swagger:model SystemConfig

type Timeout

type Timeout struct {
	Connect TimeoutValue `json:"connect,omitempty"`
	Send    TimeoutValue `json:"send,omitempty"`
	Read    TimeoutValue `json:"read,omitempty"`
}

type TimeoutValue

type TimeoutValue float32

--- structures for upstream start ---

type UnHealthy

type UnHealthy struct {
	Interval     int   `json:"interval,omitempty" comment:"间隔时间:秒"`
	HTTPStatuses []int `json:"http_statuses,omitempty" comment:"状态码列表"`
	TCPFailures  int   `json:"tcp_failures,omitempty" comment:"TCP 失败次数"`
	Timeouts     int   `json:"timeouts,omitempty" comment:"超时时间"`
	HTTPFailures int   `json:"http_failures,omitempty" comment:"HTTP 失败次数"` // 若达到此值，表示上游服务目标节点是不健康的。
}

type Upstream

type Upstream struct {
	BaseInfo
	UpstreamDef
}

swagger:model Upstream

func (*Upstream) Parse2NameResponse

func (upstream *Upstream) Parse2NameResponse() (*UpstreamNameResponse, error)

type UpstreamDef

type UpstreamDef struct {
	Nodes   interface{} `json:"nodes,omitempty" comment:"目标节点"`
	Retries *int        `` /* 170-byte string literal not displayed */
	Timeout *Timeout    `json:"timeout,omitempty" comment:"超时"`
	Type    string      `json:"type,omitempty" comment:"lb负载均衡算法，chash,roundrobin"`
	HashOn  string      `json:"hash_on,omitempty" comment:"lb哈希位置"`
	Key     string      `json:"key,omitempty" comment:"lb哈希键"`
	Checks  interface{} `json:"checks,omitempty" comment:"健康检查配置"`
	Scheme  string      `json:"scheme,omitempty" comment:"协议:http,https,grpc,grpcs"`

	DiscoveryType string            `json:"discovery_type,omitempty" comment:"服务发现类型"`
	DiscoveryArgs map[string]string `json:"discovery_args,omitempty" comment:"服务发现参数"`
	ServiceName   string            `json:"服务名称,omitempty"`

	PassHost string `json:"pass_host,omitempty" comment:"Host 请求头"` // node：使用目标节点列表中的主机名活IP，pass：保持与客户端一致的主机名

	UpstreamHost  string                 `json:"upstream_host,omitempty"`
	Name          string                 `json:"name,omitempty" comment:"upstream名称"`
	Desc          string                 `json:"desc,omitempty" comment:"upstream描述"`
	Labels        map[string]string      `json:"labels,omitempty" comment:"标签"`
	TLS           *UpstreamTLS           `json:"tls,omitempty"`
	KeepalivePool *UpstreamKeepalivePool `json:"keepalive_pool,omitempty" comment:"连接池配置"`
	RetryTimeout  TimeoutValue           `json:"retry_timeout,omitempty"`
}

func (UpstreamDef) GetNodes

func (u UpstreamDef) GetNodes() []*Node

type UpstreamKeepalivePool

type UpstreamKeepalivePool struct {
	IdleTimeout *TimeoutValue `json:"idle_timeout,omitempty"`
	Requests    int           `json:"requests,omitempty"`
	Size        int           `json:"size"`
}

type UpstreamNameResponse

type UpstreamNameResponse struct {
	ID   interface{} `json:"id"`
	Name string      `json:"name"`
}

type UpstreamTLS

type UpstreamTLS struct {
	ClientCert string `json:"client_cert,omitempty"`
	ClientKey  string `json:"client_key,omitempty"`
}