使用 InfluxDB 模板
使用 influx
命令行界面 (CLI) 来总结、验证和应用来自本地文件系统和 URL 的模板。
使用 InfluxDB 社区模板
InfluxDB 社区模板仓库 汇集了 InfluxData 社区中其他人开发和维护的越来越多的 InfluxDB 模板。使用模板的下载 URL 从 GitHub 直接应用社区模板,或下载模板。
社区模板位于以下根 URL 下
https://raw.githubusercontent.com/influxdata/community-templates/master/
例如,要访问 Docker 社区模板,请使用以下 URL
https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml
查看模板摘要
要在应用模板之前查看模板中包含内容的摘要,请使用 influx template
命令。查看存储在本地文件系统或来自 URL 的模板的摘要。
# Syntax
influx template -f <FILE_PATH>
# Example
influx template -org ORG_NAME -f /path/to/templates/TEMPLATE_FILE.yml
# Syntax
influx template -org <ORG_NAME> -u <FILE_URL>
# Example
influx template -u https://raw.githubusercontent.com/influxdata/community-templates/master/linux_system/linux_system.yml
验证模板
要在安装模板之前验证模板或对模板进行故障排除,请使用 influx template validate
命令。验证存储在本地文件系统或来自 URL 的模板。
# Syntax
influx template validate -org <ORG_NAME> -f <FILE_PATH>
# Example
influx template validate -org ORG_NAME -f /path/to/templates/TEMPLATE_FILE.yml
# Syntax
influx template validate -u <FILE_URL>
# Example
influx template validate -u https://raw.githubusercontent.com/influxdata/community-templates/master/linux_system/linux_system.yml
应用模板
使用 influx apply
命令 从本地文件系统或 URL 安装模板。默认输出是以“pretty”格式显示的模板摘要,以及确认应用更改的提示。
# Syntax
influx apply \
-o <INFLUX_ORG> \
-f <FILE_PATH> \
-u <URL> \
--secret=<SECRET_KEY>=<SECRET_VALUE>
将模板应用于现有堆栈
要将模板应用于现有堆栈,请在应用模板时包含堆栈 ID。任何时候在没有堆栈 ID 的情况下应用模板,InfluxDB 都会初始化一个新的堆栈和所有新资源。有关更多信息,请参阅 InfluxDB 堆栈。
您可以从 influx stacks
的输出中提取堆栈 ID,并将其传递给 influx apply
# Extract stack ID by name and apply a template to that stack
influx stacks | grep STACK_NAME | awk '{print $1}' | xargs -I{} influx apply -o ORG_NAME -f /path/to/TEMPLATE_FILE.yml --stack-id {}
从文件应用模板
要安装存储在本地计算机上的模板,请使用 -f
或 --file
标志来提供模板清单的文件路径。
# Example
# Apply multiple templates
influx apply -o ORG_NAME \
-f /path/to/templates/TEMPLATE_FILE_1.yml \
-f /path/to/templates/TEMPLATE_FILE_2.yml
要跳过确认并以非交互方式应用模板,请传递 --force yes
# Download templates for tests
curl https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml \
-so /path/to/templates/TEMPLATE_FILE_1.yml &&
curl https://raw.githubusercontent.com/influxdata/community-templates/master/github/github.yml \
-so /path/to/templates/TEMPLATE_FILE_2.yml &&
influx apply -o ORG_NAME \
-f /path/to/templates/TEMPLATE_FILE_1.yml \
-f /path/to/templates/TEMPLATE_FILE_2.yml \
--force yes
应用目录中的所有模板
要应用目录中的所有模板,请使用 -f
或 --file
标志来提供存储模板清单的目录的目录路径。默认情况下,这仅应用存储在指定目录中的模板。要应用存储在指定目录及其子目录中的所有模板,请包含 -R
、--recurse
标志。
# Examples
# Apply all templates in a directory
influx apply -o ORG_NAME -f /path/to/templates/
# Apply all templates in a directory and its subdirectories
influx apply -o ORG_NAME -f /path/to/templates/ --recurse
从 URL 应用模板
要从 URL 应用模板,请使用 -u
或 --template-url
标志来提供模板清单的 URL。
# Example
# Apply multiple templates from URLs
influx apply -o ORG_NAME \
-u https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml \
-u https://raw.githubusercontent.com/influxdata/community-templates/master/github/github.yml
从文件和 URL 应用模板
要在单个命令中从文件和 URL 应用模板,请包含多个文件或目录路径和 URL,每个都带有适当的 -f
或 -u
标志。
# Example
influx apply -o ORG_NAME \
-u https://raw.githubusercontent.com/influxdata/community-templates/master/raspberry-pi/raspberry-pi-system.yml \
-u https://raw.githubusercontent.com/influxdata/community-templates/master/minio/minio.yml \
-f /path/to/templates/TEMPLATE_FILE_1.yml \
-f /path/to/templates/TEMPLATE_FILE_2.yml \
--recurse
定义环境变量引用
某些模板包含 环境变量引用,允许您提供自定义资源名称。influx apply
命令会提示您为模板中的每个环境变量引用提供一个值。您还可以通过包含带有键值对的 --env-ref
标志来提供环境变量引用的值,该键值对由环境变量引用键和要替换的值组成。
# Example
influx apply -o ORG_NAME -f /path/to/templates/TEMPLATE_FILE.yml \
--env-ref=bucket-name-1=myBucket \
--env-ref=label-name-1=Label1 \
--env-ref=label-name-2=Label2
在安装模板时包含密钥
某些模板在查询中使用 密钥。密钥值不包含在模板中。要在安装模板时定义密钥值,请包含带有密钥键值对的 --secret
标志。
# Examples
# Define a single secret when applying a template
influx apply -o ORG_NAME -f /path/to/templates/TEMPLATE_FILE.yml \
--secret=FOO=BAR
# Define multiple secrets when applying a template
influx apply -o ORG_NAME -f /path/to/templates/TEMPLATE_FILE.yml \
--secret=FOO=bar \
--secret=BAZ=quz
要在应用模板后添加密钥,请参阅 添加密钥。
此页内容是否对您有帮助?
感谢您的反馈!
支持和反馈
感谢您成为我们社区的一份子!我们欢迎并鼓励您提供关于 InfluxDB 和本文档的反馈和错误报告。要寻求支持,请使用以下资源
拥有年度合同或支持合同的客户可以联系 InfluxData 支持。