You need to enable JavaScript to run this app.
导航

脚本使用指南

最近更新时间2023.12.25 10:37:58

首次发布时间2023.02.28 17:57:43

部署脚本用于在自建 Kubernetes 集群中部署采集器、Grafana 和 kube-state-metrics 组件,本文为您介绍部署脚本的基本使用方法。

基本使用方法

获取部署脚本后,您可以遵循以下格式,使用脚本。

./install.sh ${command} ${flag}

例如,您可以使用如下命令,安装 VM Agent 采集器和对应的 Exporter。

./install.sh --agent vmagent --region cn-beijing --remote-write-url http://write.prometheus-cn-beijing.ivolces.com/workspaces/b762e1a3-37***/api/v1/write --basic-auth-username username-demo --basic-auth-password password-demo

为了方便查看,您也可以使用如下格式。

./install.sh \
--agent vmagent \
--region cn-beijing \
--remote-write-url http://write.prometheus-cn-beijing.ivolces.com/workspaces/b762e1a3-37***/api/v1/write  \
--basic-auth-username username-demo \
--basic-auth-password password-demo

其中,${command} 字段包括如下几个命令。

命令说明

install

部署采集器和对应的 exporter。当您部署的采集器为 VM Agent 时,也会同步部署 vm-operator。

说明

install 为默认值,当您未输入 ${command} 字段时,默认执行 install 命令。

uninstall卸载采集器和对应的 exporter。
uninstall-operator卸载 vm-operator。
scaleVM Agent 采集器和 kube-state-metrics 组件扩容。
install-grafana部署 Grafana。
uninstall-grafana卸载 Grafana。
fetchall下载所有资源的原生 Kubernetes 资源配置清单,您可以手工修改其中的配置,再进行部署。
clear删除所有下载在本地的原生 Kubernetes 清单。

下载资源配置清单

您可以使用 fetchall 命令,下载所有资源的原生 Kubernetes 资源配置清单。

./install.sh fetchall \
--exec-script-env local \ # (可选)脚本执行环境。local:本地环境;public-cloud-vpc:VPC 环境。
--region cn-beijing # 部署组件的集群地域。

清理资源配置清单

您可以使用 clear 命令,清理保存在本地的资源配置清单。

./install.sh clear

使用帮助

您可以通过安装脚本的 --help 参数,查看脚本中所有的预定义字段和含义。

./install.sh --help