k8s

package module
v0.3.2 Latest Latest
Warning

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

Go to latest
Published: Nov 17, 2026 License: MIT Imports: 9 Imported by: 0

README

k8s

Kubernetes 客户端封装——客户端构建 / Lease 选主

🌐 项目主页:https://oekit.github.io/ · 名称由来:Open Easy Kit(开源 · 易用 · 工具集合) 🤖 AI Agent:本仓规范与硬规则见 AGENTS.md;机器可读索引见 llms.txt(接口签名以源码为准)。

安装

go get github.com/oekit/k8s@v0.3.1

这个仓库做什么

k8s 是 Kubernetes 客户端封装:一套配置解析出 rest.Config 并构建 Clientset/DynamicClient(显式 kubeconfig → KUBECONFIG 显式意图 → in-cluster 自动 → ~/.kube/config 逐级回退), 外加 Lease 选主简化封装(leaderelection)适配主备/单活场景。

零可观测性副作用:不自动注入任何 tracing/logger 后端;SDK 内部统一 logx.Delegating("k8s") 懒解析。

组成

包 import 路径 做什么
k8s(模块根包) github.com/oekit/k8s RESTConfig(解析顺序:显式 KubeconfigPath → KUBECONFIG 显式意图 → in-cluster → ~/.kube/config;QPS/Burst 默认 50/100、负值=禁用限流(client-go 契约,两字段联动置 -1,#99)、UserAgent 默认 oekit-k8s)、NewClientset、NewDynamicClient(CRD/GVR)、InCluster() 探测(判定对齐 rest.InClusterConfig)
leaderelection github.com/oekit/k8s/leaderelection Lease 选主简化封装:Run(唯一入口,#90;阻塞当选,退出原因上抛:ctx 取消返回 ctx.Err(),失权返回 ErrLostLeadership;失权与 ctx 取消并存时失权优先,续约失败与取消同窗不掩蔽成 ctx.Err());New 已 Deprecated(自行 le.Run 拿不到失权错误面,v0.3.0 移除)+ OnStartedLeading/OnStoppedLeading/OnNewLeader 回调(OnStoppedLeading 是 elector 退出回调,client-go 无条件触发、不区分失权/关停——判断失权用 Run 返回值);Config.ReleaseOnCancel 优雅关停立即释放 Lease(默认 false:继任者等租约自然过期,最长 15s 空窗);Namespace 默认 POD_NAMESPACE → default;Identity 默认 hostname_pid_随机后缀(进程唯一,#100——同主机两进程/同 Pod 两容器不再互认,多副本部署仍建议显式传 Pod 名);LeaseDuration 须整秒且 ≥1s(构造期校验,#101——client-go 按整秒写 Lease,亚秒被截断为 0 会破互斥);仅要求 Lease get/create/update 权限

快速使用

import (
    k8s "github.com/oekit/k8s"
    "github.com/oekit/k8s/leaderelection"
)

// 集群内自动走 ServiceAccount;开发机走 KUBECONFIG/~/.kube/config
cs, err := k8s.NewClientset(k8s.Config{})
pods, _ := cs.CoreV1().Pods("default").List(ctx, metav1.ListOptions{})

// 主备单活:只有 leader 跑业务;失权(Run 返回 ErrLostLeadership)才退出交由重启,
// ctx 取消(优雅关停,含从未当选的副本)正常退出——勿在 OnStoppedLeading 里
// 无条件 log.Fatal,否则每次发布/缩容所有副本都非零退出,淹没真实失权告警
err = leaderelection.Run(ctx, cs, leaderelection.Config{
    LeaseName: "my-app",
    OnStartedLeading: func(ctx context.Context) { serve(ctx) },
    OnStoppedLeading: func() {}, // client-go 要求非 nil;退出原因用 Run 返回值区分
})
if errors.Is(err, leaderelection.ErrLostLeadership) {
    log.Fatal("lost leadership, exiting for restart")
}
关停语义与 ReleaseOnCancel

OnStoppedLeading 是 elector 退出回调而非「失权回调」:client-go 在 elector 退出时无条件触发——失去领导权、ctx 取消优雅关停、乃至从未当选 就退出(多副本部署里非 leader 副本占多数)都会调用。是否失权以 Run 的返回值为准:ErrLostLeadership = 失权(典型处理:退出交由重启); ctx.Err() = 优雅关停(正常退出即可)。失权与 ctx 取消并存时失权优先 (真实失败优先于取消副作用,workflow#61 分类口径,#81):续约失败与取消 同窗(续约已在失败、RenewDeadline 窗口内触发关停)按失权上抛,ctx 取消 信息仅留在报文,errors.Is(err, context.Canceled) 不成立——失权副本不得 被按「优雅关停」零退出吞掉告警。

默认(ReleaseOnCancel: false)优雅关停不释放 Lease,继任者须等租约 自然过期——按缺省 LeaseDuration 15s 计,每次滚动发布/缩容最长 15s 无人 单活。Config{ReleaseOnCancel: true} 在 ctx 取消后立即清空 Lease,继任者 在 RetryPeriod 量级内接管(从释放到继任者当选仍有一小段选主空窗,但不 再是 15s 量级)。启用前提(client-go 明示的安全约束):取消 ctx 前必须 保证受 Lease 保护的单活逻辑已完成/排空——释放后继任者可立刻当选,否则 会出现两个副本同时执行关键路径。

Run 返回后应尽快退出进程,不要复用同一进程以同一 Identity 再入选举 (重新参与在语义上等同于未退出)。

客户端限流

client-go 默认 QPS 5/Burst 10 对 controller 类负载偏保守;本仓默认 QPS 50/Burst 100,可用 Config{QPS: ..., Burst: ...} 覆盖。三态语义对齐 client-go(#80):0 = 默认 50/100,正数 = 覆盖,负值 = 禁用客户端限流 (迁移自裸 client-go 的 QPS:-1/Burst:-1 场景,不再被静默改写成默认值)。 禁用是两字段联动语义(#99):任一字段为负即 QPS/Burst 都置 -1—— client-go 的禁用形态要求成对出现,单独只设一个负值会产出 QPS=50/Burst=-1 这类非法组合(clientset 构造期报错、dynamic 每个请求 被限流器挡回)。Timeout <=0 均为不设(默认 0)——负值无 client-go 契约, 按 0 处理(#92),勿按 QPS/Burst 的负值直觉传负数;Watch/长流式调用必须 保持 0。

边界

  • 不封装 informer/cache 体系(v0.1.0 YAGNI,直接用 client-go 原生)
  • 不做 kubectl 类资源运维封装
  • 测试:配置解析用临时 kubeconfig,选主用 fake clientset——不依赖真实 apiserver

License

MIT

矩阵总览(24 活跃模块,自动生成)

模块 内容 矩阵内依赖
pkg 微工具集 36 合 1(errors/bloomx/contextx/ctxscope/container/distlock/stringx/slicex/enumx/convert/encoding/jsonrepair/httpjson/mathx/pathx/pagination/ptrx/reflectx/secretx/shellx/timex/cache/bufiox/strmap/singleflighttest/urlguard/webhook/cli/pack/procx/config/tarx/resumable/auditchain/canon/sse;v0.10.0 起 uidgen/validator 拆至 kitx);distlock(v0.45.0 起,etcdx#123 治本侧)后端中立分布式锁契约单源——Locker 接口 + ErrLockNotAcquired/ErrLockTimeout/ErrLockNotHeld 哨兵 + WithLock 骨架,零依赖(连 oekit 内部也不依赖),redisx/etcdx 的 distlock 改为消费本包(同进程同一 interface 类型,errors.Is 跨后端正确分类);reflectx(v0.46.0 起,core#130 治本)反射共享原语单源——DeepCopyValue 深拷贝(reflect.Value 递归 + 指针环防护:按指针身份记忆、先注册再下探、环内结构共享关系原样保留),core/config 与 pkg/pagination 两侧平行实现收敛于此;errors(v0.12.0 起)New/As/Is/Unwrap 与 stdlib 同型透传——下游哨兵/As 判定单 import 即可,类型同一性红线可完整执行;cache(v0.4.0 起)含缓存接口 CacheAside + BatchGetter 批量能力(MGet)+ LocalCache/SingleFlightCache + cachetest 契约(Run 真实时间 + RunWithClock 假时钟确定性 TTL 边界)+ Checker;LocalCache 时钟可注入(LocalConfig.Now——TTL/NullTTL 全路径确定性测试,v0.13.0 起);v0.16.0 起 LocalCache 可选形状——NoBackgroundSweep 关闭后台清扫 goroutine(嵌入式/短命进程,公开 Sweep 手动清扫口)、CloneOnRead 读命中返回副本(调用方可改写不污染缓存)、EvictPolicy 可选 LRU(默认 FIFO 不变)、GetEx 区分未命中与值为 nil(新增能力以可选接口 Sweeper/HitGetter 外置,不破坏其它后端);v0.23.0 起补 Peek 非删除式读(可选接口 PeekGetter 外置——读到过期条目只算不命中、不删除它,stale-if-error 兜底需要那份过期真值留在表内;SingleFlightCache 包装 LocalCache 时曾因前置检查走 Get 惰性删除而静默废掉 StaleIfError,#72);container(v0.9.0 起,收编原 collectionx)泛型容器 Set/Ring/Queue/SafeMap + Map(sync.Map 背书)/Slice(并发安全);mathx/jsonrepair(v0.11.0)Unstable 单边向上抖动 Upward / 宽松解析 UnmarshalLenient / 抽对象与抽数组对称原语 ExtractObject·ExtractArray(v0.18.0 起——多段数组与散文含 '{' 的数组文本不再整段作废,取首个口径与对象面一致);timex/stringx(v0.7.0 起)时间段边界 BeginningOf/EndOf 七对(分/时/日/周/月/季/年,周起始显式参数)+ trie 多模式替换器 Replacer(最长匹配)/ NewMask 敏感词遮罩;stringx Masker(v0.16.0 起)正则脱敏——按形态分类打码(形态标签进掩码供审计读)+ 保留首尾各 ≤4 字符定位线索且不可复原(保留位封顶不随长度变化),规则表由调用方完全提供;singleflighttest(v0.8.0 起)singleflight 共享契约测试套件(internal 与 concurrency 双侧引用);urlguard(v0.15.0 起)出站 SSRF 防护原语——CheckURL 字面量校验(私网/loopback/链路本地含云元数据 169.254.169.254/CGNAT/ULA/组播保留、.internal·.local·localhost 域名、scheme 白名单、IPv4-mapped IPv6 归一)+ DialFunc 拨号层预解析校验与实际 RemoteAddr 端点核对闭合 TOCTOU(Happy-Eyeballs 覆盖),构造态豁免 WithAllowPrivate/WithAllowCIDRs/WithAllowDomains,与 httpx WithDialFunc 一行组合(httpx#11);cli(v0.16.0 起)框架无关可单测的子命令分发原语——App/Command + 退出码 0/1/2 写死在包里、usage 按 Summary 自动生成、不读 os.Args 不调 os.Exit(输出流全由调用方给);pack(v0.16.0 起)迁移包容器原语——zip + manifest(格式版本/条数/每文件 SHA-256)+ JSONL 流式读写 + Inspect 体检一次列全问题并区分包损坏与版本不认识;config/tarx(v0.42.0 起)启动期静态配置加载管线(yaml+env 覆盖+必填汇总校验+敏感字段脱敏 dump,#329)+ 目录 tar 传输三件套(同口径预扫 Scan/流式写出 Write/防御式解包 Extract 跳过并点名 Zip Slip 穿越条目 + sha256 manifest 自证,#326);v0.43.0 起三处收口——cache.Checker 构造期 fail-fast(nil refresh panic/WithClock(nil) 回退默认,#356)+ 刷新跑在 WithoutCancel 上(leader 断开不再把取消缓存成 failTTL 传染等待者,瞬态 Canceled 不入缓存,#352)+ SingleFlightCache 按调用注入路径不再按 key 合并(source 不可比较,合并即串味/丢 TTL/强刷退化;Refresh 与 load 分键,#353);container.Ring 逻辑序归基(32 位平台高频写入不再回绕出负下标 panic,#354);cache/pack/urlguard 三个裸 Option 改名 CheckerOption/WriterOption/GuardOption(#355,禁裸 Option 仓规收尾);v0.44.0 起三面补齐——shellx 词法事实面 Analyze(tokenize:普通词/重定向运算符+目标/动态词三类事实分离 + HasRedirect/HasDynamic/按控制符分段,前缀规则判据不再被「git status > /etc/passwd」整类绕过,判不了就报错不尽力解析,#358)+ procx 子进程内存上限原语(WithMemoryLimit/MemGroup:cgroup v2 memory.max 创建·设置·清理 + MemoryLimitCapable 问询面,兑现失败 fail closed 拒绝执行不静默不限、OOM-kill 与非零退出可辨、换出面一并封死、非 Linux 如实降级,#359)+ resumable 分片上传/断点续传会话面(新包:会话创建/分片登记/断点查询/完成/中止/Sweep 状态机,CAS 进度·合并抢占·双源对账·孤儿清扫四坑单点化,纯内存状态面 + ChunkStore 接口化存储后端,#361);v0.49.0/v0.50.0 起三件下沉新包——auditchain(append-only 审计哈希链内核:canonical 字段序单源 + sha256 链 + verify 首断点即停,宿主注入行源)、sse(游标回放应答器:订阅先于回放去重 + 心跳注释帧 + 慢消费者断流自愈)、canon(策略面规范形指纹:canonical→版本哈希 + facet diff,schema 升格兜底) —
concurrency 并发与流控原语(async/gopool/group/singleflight/progress/syncx/ratelimit/retry)+ window 滑动窗口 / breaker 自适应熔断(规范哨兵 ErrCircuitOpen)/ shedding CPU 自适应降载 / batch 攒批执行器(满条数/满字节/窗口去重)/ timewheel 单级时间轮;v0.5.0 起 retry 指数退避+抖动(MaxDelay 封顶/溢出饱和)、loop 周期原语(忙时丢 tick/单轮 panic 收编/FirstDelay 可打断)、async labeled RunSafe(panic 按任务标签上报)、syncx.FanInErr 逐槽错误(panic 槽显式标记)、KeyedLimiter 增强(容量护栏/RetryAfter/速率热更)并接入 pkg/singleflighttest 契约测试;v0.8.0 起 singleflight DoShared 折叠可观测(Result.Waiters)、async panic 统一收编 typed *PanicError(errors.As 可辨、携带栈)+ 实例级 Runner panic 路由、retry DelayHint(服务端 Retry-After 建议优先)+ JitterRatio 比例抖动 + retry/httpx Retryable 可重试性判定;v0.9.0 起 breaker 显式三态状态机 closed/open/half-open——冷却(WithProbeTimeout 缺省 1m)期满首个放行即半开探测、探测成功关闸清窗/失败重开、失联超时自动回收 + AbandonGen 显式放弃,GenBreaker 代绑定(AllowGen/SuccessGen/FailureGen/AbandonGen:代仅在探测放行自增、陈旧代回报整体作废、开放期失败不后移冷却);v0.10.0 起 WithCooldown 独立业务冷却期(缺省回落 probeTimeout)+ WithConsecutiveFailures 连续失败计数触发(与速率型并联,补低 QPS 信号,对齐 Envoy consecutive_5xx);v0.11.0 起 ratelimit Lockout 防爆破锁(fail2ban 形态:滑窗失败计数→阈值锁定拒绝 LockDuration→成功 Reset 清零/到期自解,CheckLocked 返回剩余时长);v0.12.0 起 retry/httpx RetryableWithHeaders(403 + Retry-After/X-RateLimit-Remaining 头感知可重试判定,HeaderSource 零依赖抽象)、syncx FanInLimit 受限并发扇出(固定 worker 防下游过载)+ FanInLimitCtx(v0.14.0,ctx 感知:ctx 已取消未启动项 fn 一次不调、剩余槽快速排空 Canceled、在飞项照常落槽)、ratelimit WithTokenClock 时钟注入;v0.13.0 起 breaker 熔断期收敛到探测级(forcePass 强制探活 + 冷却期满半开探测,其余拒绝——SRE 公式退役为 closed→open 触发器,WithConsecutiveFailures 触发后流量真停)+ State()/State 枚举可观测出口;v0.16.0 起 ratelimit NewKeyedLimiterByFunc[K]——factory func(K) Limiter 按 key 定配额(一个管理器按接口维度分档位,NewKeyedLimiterOf 零破坏随迁;未登记 key 拿 factory 兜底档的坑已在 doc 点名,#31);v0.17.0 起 KeyedLimiter.Create 护栏内原子登记(表满先回收空闲与 Allow 同路、仍满拒绝计 OverCapHits、已存在不覆盖——热更走 Replace;解决 ByFunc factory 库锁内调用致消费方锁序倒置,#33);v0.18.0 起 retry.DoValue 泛型伴生——带返回值的重试(DoValue[T](ctx, cfg, fn func(attempt int) (T, error));Do 改为委托给 DoValue——退避序列/抖动/MaxDelay 封顶/DelayHint 优先/Retryable 门控/ctx 取消只有一份实现,杜绝「同一个仓里两份实现」;失败返回零值与最后一次错误) pkg
logx 统一日志门面(多后端可替换 + caller 归属;Sink 已迁嵌套模块 logx/sink,根包纯 stdlib);WithFilter 脱敏/丢弃包装(FilterKey 命中键替换 ***/FilterFunc 丢整条,子 logger 保持规则)、Slogger/SlogHandler 正向桥(三方 slog 直接消费 logx 生态)、TraceHandler 任意 slog.Handler 自动注入 trace_id、NewAuditLogger 审计留痕(级别锁 Info,不受 LOG_LEVEL 降级)、LevelEnabler 热路径提前判级、ParseLogLevel 返回 (Level, error) + ParseLogLevelOr 配错退默认(v0.7.0);优雅关停正身在 core/lifecycle.Manager(logx/shutdown 仅余 Deprecated 别名);桥接子包 hlog/hertzlog/kitexlog 为嵌套模块按需引入 —
core 应用基建件——governance 治理 schema、config 配置加载(LoadBootstrap/LoadDotEnv/Get* 系、default/env/range/options tag 校验、OverlaySource 多源叠加热更、ApplyEnvOverlay env 优先 12-factor 形态)、transport 协议无关传输上下文(Transporter/Header/Server·Client ctx 存取,仅标准库)、chain 中间件链(Handler/Middleware/Chain/Recovery/Timeout,与 nns-endpoint.Endpoint 同形)、lifecycle 契约 + Manager 优雅关停(自 logx/shutdown 迁入,日志 *slog.Logger——core 不再依赖 logx)、network IP 工具、version;v0.9.0 起 config FieldSet 显式提供集合(yaml 显式 port:0 不再被 default/env 覆盖——LoadBootstrap 默认接线,免全量指针化)+ require tag(必须 yaml/env 提供,缺失列全并附 env 提示)+ v0.9.1 修 yaml:,inline 字段在 FieldSet 下漏标记(inline 叶子显式零值曾被 default 覆盖);v0.9.2 env 卫生改纯静态(仅格式/重名,移除依赖进程环境的拼写冒烟检查——误报 PATH/HOME、漏无人设置的真拼错,core#8),命名一致性走 LintEnvNaming 诊断 / WithEnvNamingLint 可选 fail-closed / ignorederived="true" 豁免;v0.10.0 起 config 严格模式——LoadBootstrap[T](envFlag string, opts ...LoadOption) 传 config.WithStrict() 开启:未知键拒载(不再静默忽略),错误带嵌套路径 + 该层合法键清单 + 近似拼写建议(UnknownKeyError);默认行为不变,严格模式显式开启;v0.11.0 起 config 加载入口按来源拆开——LoadFile(任意路径:CLI -config 路径、容器内固定挂载位)+ Unmarshal(字节源:API 下发 / 模板渲染 / 测试夹具),与 LoadBootstrap(etc/ 约定)共享同一条解码线,因此严格模式诊断面(嵌套路径 / 合法键清单 / 拼写建议)与来源无关;LoadBootstrap 行为与错误文案逐字不变 pkg
kitx 标识与校验——uidgen(Snowflake 全局单例+Extract 元数据、手写 RFC 4122 v4 UUID 零第三方依赖、RandomHex/RandomString 拒绝采样随机串)+ validator(go-playground/validator v10 接口化门面:struct tag 校验/自定义规则注册/ValidationError Unwrap 为 BizError 400 对接 middleware.Fail)+ hash(v0.2.0 起非密码学哈希助手 Md5Hex/Md5Bytes——缓存键/幂等键/短唯一 code,格式稳定承诺,pkg 2026-09-15 治理移除弱哈希后 kitx 侧收编 pkg#10),自 pkg v0.10.0 拆出 logx、pkg
metrics Prometheus 门面 + 弹性指标族 core
tracing OpenTelemetry 追踪 + trace_id 真相源(v0.3.0 起 OTLP 双协议导出:gRPC 缺省 / HTTP,Config.Protocol + Headers,切换协议不丢传播器/指标/旧 provider 关闭) logx、pkg
registry 注册发现核心(provider 无关 SPI:Registrar/Discoverer/Subscriber/ConfigStore + 实例模型 + netutil)+ sdbridge + registrymocks——根仓零第三方依赖;Nacos 实现与 Nacos 配置源已拆成嵌套模块(v0.5.0 起:registry/nacosimpl、registry/nacos——nacos-sdk-go 重依赖隔离在此,实测单独引入即拖 63 个第三方模块,不隔离时只要 SPI 接口的消费方也会被连带拖入) core、pkg
data 数据访问门面——复刻 ekit data/ 能力面:cache/rediscache/crud/distlock/gormx/redisx/timertask/cachetest 八子包 re-export(类型同一,实现住 pkg 与各子仓)+ cached 缓存读写编排(写后失效/事务提交后失效/查询缓存版本号失效/GetByIDs 批量点读 MGet 快路径/bloom 防穿透)+ twolevel 两级缓存与跨实例失效广播(v0.7.0 起本仓唯二非 re-export 实现);v0.15.0 起壳跟随源仓演进——cache 壳补 LocalCache 可选形状(EvictPolicy/Sweeper/HitGetter)、cachetest 壳补 5 个契约套件入口(套件 8 → 13 场景)、v0.18.0 起 cache 壳补 PeekGetter 别名 + cachetest 壳补 2 个 stale-if-error 契约入口(套件 13 → 15 场景)、timertask 壳的 Redis 形态随源仓 v0.2.0 迁至嵌套模块 timertask/redis(壳不再转发 RedisBackend/ShardManager,Redis 形态直接依赖该嵌套模块);all/ 聚合模块已废弃 retract concurrency、gormx、logx、pkg、redisx、timertask
gormx SQL/GORM 全家——连接池增强、框架无关 CRUD Service、仓储(原 oekit/gorm,v0.3.0 更名) logx、pkg
redisx Redis 全家——客户端封装(根包)、分布式缓存 cache/、分布式锁 distlock(Locker 同形可互换;Renew 手动续期(false=锁丢失,不进 Locker 接口保 etcdx 互换)+ WithAutoRenew 覆盖 TryLock 自动续期(v0.8.0 feat!:此前组合不续期);Semaphore ZSET 槽位信号量(v0.8.0:Acquire 同 identifier 幂等刷新 + Lua 内原子清过期槽崩溃自愈、Renew 仅未过期槽可续、Cleanup 返条数、无 Redis 降级 fail-fast))、分布式限流 ratelimit(Lua 三态 + 故障本地兜底);v0.9.0 起 distlock Lockout 分布式防爆破锁(Redis 侧 fail2ban:滑窗失败计数→阈值锁定 Penalty→Reset 清零,与 concurrency/ratelimit.Lockout 进程内孪生——多实例共享计数是存在理由;惩罚只按首次触发计算、nil client fail-fast 不降级,#6) concurrency、logx、pkg
etcdx etcd 全家——客户端封装(根包:生产默认值/Health 探活/Close(ctx) 幂等)、registry 注册发现实现(SPI 对接 registry/nacos 链路:Lease KeepAlive 注册 + 丢约指数退避自动重注册、prefix Watch 订阅推送、ConfigStore KV 配置监听)、distlock 分布式锁(Session+concurrency.Mutex 公平排队,接口与 redisx/distlock.Locker 同形可互换,可选无 etcd 降级放行) concurrency、logx、pkg、registry
httpx HTTP 客户端 + 负载均衡——服务发现/熔断(规范哨兵 ErrCircuitOpen)/重试/指标/OTel 透传;loadbalance Selector 形态(RoundRobin/Random/Weighted/一致性哈希权重感知虚拟副本/p2c 自适应——EWMA 经 DoneFunc 回写建立、Err 计 1s 惩罚;WithFilter 按元数据过滤;v0.4.0 起 Balancer 全家族删除无兼容路径);codec 注册制编解码器(json 内置 + form 表单,DoCodec 请求按 codec 序列化、响应按 Content-Type 反查回退请求 codec);v0.6.0 起 net/http 桥接层 NewRoundTripper/StdClient——存量标准库外呼一行 Transport 接入熔断/重试/指标/链路(重试缺省关显式开、非 2xx 非错误、hop-by-hop 隔离,#8);v0.8.0 起 SafeDialFunc/WithSafeDial 出站 SSRF 防护胶水(判定单源 pkg/urlguard v0.15.0:解析 IP 全量预检 + 实际 RemoteAddr 端点核对闭合重解析 TOCTOU、Happy-Eyeballs 覆盖,构造态豁免;v0.7.0 内置的独立 httpx/urlguard 实现收敛删除,#11) concurrency、logx、metrics、pkg、registry、tracing
network 轻量网络客户端——WebSocket/NATS/MQ 抽象、连接与流工具 concurrency、logx、pkg、tracing
timertask 分片定时任务(FNV-1a、心跳续约);v0.1.5 起可选可靠投递 DeliveryAtLeastOnce(租约 + Ack + 可见性超时;过期租约回扫重投/死信、停机 best-effort 收租,v0.1.7 接入生命周期真正生效);v0.2.0 起 Redis 后端迁至嵌套模块 timertask/redis(根包不再引 go-redis/logx/concurrency,require 仅 pkg——import timertask 与 import timertask/local 的模块依赖面均无 redis,纯 stdlib 嵌入式场景可用)+ 新增 local 子包 cron 调度器 Scheduler(表达式复用 pkg/timex/cron 不另写一份;并发度/CatchUp 补跑/退出语义明确,FakeClock 假时钟驱动、触发点序列可确定性断言) pkg
middleware Hertz 标准中间件栈(模块根 mw,双层目录已收平)+ contrib 桥接 + hmw + SheddingMiddleware 自适应降载 + chainmw 子包(transport 感知框架无关中间件,基于 core/chain+transport:Recovery 带 panic 隔离上报钩子 WithRecoveryReporter、AccessLog skip+redact+自定义字段、MetadataPropagate——kitex 经 kitex/chainmw.ToKitex 复用同一实现,根包 Recovery/AccessLog 已薄壳化复用 chainmw 内核、下游 handler 可经 transport.FromServerContext 读协议无关传输信息);v0.6.0 起 accesslog 凭证路径脱敏(WithAccessLogRedactPathPrefixes)、ratelimit 默认 KeyFunc 去端口(连接桶→地址桶);v0.11.0 起 WithAccessLogSink 落库 sink(AccessRecord{Method,Path,Status,Latency,ClientIP,UserAgent,TraceID} 与日志同源、c 同传可读业务键、error/panic 只记 Warn 不影响主链路、SkipPaths 命中不触发)+ chainmw.WithSink 内核同构(kitex 随 ToKitex 获得)+ StackConfig.DisableResponseWrap 响应自管一键形态(TraceID→Recovery→AccessLog)与 AccessLogOptions 透传 + doc/README「适用边界」段(响应契约统一 vs handler 自管的推荐组合,#18);v0.12.0 起 AccessLog panic 恢复点产出记录(AccessRecord.Panic 标记 + Err 摘要,Hertz status 按 Recovery 缺省 500)后按原值重抛——panic 请求不再零访问记录,sink/kitex 桥接同步留痕,#20;v0.13.0 起 accesslog 内建日志可关闭/改道(WithAccessLogSilent 只采不写、WithAccessLogLogger 注入宿主 logger 避免双写;静默下 skip/redact/sink/panic 记录照常),内核 chainmw.WithSilent 同构(kitex 随 ToKitex 获得),#38 concurrency、core、logx、metrics、pkg、registry、tracing
k8s Kubernetes 客户端封装——RESTConfig/Clientset/DynamicClient 构建(显式 kubeconfig → KUBECONFIG 显式意图 → in-cluster 自动 → ~/.kube/config 逐级回退,QPS/Burst 限流默认 50/100、负值=禁用客户端限流)+ leaderelection 子包 Lease 选主简化封装(OnStartedLeading/OnStoppedLeading/OnNewLeader 回调,主备单活,仅要求 Lease CRUD 权限;失权与 ctx 取消并存时失权优先上抛 ErrLostLeadership,续约失败与取消同窗不掩蔽) logx、pkg
nns NNS 服务治理客户端——provider 无关发现/配置/实例缓存 concurrency、core、logx、pkg、registry
nns-endpoint NNS 端点工厂——per-service 熔断、换实例重试、gRPC 池 httpx、logx、metrics、nns、pkg、registry
bootstrap 应用生命周期引导——New(WithServiceName/WithShutdownTimeout/WithBeforeServe) + Run(fn) + healthz;App.Ready/ReadyChan/IsReady 就绪门(幂等并发安全)——嵌套 bootstrap/nacos 自 v0.3.0 起 NNS 注册延迟到 Ready 之后(server 就绪 → userFn 触发 Ready → 才进注册中心)、关停序 nns 反注册先于 server 关闭;就绪门漏接时可观测——nacos 看门狗超时打 ERROR 点明「服务不会注册到注册中心」(WithReadyTimeout 可调)+ NNSComponent.RegistrationState() 暴露注册阶段(pending/registered/failed/skipped/shutdown);Metrics/Tracing 在嵌套模块 bootstrap/obs concurrency、core、logx、pkg
hertz Hertz 运行时集成(模块根扁平化)——日志桥接、生命周期、SSE/health/metrics、适配器、OTel、crudh/validatorh(基于 kitx/validator)/versionh(原 handler 微库收编);RunServer 变参就绪门 WithOnReady(全部 HostPort TCP 探活可建连后回调,探活超时按启动失败优雅关机;缺省超时 5s 经 WithReadyProbeTimeout 调整——探活目标是 server 自动取到的全部 HostPort,无探活地址覆盖选项(kitex 侧才有 WithReadyAddr)),配合 bootstrap Ready 实现 NNS 延迟注册;transportx(hertz→core/transport 同构适配器)+ chainmw 桥接 bootstrap、concurrency、core、gormx、kitx、logx、metrics、middleware、nns、pkg、registry、tracing
kitex Kitex 生态——日志桥接、治理热更、生命周期、BizError 桥接、kitexotel、istio(xDS 动态熔断,原 istio 微库收编);RunServer 变参就绪门(WithOnReady/WithReadyAddr/WithReadyProbeTimeout)+ chainmw.ToKitex(core/chain.Middleware → kitex 中间件,与 hertz 共享 middleware/chainmw 实现)+ transportx bootstrap、concurrency、core、logx、metrics、nns、pkg、registry、tracing
workflow 组合式流程编排——串行/并行/异步/条件分支 + Hook AOP concurrency、logx、pkg
kitex-examples Kitex echo 示例——client/server + IDL + 治理配置 bootstrap、core、kitex、logx、tracing

Documentation

Overview

Package k8s 提供 Kubernetes 客户端封装:RESTConfig/Clientset/DynamicClient 构建(显式 kubeconfig → KUBECONFIG 显式意图 → in-cluster 自动 → ~/.kube/config 逐级回退)与 Lease 选主简化封装 (leaderelection 子包,适配主备/单活场景)。

零可观测性副作用:不自动注入任何 tracing/logger 后端,SDK 内部统一 logx.Delegating("k8s") 懒解析。

快速接入

// 集群内(Pod)自动走 ServiceAccount;开发机走 KUBECONFIG/~/.kube/config。
// 显式 KUBECONFIG 环境变量即显式意图(与 kubectl 同语义),优先于
// in-cluster 自动探测;in-cluster 试加载失败自动回退 kubeconfig(#79)。
cs, err := k8s.NewClientset(k8s.Config{})

// 显式 kubeconfig
cs, err := k8s.NewClientset(k8s.Config{KubeconfigPath: "/path/to/kubeconfig"})

选主(同 kube-apiserver Lease 协议,二进制/多副本单活)。leaderelection 是独立子包,与 k8s 根包分开 import(#104——Go 不允许经父包限定符访问 子包,k8s.leaderelection 无法编译):

import (
    "github.com/oekit/k8s"
    "github.com/oekit/k8s/leaderelection"
)

err := leaderelection.Run(ctx, cs, leaderelection.Config{
    LeaseName: "my-app",
    OnStartedLeading: func(ctx context.Context) { serve(ctx) },
    OnStoppedLeading: func() {}, // client-go 要求非 nil;退出原因用 Run 返回值区分
})
// 失权(续约失败放弃领导权)返回 ErrLostLeadership——此时才退出交由重启
// (含续约失败与取消同窗:失权优先上抛,不被掩蔽成 ctx.Err(),#81);
// ctx 取消(含 WithTimeout 的 deadline 触发,#108)返回 ctx.Err()——优雅
// 关停(含从未当选的副本),正常退出即可,勿无条件 log.Fatal(否则每次
// 发布/缩容所有副本都非零退出)
if errors.Is(err, leaderelection.ErrLostLeadership) {
    log.Fatal("lost leadership, exiting for restart")
}
Example (QuickStart)
package main

// doc.go「快速接入」选主示例的可编译性守卫(#104):示例此前用了非法限定符
// k8s.leaderelection——leaderelection 是独立子包,Go 不允许经父包限定符访问
// 子包,逐字照抄编译不过(undefined: k8s.leaderelection);而注释不是可执行
// 的 Example,CI 抓不到。本文件把示例按修复后的真实 import 路径做成 Example
// 函数:无 Output 注释 ⇒ go test 仅编译不执行(不触发 NewClientset 的
// kubeconfig 探测与选主网络动作),从此示例可编译性由 CI 守住。与 README
// 「快速使用」、leaderelection 包文档的同一写法三处对齐。

import (
	"context"
	"errors"
	"log"

	"github.com/oekit/k8s"
	"github.com/oekit/k8s/leaderelection"
)

// serve 是示例里的单活逻辑占位(阻塞至失去领导权时 ctx 被取消)。
func serve(ctx context.Context) { <-ctx.Done() }

func main() {
	cs, err := k8s.NewClientset(k8s.Config{})
	if err != nil {
		log.Fatal(err)
	}
	runErr := leaderelection.Run(context.Background(), cs, leaderelection.Config{
		LeaseName:        "my-app",
		OnStartedLeading: serve,
		OnStoppedLeading: func() {}, // client-go 要求非 nil;退出原因用 Run 返回值区分
	})
	if errors.Is(runErr, leaderelection.ErrLostLeadership) {
		log.Fatal("lost leadership, exiting for restart")
	}
}

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultKubeconfigPath

func DefaultKubeconfigPath() string

DefaultKubeconfigPath 返回当前用户家目录下的默认 kubeconfig 路径 (HOME 不可用时返回空串)。

func InCluster

func InCluster() bool

InCluster 判断当前进程是否具备可用的集群内 ServiceAccount 配置:除 POD 环境注入的非空 KUBERNETES_SERVICE_HOST/PORT 外,还要求 ServiceAccount token 可加载(与 client-go rest.InClusterConfig 的判定对齐)。只看两个 env 的弱判定在半注入环境(CI runner Pod、kubectl exec 残留 export 等) 会误判为集群内,截断 kubeconfig 回退链(#79)。

仅作外部探测用途:RESTConfig 内部不走本函数——判定+实取会两次调用 rest.InClusterConfig,每次客户端构造双读 SA token,两调之间 token 可被 卸载(TOCTOU,#91);RESTConfig 单次实取、失败走回退链。

func NewClientset

func NewClientset(cfg Config) (*kubernetes.Clientset, error)

NewClientset 构建带全部内置资源组的客户端(典型入口)。

func NewDynamicClient

func NewDynamicClient(cfg Config) (dynamic.Interface, error)

NewDynamicClient 构建非资源型动态客户端(CRD/GVR 操作)。

func RESTConfig

func RESTConfig(cfg Config) (*rest.Config, error)

RESTConfig 按配置解析出 *rest.Config(连接参数已应用)。

解析顺序:显式 KubeconfigPath > KUBECONFIG 环境变量(显式意图,与 kubectl 同语义)> in-cluster(ServiceAccount,判定+实取单次调用,#91)> ~/.kube/config。in-cluster 加载失败不截断回退链(#79)——疑似集群内 (POD env 注入)时告警并回退,纯开发机静默回退。

Types

type Config

type Config struct {
	// KubeconfigPath 显式指定 kubeconfig 路径;设置后不再探测 in-cluster。
	// 为空时:显式 KUBECONFIG 环境变量(显式意图,与 kubectl 同语义)优先,
	// 其次集群内环境(POD)自动使用 ServiceAccount,最后回退 ~/.kube/config;
	// in-cluster 试加载失败不截断回退链,自动回退 kubeconfig 并告警(#79)。
	KubeconfigPath string `yaml:"kubeconfigPath"`
	// QPS/Burst 是客户端限流:0 = 未配置(默认 50/100——client-go 默认 5/10
	// 对 controller 类负载偏保守);正数 = 覆盖;负值 = 禁用客户端限流
	// (client-go 契约,迁移自裸 client-go 的 QPS:-1/Burst:-1 场景,#80)。
	// 禁用是**两字段联动**语义(#99):任一字段为负即两个字段都置 -1——
	// client-go 的禁用形态是 QPS:-1/Burst:-1 成对出现,单独只设一个负值
	// 会产出 QPS>0 && Burst<=0 的非法组合(NewClientset 构造期被拒;
	// NewDynamicClient 限流器建成 rate.NewLimiter(50,-1),每个请求都被挡回)。
	QPS   float32 `yaml:"qps"`
	Burst int     `yaml:"burst"`
	// Timeout 是单请求超时;<=0 均为不设(#92)——负值无 client-go 契约,
	// 按 0 处理,勿按 QPS/Burst 的「负值=禁用限流」直觉传负数(rest.Config
	// 负 Timeout 只会让请求即刻超时)。Watch/长流式调用必须保持 0。
	Timeout time.Duration `yaml:"timeout"`
	// UserAgent 是请求 UA(默认 "oekit-k8s",便于 apiserver 审计归因)。
	UserAgent string `yaml:"userAgent"`
	// InsecureSkipTLSVerify 跳过 TLS 校验(仅开发/联调,勿用于生产)。
	InsecureSkipTLSVerify bool `yaml:"insecureSkipTLSVerify"`
}

Config 是客户端构建配置。

Directories

Path Synopsis
Package leaderelection 提供基于 Kubernetes Lease 的选主简化封装: 一个二进制多副本部署时单活运行(定时任务分片、controller、缓存刷新等 场景的兜底互斥),底层即 kube-controller-manager 同款 leader election 协议(coordination.k8s.io/lease),对 apiserver 仅有 Lease 的 get/create/update 权限要求。
Package leaderelection 提供基于 Kubernetes Lease 的选主简化封装: 一个二进制多副本部署时单活运行(定时任务分片、controller、缓存刷新等 场景的兜底互斥),底层即 kube-controller-manager 同款 leader election 协议(coordination.k8s.io/lease),对 apiserver 仅有 Lease 的 get/create/update 权限要求。

Jump to

Keyboard shortcuts

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