v1alpha1

package
v1.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 14, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

+k8s:deepcopy-gen=package

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DetectRunningMode added in v1.13.1 

func DetectRunningMode() defaults.RunningMode

DetectRunningMode detects whether the container is running on cloud node or edge node. It will recognize whether there is KUBERNETES_PORT in the container environment variable, because edged will not inject KUBERNETES_PORT environment variable into the container, but kubelet will. What is edged: https://kubeedge.io/en/docs/architecture/edge/edged/

Types

type AgentModules 

type AgentModules struct {
	// EdgeDNSConfig indicates EdgeDNS module config
	EdgeDNSConfig *EdgeDNSConfig `json:"edgeDNS,omitempty"`
	// EdgeProxyConfig indicates EdgeProxy module config
	EdgeProxyConfig *EdgeProxyConfig `json:"edgeProxy,omitempty"`
	// EdgeTunnelConfig indicates EdgeTunnel module config
	EdgeTunnelConfig *EdgeTunnelConfig `json:"edgeTunnel,omitempty"`
	//EdgeCniConfig indicates EdgeCNI module config
	EdgeCNIConfig *EdgeCNIConfig `json:"edgeCNI,omitempty"`
}

AgentModules indicates the modules of EdgeMeshAgent will be use

type CacheDNS 

type CacheDNS struct {
	// Enable indicates whether enable node local cache dns
	// default false
	Enable bool `json:"enable,omitempty"`
	// AutoDetect indicates whether to automatically detect the
	// address of the upstream clusterDNS
	// default true
	AutoDetect bool `json:"autoDetect,omitempty"`
	// UpstreamServers indicates the upstream ClusterDNS addresses
	UpstreamServers []string `json:"upstreamServers,omitempty"`
	// CacheTTL indicates the time to live of a dns cache entry
	// default 30(second)
	CacheTTL int `json:"cacheTTL,omitempty"`
}

type CommonConfig 

type CommonConfig struct {
	// BridgeDeviceName indicates the name of the bridge device will be created
	// default edgemesh0
	BridgeDeviceName string `json:"bridgeDeviceName,omitempty"`
	// BridgeDeviceIP indicates the IP bound to the bridge device
	// default "169.254.96.16"
	BridgeDeviceIP string `json:"bridgeDeviceIP,omitempty"`
	// PprofConfig provides configuration for pprof monitoring tools
	PprofConfig *PprofConfig `json:"pprofConfig,omitempty"`
}

CommonConfig defines some common configuration items

type ConsistentHash 

type ConsistentHash struct {
	// PartitionCount indicates the hash ring partition count
	// default 100
	PartitionCount int `json:"partitionCount,omitempty"`
	// ReplicationFactor indicates the hash ring replication factor
	// default 10
	ReplicationFactor int `json:"replicationFactor,omitempty"`
	// Load indicates the hash ring bounded loads
	// default 1.25
	Load float64 `json:"load,omitempty"`
}

ConsistentHash strategy is an extension of the loadbalancer For more information about the consistentHash algorithm, please take a look at https://research.googleblog.com/2017/04/consistent-hashing-with-bounded-loads.html

type EdgeCNIConfig added in v1.15.0 

type EdgeCNIConfig struct {
	// Enable indicates whether enable EdgeCni
	// default false
	Enable bool `json:"enable,omitempty"`

	// EncapsulationIP indicates the encapsulation IP of EdgeCni Tun Dev
	// do not allow users to configure manually
	EncapIP string `json:"encapsulationIP,omitempty"`

	// TunMode indicates wether adapter usese ebpf and fast mod
	TunMode int `json:"tunMode,omitempty"`

	// MeshCIDR indicates the CIDR of cluster, separate as ClouCIDR and EdgeCIDR
	// must set
	// Allowed values are like:
	// - cloudcidr:  10.244.36.0/24
	// - edgecidr:   10.244.13.0/24,10.244.15.0/24
	MeshCIDRConfig *MeshCIDRConfig `json:"meshCIDRConfig,omitempty"`
}

type EdgeDNSConfig 

type EdgeDNSConfig struct {
	// Enable indicates whether enable EdgeDNS
	// default false
	Enable bool `json:"enable,omitempty"`
	// KubeAPIConfig is equivalent to EdgeMeshAgentConfig.KubeAPIConfig
	// do not allow users to configure manually
	KubeAPIConfig *KubeAPIConfig `json:"kubeAPIConfig,omitempty"`
	// ListenInterface indicates the listen interface of EdgeDNS
	// do not allow users to configure manually
	ListenInterface string `json:"listenInterface,omitempty"`
	// ListenPort indicates the listen port of EdgeDNS
	// default 53
	ListenPort int `json:"listenPort,omitempty"`
	// CacheDNS indicates the node local cache dns
	CacheDNS *CacheDNS `json:"cacheDNS,omitempty"`
}

EdgeDNSConfig indicates the EdgeDNS config

type EdgeGatewayConfig 

type EdgeGatewayConfig struct {
	// Enable indicates whether enable edge gateway
	// default false
	Enable bool `json:"enable,omitempty"`
	// NIC indicates the network interface controller that the edge gateway needs to listen to.
	// empty or "*" stands for all netcards. You can also specify network interfaces such as "lo,eth0"
	// default "*"
	NIC string `json:"nic,omitempty"`
	// IncludeIP indicates the host IP that the edge gateway needs to listen to.
	// empty or "*" stands for all ips. You can also specify ips such as "192.168.1.56,10.3.2.1"
	// default "*"
	IncludeIP string `json:"includeIP,omitempty"`
	// ExcludeIP indicates the IP address that the edge gateway does not want to listen to.
	// empty or "*" stands for not exclude any ip. You can also specify ips such as "192.168.1.56,10.3.2.1"
	// default "*"
	ExcludeIP string `json:"excludeIP,omitempty"`
	// LoadBalancer indicates the load balance strategy
	LoadBalancer *LoadBalancer `json:"loadBalancer,omitempty"`
}

EdgeGatewayConfig indicates the EdgeGateway config

type EdgeMeshAgentConfig 

type EdgeMeshAgentConfig struct {
	metav1.TypeMeta
	// KubeAPIConfig indicates the kubernetes cluster info which EdgeMeshAgent will connect
	// +Required
	KubeAPIConfig *KubeAPIConfig `json:"kubeAPIConfig,omitempty"`
	// CommonConfig indicates common config for all modules
	// +Required
	CommonConfig *CommonConfig `json:"commonConfig,omitempty"`
	// Modules indicates EdgeMeshAgent modules config
	// +Required
	Modules *AgentModules `json:"modules,omitempty"`
}

EdgeMeshAgentConfig indicates the config of EdgeMeshAgent which get from EdgeMeshAgent config file

func NewDefaultEdgeMeshAgentConfig 

func NewDefaultEdgeMeshAgentConfig(configPath string) *EdgeMeshAgentConfig

NewDefaultEdgeMeshAgentConfig returns a full EdgeMeshAgentConfig object

func NewDefaultEdgeMeshAgentMinConfig added in v1.15.0 

func NewDefaultEdgeMeshAgentMinConfig() *EdgeMeshAgentConfig

NewDefaultEdgeMeshAgentMinConfig returns a min EdgeMeshAgentConfig object

type EdgeMeshGatewayConfig 

type EdgeMeshGatewayConfig struct {
	metav1.TypeMeta
	// KubeAPIConfig indicates the kubernetes cluster info which EdgeMeshGateway will connect
	// +Required
	KubeAPIConfig *KubeAPIConfig `json:"kubeAPIConfig,omitempty"`
	// Modules indicates EdgeMeshAgent modules config
	// +Required
	Modules *GatewayModules `json:"modules,omitempty"`
	// PprofConfig provides configuration for pprof monitoring
	PprofConfig *PprofConfig `json:"pprofConfig,omitempty"`
}

EdgeMeshGatewayConfig indicates the config of EdgeMeshGateway which get from EdgeMeshGateway config file

func NewDefaultEdgeMeshGatewayConfig 

func NewDefaultEdgeMeshGatewayConfig(configPath string) *EdgeMeshGatewayConfig

NewDefaultEdgeMeshGatewayConfig returns a full EdgeMeshGatewayConfig object

type EdgeProxyConfig 

type EdgeProxyConfig struct {
	// Enable indicates whether enable EdgeProxy
	// default false
	Enable bool `json:"enable,omitempty"`
	// ListenInterface indicates the listen interface of EdgeProxy
	// do not allow users to configure manually
	ListenInterface string `json:"listenInterface,omitempty"`
	// Socks5Proxy indicates the socks5 proxy config
	Socks5Proxy *Socks5Proxy `json:"socks5Proxy,omitempty"`
	// LoadBalancer indicates the load balance strategy
	LoadBalancer *LoadBalancer `json:"loadBalancer,omitempty"`
	// ServiceFilterMode indicates the service filter mode
	// Allowed values are: "FilterIfLabelExists", "FilterIfLabelDoesNotExists"
	// default "FilterIfLabelExists"
	ServiceFilterMode defaults.ServiceFilterMode `json:"serviceFilterMode,omitempty"`
}

EdgeProxyConfig indicates the EdgeProxy config

type EdgeTunnelConfig 

type EdgeTunnelConfig struct {
	// Enable indicates whether EdgeTunnel is enabled,
	// if set to false (for debugging etc.), skip checking other EdgeTunnel configs.
	// default false
	Enable bool `json:"enable,omitempty"`
	// Mode indicates EdgeTunnel running mode
	// do not allow users to configure manually
	// options: ServerAndClient, ClientOnly
	Mode defaults.TunnelMode `json:"mode,omitempty"`
	// NodeName indicates the node name of EdgeTunnel
	// do not allow users to configure manually
	NodeName string `json:"nodeName,omitempty"`
	// ListenPort indicates the listen port of EdgeTunnel
	// default 20006
	ListenPort int `json:"listenPort,omitempty"`
	// Transport indicates the transport protocol used by the p2p tunnel
	// default tcp
	Transport string `json:"transport,omitempty"`
	// Rendezvous unique string to identify group of libp2p nodes
	// default EDGEMESH_PLAYGOUND
	Rendezvous string `json:"rendezvous,omitempty"`
	// RelayNodes indicates some nodes that can become libp2p relay nodes
	RelayNodes []*RelayNode `json:"relayNodes,omitempty"`
	// EnableIpfsLog open ipfs log info
	// default false
	EnableIpfsLog bool `json:"enableIpfsLog,omitempty"`
	// MaxCandidates sets the number of relay candidates that we buffer.
	// default 5
	MaxCandidates int `json:"maxCandidates,omitempty"`
	// HeartbeatPeriod indicates the heartbeat period to keep connected with the relay peers (unit second)
	// default 120
	HeartbeatPeriod int `json:"heartbeatPeriod,omitempty"`
	// FinderPeriod indicates the execution period of the relay finder (unit second)
	// default 60
	FinderPeriod int `json:"finderPeriod,omitempty"`
	// PSK configures libp2p to use the given private network protector.
	PSK *PSK `json:"psk,omitempty"`
	// TunnelLimitConfig configures tunnel stream limit
	TunnelLimitConfig *TunnelLimitConfig `json:"tunnelLimitConfig,omitempty"`
	// ConfigPath indicates the config file path
	// do not allow users to configure manually
	ConfigPath string `json:"configPath,omitempty"`
	// ListenInterfaces indicates the network interface devices that EdgeTunnel needs to listen to.
	// empty or "*" stands for all NICs. You can also specify network interfaces such as "lo,eth0"
	// default "*"
	ListenInterfaces string `json:"listenInterfaces,omitempty"`
	// ExtraFilteredInterfaces indicates user defined network interface devices that EdgeTunnel not to listen to.
	// by default, interfaces prefixed with "docker", "edgemesh", "tunl", "flannel", "cni", "br" and "kube-ipvs" will be filtered.
	// empty stands for no additional NICs to be filtered. You can specify network interfaces separated with comma such as "lo,eth0"
	// default ""
	ExtraFilteredInterfaces string `json:"extraFilteredInterfaces,omitempty"`
	// MetricConfig provides metrics for prometheus
	MetricConfig *MetricConfig `json:"metricConfig,omitempty"`
}

type GatewayModules 

type GatewayModules struct {
	// EdgeGatewayConfig indicates EdgeGateway module config
	EdgeGatewayConfig *EdgeGatewayConfig `json:"edgeGateway,omitempty"`
	// EdgeTunnelConfig indicates EdgeTunnel module config
	EdgeTunnelConfig *EdgeTunnelConfig `json:"edgeTunnel,omitempty"`
}

GatewayModules indicates the modules of EdgeMeshGateway will be use

type KubeAPIConfig 

type KubeAPIConfig struct {
	// Master indicates the address of the Kubernetes API server (overrides any value in KubeConfig)
	// such as https://127.0.0.1:8443
	// default ""
	Master string `json:"master,omitempty"`
	// ContentType indicates the ContentType of message transmission when interacting with k8s
	// default "application/vnd.kubernetes.protobuf"
	ContentType string `json:"contentType,omitempty"`
	// QPS to while talking with kubernetes apiserver
	// default 100
	QPS int32 `json:"qps,omitempty"`
	// Burst to use while talking with kubernetes apiserver
	// default 200
	Burst int32 `json:"burst,omitempty"`
	// KubeConfig indicates the path to kubeConfig file with authorization and master location information.
	// default "/root/.kube/config"
	KubeConfig string `json:"kubeConfig,omitempty"`
	// Mode indicates the current running mode of container
	// do not allow users to configure manually
	// options ManualMode, CloudMode and EdgeMode
	Mode defaults.RunningMode `json:"mode,omitempty"`
	// MetaServer indicates the config of EdgeCore's metaServer module
	MetaServer *MetaServer `json:"metaServer,omitempty"`
	// DeleteKubeConfig indicates whether to delete the kubeConfig file, in order to improve security
	// default false
	DeleteKubeConfig bool `json:"deleteKubeConfig,omitempty"`
}

KubeAPIConfig indicates the configuration for interacting with k8s server

type LoadBalancer 

type LoadBalancer struct {
	// Caller indicates which module using LoadBalancer
	// do not allow users to configure manually
	// options: ProxyCaller, GatewayCaller
	Caller defaults.LoadBalancerCaller `json:"caller,omitempty"`
	// NodeName indicates name of host
	// do not allow users to configure manually
	NodeName string `json:"nodeName,omitempty"`
	// ConsistentHash indicates the extension of the loadbalancer
	ConsistentHash *ConsistentHash `json:"consistentHash,omitempty"`
}

LoadBalancer indicates the loadbalance strategy in edgemesh

type MeshCIDRConfig added in v1.15.0 

type MeshCIDRConfig struct {
	// CloudCIDR indicates the CIDR of cloud Pods, Allows multiNetwork
	CloudCIDR []string `json:"cloudCIDR,omitempty"`
	// CloudCIDR indicates the CIDR of edge Pods, Allows multiNetwork
	EdgeCIDR []string `json:"edgeCIDR,omitempty"`
}

MeshCIDR indicates the CIDR of cluster

type MetaServer 

type MetaServer struct {
	// Server indicates the address of metaServer
	// default http://127.0.0.1:10550, when security is disabled
	// default https://127.0.0.1:10550, when security is enabled
	Server string `json:"server,omitempty"`
	// Security indicates the metaServer security feature
	Security *MetaServerSecurity `json:"security,omitempty"`
}

MetaServer indicates the config of EdgeCore's metaServer module

type MetaServerSecurity 

type MetaServerSecurity struct {
	// RequireAuthorization indicates whether enable metaServer security access
	// default false
	RequireAuthorization bool `json:"requireAuthorization,omitempty"`
	// InsecureSkipTLSVerify indicates whether enable insecure skip tls verify
	// default false
	InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`
	// TLSCaFile indicates the ca file
	// default /etc/edgemesh/metaserver/rootCA.crt
	TLSCaFile string `json:"tlsCaFile,omitempty"`
	// TLSCertFile indicates the cert file
	// default /etc/edgemesh/metaserver/server.crt
	TLSCertFile string `json:"tlsCertFile,omitempty"`
	// TLSPrivateKeyFile indicates the private key file
	// default /etc/edgemesh/metaserver/server.key
	TLSPrivateKeyFile string `json:"tlsPrivateKeyFile,omitempty"`
}

MetaServerSecurity indicates the metaServer security feature, KubeEdge >= 1.12.0 support TLS-based security access, refer to https://github.com/kubeedge/kubeedge/issues/4108

type MetricConfig added in v1.15.0 

type MetricConfig struct {
	// defaults false
	Enable bool `json:"enable,omitempty"`
	// Port is the port of the metrics server endpoint
	// default is 9999
	Port int `json:"port,omitempty"`
}

type PSK 

type PSK struct {
	// Enable indicates whether libp2p pnet is enabled.
	// default true
	Enable bool `json:"enable,omitempty"`
	// Path indicates the psk file path.
	// default /etc/edgemesh/psk
	Path string `json:"path,omitempty"`
}

type PprofConfig added in v1.15.0 

type PprofConfig struct {
	// Enables pprof at profilingAddress:profilingPort/debug/pprof.
	EnableProfiling bool `json:"enableProfiling,omitempty"`
	// ProfilingAddress is the IP address for the profiling server to serve on.
	ProfilingAddress string `json:"profilingAddress,omitempty"`
	// ProfilingPort is the port of the localhost profiling endpoint
	ProfilingPort int `json:"profilingPort,omitempty"`
}

type RelayNode 

type RelayNode struct {
	// NodeName indicates the relay node name, which is the same as the node name of Kubernetes
	NodeName string `json:"nodeName,omitempty"`
	// AdvertiseAddress sets the IP address for the relay node to advertise
	AdvertiseAddress []string `json:"advertiseAddress,omitempty"`
}

type Socks5Proxy 

type Socks5Proxy struct {
	// Enable indicates whether enable socks5 proxy server
	// default false
	Enable bool `json:"enable,omitempty"`
	// ListenPort indicates the listen port of Socks5Proxy
	// default 10800
	ListenPort int `json:"listenPort,omitempty"`
	// NodeName indicates name of host
	// do not allow users to configure manually
	NodeName string `json:"nodeName,omitempty"`
	// Namespace indicates namespace of host
	// do not allow users to configure manually
	Namespace string `json:"namespace,omitempty"`
}

Socks5Proxy indicates the socks5 proxy config

type TunnelLimitConfig added in v1.13.0 

type TunnelLimitConfig struct {
	// Enable indicates whether libp2p ResourceLimit is enabled,
	// defaults true
	Enable bool `json:"enable,omitempty"`
	// Tunnel Proxy all Stream InBound count
	// default:10240
	TunnelBaseStreamIn int `json:"tunnelBaseStreamIn,omitempty"`
	// Tunnel Proxy all Stream OutBound count
	// default:10240
	TunnelBaseStreamOut int `json:"tunnelBaseStreamOut,omitempty"`
	// Tunnel Proxy each Peer Stream InBound count
	// default:1024
	TunnelPeerBaseStreamIn int `json:"tunnelPeerBaseStreamIn,omitempty"`
	// Tunnel Proxy each Peer Stream OutBound count
	// default:1024
	TunnelPeerBaseStreamOut int `json:"tunnelPeerBaseStreamOut,omitempty"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.