ek8s

README

ek8s 组件使用指南

1 简洁

• 规范了标准配置格式，提供了统一的 Load().Build() 方法。
• 支持查询K8S信息
• 根据K8S Endpoints调用gRPC

2 Example

• 获取K8S信息
• 根据K8S endpoints调用gRPC

3 K8S配置

type Config struct {
    // Addr k8s API Server 地址
    Addr string
    // Debug 是否开启debug模式
    Debug bool
    // Token k8s API Server 请求token
    Token string
    // Token k8s API Server 请求token file
    // 本地运行时需要将 tokenFile 参数显式的设置为 ""
    TokenFile string
    // Namespaces 需要进行查询和监听的 Namespace 列表
    Namespaces []string
    // DeploymentPrefix 命名前缀
    DeploymentPrefix string
    // TLSClientConfigInsecure 是否启用 TLS
    TLSClientConfigInsecure bool
}

4 默认配置

• host: KUBERNETES_SERVICE_HOST 环境变量
• port: KUBERNETES_SERVICE_PORT 环境变量
• token: /var/run/secrets/kubernetes.io/serviceaccount/token 文件中值
• tokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token 文件路径

5 根据K8S信息，调用gRPC

5.1 K8S配置

[k8s]
# k8s API Server 地址
addr="https://$API_SERVER_ADDR"
# Debug 是否开启debug模式
debug = true
# Token k8s API Server 请求token
token="$API_SERVER_TOKEN"
# Token k8s API Server 请求token file
# 本地运行时：需要显式设置 tokenFile = ""
# 集群模式下运行时：需要 tokenFile = "/var/run/secrets/kubernetes.io/serviceaccount/token" 或释掉 tokenFile 这个 key
tokenFile = ""
# Namespaces 需要进行查询和监听的 Namespace 列表
namespaces=["default"]

[grpc.test]
debug = true # 开启后并加上export EGO_DEBUG=true，可以看到每次grpc请求，配置名、地址、耗时、请求数据、响应数据
addr = "k8s:///test:9090"
#balancerName = "round_robin" # 默认值
#dialTimeout = "1s" # 默认值
#enableAccessInterceptor = true
#enableAccessInterceptorRes = true
#enableAccessInterceptorReq = true

5.2 用户代码

配置创建一个 k8s 的配置项，其中内容按照上文配置进行填写。以上这个示例里这个配置key是k8s

代码中创建一个 k8s 客户端， ek8s.Load("k8s").Build()，代码中的 key 和配置中的 key 要保持一致。创建完 k8s 客户端后， 将他添加到你所需要的Registry里即可。

// 构建k8s registry，并注册为grpc resolver
registry.DefaultContainer().Build(registry.WithClient(ek8s.Load("k8s").Build()))
// 构建gRPC.ClientConn组件
grpcConn := egrpc.Load("grpc.test").Build()
// 构建gRPC Client组件
grpcComp := helloworld.NewGreeterClient(grpcConn.ClientConn)
fmt.Printf("client--------------->"+"%+v\n", grpcComp)

Documentation

Index

• Constants
• type Component
  • func (c *Component) Config() Config
  • func (c *Component) ListEndpoints(option ListOptions) (endPoints []*v1.EndpointsList, err error)
  • func (c *Component) ListEndpointsByName(name string) (endPoints []*v1.Endpoints, err error)
  • func (c *Component) ListPods(option ListOptions) (pods []*v1.PodList, err error)
  • func (c *Component) ListPodsByName(name string) (pods []*v1.Pod, err error)
  • func (c *Component) NewWatcherApp(ctx context.Context, appName string, kind string) (app *WatcherApp, err error)
• type Config
  • func DefaultConfig() *Config
• type Container
  • func DefaultContainer() *Container
  • func Load(key string) *Container
  • func (c *Container) Build(options ...Option) *Component
• type KubernetesEvent
• type ListOptions
• type Option
  • func WithAddr(addr string) Option
  • func WithDeploymentPrefix(deploymentPrefix string) Option
  • func WithNamespaces(namespaces []string) Option
  • func WithTLSClientConfigInsecure(insecure bool) Option
  • func WithToken(token string) Option
  • func WithTokenFile(tokenFile string) Option
• type WatcherApp
  • func (c *WatcherApp) ProcessWorkItem(f func(info *KubernetesEvent) error) bool

Constants

const (
	KindPods      = "pods"
	KindEndpoints = "endpoints"
)

const PackageName = "component.ek8s"

Types

type Component

type Component struct {
	*kubernetes.Clientset
	// contains filtered or unexported fields
}

Component ...

func (*Component) Config

func (c *Component) Config() Config

func (*Component) ListEndpoints

func (c *Component) ListEndpoints(option ListOptions) (endPoints []*v1.EndpointsList, err error)

func (*Component) ListEndpointsByName

func (c *Component) ListEndpointsByName(name string) (endPoints []*v1.Endpoints, err error)

func (*Component) ListPods

func (c *Component) ListPods(option ListOptions) (pods []*v1.PodList, err error)

func (*Component) ListPodsByName

func (c *Component) ListPodsByName(name string) (pods []*v1.Pod, err error)

func (*Component) NewWatcherApp

func (c *Component) NewWatcherApp(ctx context.Context, appName string, kind string) (app *WatcherApp, err error)

type Config

type Config struct {
	// Addr k8s API Server 地址
	Addr string
	// 是否开启，默认开启
	Enable bool
	// Token k8s API Server 请求token
	Token string
	// Token k8s API Server 请求token file
	// 本地运行时：一定需要显式设置 tokenFile = ""
	// 集群模式下运行时：需要 tokenFile = "/var/run/secrets/kubernetes.io/serviceaccount/token" 或释掉 tokenFile 这个 key
	TokenFile string
	// Namespaces 需要进行查询和监听的 Namespace 列表
	Namespaces []string
	// DeploymentPrefix 命名前缀
	DeploymentPrefix string
	// TLSClientConfigInsecure 是否启用 TLS
	TLSClientConfigInsecure bool
}

Config 定义了ek8s组件配置结构

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig 返回默认配置，默认采用集群内模式

type Container

type Container struct {
	// contains filtered or unexported fields
}

func DefaultContainer

func DefaultContainer() *Container

func Load

func Load(key string) *Container

func (*Container) Build

func (c *Container) Build(options ...Option) *Component

Build ...

type KubernetesEvent

type KubernetesEvent struct {
	IPs       []string
	EventType watch.EventType
}

type ListOptions

type ListOptions = metav1.ListOptions

type Option

type Option func(c *Container)

Option 可选项

func WithAddr

func WithAddr(addr string) Option

func WithDeploymentPrefix

func WithDeploymentPrefix(deploymentPrefix string) Option

func WithNamespaces

func WithNamespaces(namespaces []string) Option

func WithTLSClientConfigInsecure

func WithTLSClientConfigInsecure(insecure bool) Option

func WithToken

func WithToken(token string) Option

func WithTokenFile

func WithTokenFile(tokenFile string) Option

type WatcherApp

type WatcherApp struct {
	*kubernetes.Clientset
	// contains filtered or unexported fields
}

func (*WatcherApp) ProcessWorkItem

func (c *WatcherApp) ProcessWorkItem(f func(info *KubernetesEvent) error) bool