Merge pull request #2 from xiaozongyang/deploy/add_k8s_deploy

1. support docker multi-arch docker images
2. push images to docker hub
3. add Chinese README

Author: xiaozongyang

Dockerfile

@@ -1,11 +1,21 @@
-FROM golang:1.24.0 as builder
+FROM --platform=$BUILDPLATFORM golang:1.24.0 as builder
 
-WORKDIR /workspace
+WORKDIR /app
 ENV GOPROXY=https://goproxy.cn,direct
 
+COPY go.mod go.sum ./
+RUN go mod download
+
 COPY . .
 
-#### Build
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build .
 
-CMD ["/workspace/kube-node-metrics"]
+ARG TARGETARCH
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=$TARGETARCH go build -o kube-node-metrics .
+
+FROM scratch
+WORKDIR /
+COPY --from=builder /app/kube-node-metrics .
+
+EXPOSE 19191
+
+CMD ["/kube-node-metrics"]

Makefile

@@ -0,0 +1,16 @@
+.PHONY:
+build:
+	go fmt ./...
+	go mod tidy
+	go vet ./...
+	go build .
+
+.PHONY:
+build-docker:
+	docker buildx build --platform linux/amd64,linux/arm64 \
+		-t xiaozongyang/kube-node-metrics:latest \
+		--push .
+
+.PHONY:
+clean:
+	rm kube-node-metrics

README-zh.md

@@ -0,0 +1,47 @@
+# README [Go To English Version](README.md)
+
+本项目遵守 MIT 协议。
+
+本项目灵感来源于 [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics) 和 [kubectl](https://github.com/kubernetes/kubectl)。
+
+本项目实现了一个暴露 kubernetes 节点资源指标的服务，目前暴露的指标有：
+```
+kube_node_metrics_cpu_request
+kube_node_metrics_cpu_limit
+kube_node_metrics_mem_request_bytes
+kube_node_metrics_mem_limit_bytes
+```
+
+本项目暴露出的资源申请(request)和限制()g(limit)的指标值应该和 `kubectl describe node <node>` 命令的结果相同。
+
+## 快速开始
+### 在 Minikube 上试用
+请确保你已经安装了 [minikube](https://github.com/kubernetes/minikube)。
+
+在你终端中执行下列命令：
+```
+minikube start
+kubectl apply -f deploy.yaml
+```
+
+### 在 Kubernetes 上部署
+```bash
+kubectl apply -f deploy.yaml
+```
+
+## 构建
+### 手动构建二进制
+```bash
+go build .
+```
+
+### 构建 docker 镜像
+```bash
+docker build . -t <image>:<tag>
+```
+
+## 运维
+本项目也暴露了一个 `kube_node_metrics_last_full_sync_ok_time_seconds` ata 指标，用于表示最后一次全量同步成功的时间。 根据这个指标可以配置报警，例如通过 `time() - kube_node_metrics_last_full_sync_ok_time_seconds > 300` 来通知已经 5 分钟没有同步成功的情况。
+
+## TODO
+1. 支持暴露节点 k8s 节点标签，范围通过前缀指定

README.md

@@ -1,4 +1,6 @@
-# Kube Node Metrics
+# README [查看中文版](README-zh.md)
+
+This project is licensed under the MIT License.
 
 This project is inspired by [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics) and [kubectl](https://github.com/kubernetes/kubectl).
 
@@ -13,14 +15,35 @@ kube_node_metrics_mem_limit_bytes
 These samples values should be equal to the result of `kubectl describe node <node>`.
 
 ## Getting started
-TODO: add docker image
 
-### build manually
+### Try in Minikube
+Please ensure you have [minikube](https://github.com/kubernetes/minikube) installed.
+
+Run with following commands in your terminal:
+```
+minikube start
+kubectl apply -f deploy.yaml
+```
+
+### Run in Kubernetes
+```bash
+kubectl apply -f deploy.yaml
+```
+
+## Build
+### build binary manually
 ```bash
 go build .
 ```
 
-# TODO
-1. release with docker image
-1. support custom k8s api server address
-1. support mutiple arch docker iamges
+### build docker image
+```bash
+docker build . -t <image>:<tag>
+```
+
+## Operating
+This exporter also exposed a metric `kube_node_metrics_last_full_sync_ok_time_seconds` which indicates the last full sync timestamp in seconds. You can create alert rule to monitor the exporter health with the expression `time() - kube_node_metrics_last_full_sync_ok_time_seconds > 300` and you will receive alert if the exporter is not sync sucessfully for 300 seconds.
+
+
+## TODO
+1. support exposed node labels match given pattern

deploy.yaml

@@ -0,0 +1,82 @@
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: kube-node-metrics
+  namespace: default
+
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: kube-node-metrics
+rules:
+- apiGroups: [""]
+  resources: ["nodes"]
+  verbs: ["list", "watch"]
+- apiGroups: [""]
+  resources: ["pods"]
+  verbs: ["list", "watch"]
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: kube-node-metrics
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: kube-node-metrics
+subjects:
+- kind: ServiceAccount
+  name: kube-node-metrics
+  namespace: default
+
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: kube-node-metrics
+  namespace: default
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: kube-node-metrics
+  template:
+    metadata:
+      labels:
+        app: kube-node-metrics
+    spec:
+      serviceAccountName: kube-node-metrics
+      containers:
+      - name: kubep-node-metrics
+        image: docker.io/xiaozongyang/kube-node-metrics:latest
+        env:
+          - name: FULL_SYNC_INTERVAL
+            value: "2m"
+        ports:
+        - containerPort: 19191
+          name: metrics
+        resources:
+          limits:
+            memory: "2Gi"
+            cpu: "2000m"
+          requests:
+            memory: "64Mi"
+            cpu: "50m"
+      tolerations:
+      - operator: Exists
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: kube-node-metrics
+  namespace: default
+  labels:
+    app: kube-node-metrics
+spec:
+  selector:
+    app: kube-node-metrics
+  ports:
+  - port: 19191
+    targetPort: 19191
+    name: metrics