ADD README-zh.md

Author: xiaozongyang

README-zh.md

@@ -0,0 +1,43 @@
+# Kube Node Metrics
+[English Version](README.md)
+
+本项目灵感来源于 [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>
+```
+
+## 运维
+1. 支持暴露指定前缀的 k8s 节点标签

README.md

@@ -1,4 +1,5 @@
 # Kube Node Metrics
+[中文版](README-zh.md)
 
 This project is inspired by [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics) and [kubectl](https://github.com/kubernetes/kubectl).
 
@@ -16,6 +17,8 @@ These samples values should be equal to the result of `kubectl describe node <no
 
 ### 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
@@ -26,7 +29,8 @@ kubectl apply -f deploy.yaml
 kubectl apply -f deploy.yaml
 ```
 
-### build manually
+## Build
+### build binary manually
 ```bash
 go build .
 ```
@@ -36,6 +40,9 @@ go build .
 docker build . -t <image>:<tag>
 ```
 
-# TODO
-1. support custom k8s api server address
+## 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