Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update helm & README #40

Merged
merged 1 commit into from
Feb 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PROJECT="nebula-exporter"

GO ?= go
VERSION ?= v0.0.5
VERSION ?= v0.0.6
DockerUser=vesoft

ifeq (,$(shell go env GOBIN))
Expand Down
13 changes: 3 additions & 10 deletions README-CN.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://github.com/vesoft-inc/nebula/raw/master/docs/logo.png"/>
<img src="https://nebula-website-cn.oss-cn-hangzhou.aliyuncs.com/nebula-website/images/nebulagraph-logo.png"/>
<br> <a href="README.md">English</a> | <a href="README-CN.md">中文</a>
<br>A distributed, scalable, lightning-fast graph database<br>
</p>
Expand Down Expand Up @@ -47,13 +47,6 @@ clusters: # 您想要监控的 cluster 列表
endpointPort: 19559 # instance 的端口
componentType: metad # instance 的组建类型, optional value metad, graphd and storaged.
- ...
# 废弃: 使用 clusters 来替换
nebulaItems: # 类似 clusters/instances, 默认的 cluster 名称为 '_nebula'
- instanceName: metad0 # 类似 clusters/instances/name
endpointIP: 192.168.10.131 # 类似 clusters/instances/endpointIP
endpointPort: 19559 # 类似 clusters/instances/endpointPort
componentType: metad # 类似 clusters/instances/componentType
- ...
```

_详情请见 [config.yaml](deploy/bare-metal/config.yaml) 。_
Expand All @@ -76,12 +69,12 @@ scrape_configs:
```shell
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
-v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
vesoft/nebula-stats-exporter:v0.0.5 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml

# 例如:
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
-v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
vesoft/nebula-stats-exporter:v0.0.5 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
```

## 在裸机上运行
Expand Down
13 changes: 3 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://github.com/vesoft-inc/nebula/raw/master/docs/logo.png"/>
<img src="https://nebula-website-cn.oss-cn-hangzhou.aliyuncs.com/nebula-website/images/nebulagraph-logo.png"/>
<br> <a href="README.md">English</a> | <a href="README-CN.md">中文</a>
<br>A distributed, scalable, lightning-fast graph database<br>
</p>
Expand Down Expand Up @@ -47,13 +47,6 @@ clusters: # a list of clusters you want to mon
endpointPort: 19559 # the port of this instance
componentType: metad # the component type of this instance, optional value metad, graphd and storaged.
- ...
# Deprecated: use clusters instead.
nebulaItems: # same as clusters/instances, the default cluster name is '_nebula'
- instanceName: metad0 # same as clusters/instances/name
endpointIP: 192.168.10.131 # same as clusters/instances/endpointIP
endpointPort: 19559 # same as clusters/instances/endpointPort
componentType: metad # same as clusters/instances/componentType
- ...
```

_See [config.yaml](deploy/bare-metal/config.yaml) for details._
Expand All @@ -76,12 +69,12 @@ And adjust the host name `NEBULA_STATS_EXPORTER_HOSTNAME` accordingly.
```shell
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
-v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
vesoft/nebula-stats-exporter:v0.0.5 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml

# For example:
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
-v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
vesoft/nebula-stats-exporter:v0.0.5 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
```

## Run on Bare Metal
Expand Down
14 changes: 7 additions & 7 deletions charts/index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ apiVersion: v1
entries:
nebula-exporter:
- apiVersion: v1
appVersion: v2.5.0
created: "2021-08-16T11:54:34.149524302+08:00"
appVersion: v3.0.0
created: "2022-02-14T12:07:04.219772+08:00"
description: Nebula Graph stats exporter for prometheus
digest: 8b02d03f03d5d0ee7fbb2dc6fdb92ad5878409f07d928a2d778413dfd7a0b8de
digest: b5026b4e12b325e54bac8c8538bb1d21793df3f4a5d7878b312f5f43c12ec6e3
home: https://nebula-graph.io
icon: https://github.com/vesoft-inc/nebula/raw/master/docs/logo.png
icon: https://nebula-website-cn.oss-cn-hangzhou.aliyuncs.com/nebula-website/images/nebulagraph-logo.png
keywords:
- kubernetes
- exporter
Expand All @@ -28,6 +28,6 @@ entries:
sources:
- https://github.com/vesoft-inc/nebula
urls:
- https://vesoft-inc.github.io/nebula-stats-exporter/charts/nebula-exporter-v0.0.5.tgz
version: v0.0.5
generated: "2021-08-16T11:54:34.14868979+08:00"
- https://vesoft-inc.github.io/nebula-stats-exporter/charts/nebula-exporter-0.0.6.tgz
version: 0.0.6
generated: "2022-02-14T12:07:04.219113+08:00"
Binary file added charts/nebula-exporter-0.0.6.tgz
Binary file not shown.
Binary file removed charts/nebula-exporter-v0.0.5.tgz
Binary file not shown.
6 changes: 3 additions & 3 deletions charts/nebula-exporter/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
apiVersion: v1
appVersion: v2.0.0
appVersion: v3.0.0
description: Nebula Graph stats exporter for prometheus
home: https://nebula-graph.io
icon: https://github.com/vesoft-inc/nebula/raw/master/docs/logo.png
icon: https://nebula-website-cn.oss-cn-hangzhou.aliyuncs.com/nebula-website/images/nebulagraph-logo.png
keywords:
- kubernetes
- exporter
Expand All @@ -22,4 +22,4 @@ maintainers:
name: nebula-exporter
sources:
- https://github.com/vesoft-inc/nebula
version: 0.2.0
version: 0.0.6
2 changes: 1 addition & 1 deletion charts/nebula-exporter/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ startUp:

image:
repository: vesoft/nebula-stats-exporter
tag: v0.0.5
tag: v0.0.6
pullPolicy: IfNotPresent

serviceAccount:
Expand Down
7 changes: 0 additions & 7 deletions deploy/bare-metal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,6 @@ clusters: # a list of clusters you want to mon
endpointPort: 19559 # the port of this instance
componentType: metad # the component type of this instance, optional value metad, graphd and storaged.
- ...
# Deprecated: use clusters instead.
nebulaItems: # same as clusters/instances, the default cluster name is '_nebula'
- instanceName: metad0 # same as clusters/instances/name
endpointIP: 192.168.10.131 # same as clusters/instances/endpointIP
endpointPort: 19559 # same as clusters/instances/endpointPort
componentType: metad # same as clusters/instances/componentType
- ...
```

_See [config.yaml](config.yaml) for details._
Expand Down
34 changes: 2 additions & 32 deletions deploy/bare-metal/config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: v0.0.4
version: v0.0.6
clusters:
- name: nebula
instances:
Expand Down Expand Up @@ -29,34 +29,4 @@ clusters:
- name: storaged2
endpointIP: 192.168.10.133
endpointPort: 19779
componentType: storaged
# Deprecated: use clusters instead.
nebulaItems:
- instanceName: metad0
endpointIP: 192.168.10.131
endpointPort: 19559
componentType: metad
- instanceName: metad1
endpointIP: 192.168.10.132
endpointPort: 19559
componentType: metad
- instanceName: metad2
endpointIP: 192.168.10.133
endpointPort: 19559
componentType: metad
- instanceName: graphd0
endpointIP: 192.168.10.131
endpointPort: 19669
componentType: graphd
- instanceName: storaged0
endpointIP: 192.168.10.131
endpointPort: 19779
componentType: storaged
- instanceName: storaged1
endpointIP: 192.168.10.132
endpointPort: 19779
componentType: storaged
- instanceName: storaged2
endpointIP: 192.168.10.133
endpointPort: 19779
componentType: storaged
componentType: storaged
4 changes: 2 additions & 2 deletions deploy/bare-metal/example-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
```shell
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
-v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
vesoft/nebula-stats-exporter:v0.0.5 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml

# 例如:
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
-v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
vesoft/nebula-stats-exporter:v0.0.5 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
```

## 安装 prometheus
Expand Down
4 changes: 2 additions & 2 deletions deploy/bare-metal/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
```shell
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
-v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
vesoft/nebula-stats-exporter:v0.0.5 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml

# For example:
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
-v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
vesoft/nebula-stats-exporter:v0.0.5 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
```

## Install prometheus
Expand Down
6 changes: 3 additions & 3 deletions deploy/kubernetes/README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ _访问 [helm repo](https://helm.sh/docs/helm/helm_repo/) 来查看命令文档

```shell
export NEBULA_EXPORTER_NAMESPACE=nebula # 您想要安装 nebula exporter 的 namespace
export CHART_VERSION=v0.2.0 # Nebula Exporter 的 chart 版本
export CHART_VERSION=v0.0.6 # Nebula Exporter 的 chart 版本

$ kubectl create namespace "${NEBULA_EXPORTER_NAMESPACE}" # 如果您已经创建了,请跳过
$ helm install nebula-exporter nebula-exporter/nebula-exporter \
Expand All @@ -35,7 +35,7 @@ nebula-exporter-5964b765c9-4xfkm 1/1 Running 0 44s

注意:

* `${chart_version}` 表示 Nebula Exporter chart 的版本。 例如,v0.2.0 。 您可以通过运行 `helm search repo -l nebula-exporter` 命令来查看当前支持的版本。
* `${chart_version}` 表示 Nebula Exporter chart 的版本。 例如,v0.0.6 。 您可以通过运行 `helm search repo -l nebula-exporter` 命令来查看当前支持的版本。

_访问 [helm install](https://helm.sh/docs/helm/helm_install/) 来查看命令文档。_

Expand Down Expand Up @@ -85,7 +85,7 @@ $ helm show values nebula-exporter/nebula-exporter
| `startUp.listenPort` | Nebula metrics 服务监听端口 | `9100` |
| `startUp.maxRequests` | 最大并行抓取请求数,使用 0 则不限制 | `40` |
| `image.repository` | Nebula stats exporter image repository | `vesoft/nebula-stats-exporter` |
| `image.tag` | Nebula stats exporter image tag | `v0.0.5` |
| `image.tag` | Nebula stats exporter image tag | `v0.0.6` |
| `image.pullPolicy` | Nebula stats exporter imagePullPolicy | `IfNotPresent` |
| `serviceAccount.create` | 指定是否应创建 service account | `true` |
| `serviceAccount.annotations` | 添加到 service account 的 annotations | `{}` |
Expand Down
6 changes: 3 additions & 3 deletions deploy/kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ _See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation

```shell
export NEBULA_EXPORTER_NAMESPACE=nebula # the namespace you want to install the nebula exporter
export CHART_VERSION=v0.2.0 # the chart version of Nebula Exporter
export CHART_VERSION=v0.0.6 # the chart version of Nebula Exporter

$ kubectl create namespace "${NEBULA_EXPORTER_NAMESPACE}" # If you have already created it, please skip.
$ helm install nebula-exporter nebula-exporter/nebula-exporter \
Expand All @@ -35,7 +35,7 @@ nebula-exporter-5964b765c9-4xfkm 1/1 Running 0 44s

Notes:

* `${chart_version}` represents the chart version of Nebula Exporter. For example, v0.2.0. You can view the currently supported versions by running the `helm search repo -l nebula-exporter` command.
* `${chart_version}` represents the chart version of Nebula Exporter. For example, v0.0.6. You can view the currently supported versions by running the `helm search repo -l nebula-exporter` command.

_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._

Expand Down Expand Up @@ -85,7 +85,7 @@ The following table lists is the configurable parameters of the chart and their
| `startUp.listenPort` | The nebula metrics server listening port | `9100` |
| `startUp.maxRequests` | Maximum number of parallel scrape requests, use 0 for no limit | `40` |
| `image.repository` | Nebula stats exporter image repository | `vesoft/nebula-stats-exporter` |
| `image.tag` | Nebula stats exporter image tag | `v0.0.5` |
| `image.tag` | Nebula stats exporter image tag | `v0.0.6` |
| `image.pullPolicy` | Nebula stats exporter imagePullPolicy | `IfNotPresent` |
| `serviceAccount.create` | Specifies whether a service account should be created | `true` |
| `serviceAccount.annotations` | Annotations to add to the service account | `{}` |
Expand Down
4 changes: 2 additions & 2 deletions deploy/kubernetes/example-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ _详情请见 [Install Nebula Cluster with helm](https://github.com/vesoft-inc/n

```shell
$ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
--namespace=example1 --version=v0.2.0 \
--namespace=example1 --version=v0.0.6 \
--set serviceMonitor.enabled=true \
--set serviceMonitor.prometheusServiceMatchLabels.release=prometheus

$ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
--namespace=example2 --version=v0.2.0 \
--namespace=example2 --version=v0.0.6 \
--set serviceMonitor.enabled=true \
--set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
```
Expand Down
4 changes: 2 additions & 2 deletions deploy/kubernetes/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ _See [Install Nebula Cluster with helm](https://github.com/vesoft-inc/nebula-ope

```shell
$ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
--namespace=example1 --version=v0.2.0 \
--namespace=example1 --version=v0.0.6 \
--set serviceMonitor.enabled=true \
--set serviceMonitor.prometheusServiceMatchLabels.release=prometheus

$ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
--namespace=example2 --version=v0.2.0 \
--namespace=example2 --version=v0.0.6 \
--set serviceMonitor.enabled=true \
--set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
```
Expand Down