influx stacks update
- influx CLI 2.0.1+
- InfluxDB 2.0.1+
- Updated in CLI v2.0.4
This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.
The influx stacks update
command updates an InfluxDB stack.
Usage
influx stacks update [flags]
Flags
Flag | Description | Input type | Maps to ? | |
---|---|---|---|---|
—addResource | Associate an existing resource with a stack | string | ||
-c | —active-config | CLI configuration to use for command | string | |
—configs-path | Path to influx CLI configurations (default ~/.influxdbv2/configs ) | string | INFLUX_CONFIGS_PATH | |
-f | —export-file | Destination for exported template | string | |
-h | —help | Help for the update command | ||
—hide-headers | Hide table headers (default false ) | INFLUX_HIDE_HEADERS | ||
—host | HTTP address of InfluxDB (default http://localhost:8086 ) | string | INFLUX_HOST | |
—http-debug | Inspect communication with InfluxDB servers. | string | ||
-i | —stack-id | The stack ID to update | string | |
—json | Output data as JSON (default false ) | INFLUX_OUTPUT_JSON | ||
—skip-verify | Skip TLS certificate verification | INFLUX_SKIP_VERIFY | ||
-d | —stack-description | Stack description | string | |
-n | —stack-name | Stack name | string | |
-u | —template-url | Template URLs to associate with a stack | list of strings | |
-t | —token | API token | string | INFLUX_TOKEN |
Export an updated template
To prevent accidental changes, we strongly recommend exporting a new template any time you add additional resources to a stack using the --addResource
flag with the influx stack update
command. The updated stack will differ from the previous template. If you apply the outdated template, InfluxDB will revert the updates and remove the added resources.
Examples
Authentication credentials
The examples below assume your InfluxDB host, organization, and token are provided by either the active influx CLI configuration or by environment variables (INFLUX_HOST
, INFLUX_ORG
, and INFLUX_TOKEN
). If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:
--host
: InfluxDB host-o, --org
or--org-id
: InfluxDB organization name or ID-t, --token
: InfluxDB API token- Update a stack with a name and urls to associate with stack
- Update a stack with new resources to manage
- Update a stack with new resources and export the stack as a template
Update a stack with a name and description
influx stack update \
-i ab12cd34ef56 \
-n "New stack name" \
-d "New stack description"
Update a stack with a name and URLs to associate with stack
influx stack update \
-i ab12cd34ef56 \
-n "New stack name" \
--template-url https://example.com/template-1.yml \
--template-url https://example.com/template-2.yml
Update a stack with new resources to manage
influx stacks update \
--stack-id ab12cd34ef56 \
--addResource=Bucket=12ab34cd56ef \
--addResource=Dashboard=98zy76xw54vu
Update a stack with new resources and export the stack as a template
influx stacks update \
--stack-id ab12cd34ef56 \
--addResource=Bucket=12ab34cd56ef \
--export-file /path/to/template-file.yml
Related
- InfluxDB stacks
- influx CLI—Provide required authentication credentials
- influx CLI—Flag patterns and conventions