- Elastic Cloud Control - The Command-Line Interface for Elasticsearch Service and ECE:
- Overview
- Installing
- Configuring
- Usage examples
- Command reference
- ecctl
- ecctl auth
- ecctl auth key
- ecctl auth key create
- ecctl auth key delete
- ecctl auth key list
- ecctl auth key show
- ecctl comment
- ecctl comment create
- ecctl comment delete
- ecctl comment list
- ecctl comment show
- ecctl comment update
- ecctl deployment
- ecctl deployment create
- ecctl deployment delete
- ecctl deployment elasticsearch
- ecctl deployment elasticsearch keystore
- ecctl deployment elasticsearch keystore show
- ecctl deployment elasticsearch keystore update
- ecctl deployment extension
- ecctl deployment extension create
- ecctl deployment extension delete
- ecctl deployment extension list
- ecctl deployment extension show
- ecctl deployment extension update
- ecctl deployment list
- ecctl deployment plan
- ecctl deployment plan cancel
- ecctl deployment resource
- ecctl deployment resource delete
- ecctl deployment resource restore
- ecctl deployment resource shutdown
- ecctl deployment resource start-maintenance
- ecctl deployment resource start
- ecctl deployment resource stop-maintenance
- ecctl deployment resource stop
- ecctl deployment resource upgrade
- ecctl deployment restore
- ecctl deployment resync
- ecctl deployment search
- ecctl deployment show
- ecctl deployment shutdown
- ecctl deployment template
- ecctl deployment template create
- ecctl deployment template delete
- ecctl deployment template list
- ecctl deployment template show
- ecctl deployment template update
- ecctl deployment traffic-filter
- ecctl deployment traffic-filter association
- ecctl deployment traffic-filter association create
- ecctl deployment traffic-filter association delete
- ecctl deployment traffic-filter create
- ecctl deployment traffic-filter delete
- ecctl deployment traffic-filter list
- ecctl deployment traffic-filter show
- ecctl deployment traffic-filter update
- ecctl deployment update
- ecctl generate
- ecctl generate completions
- ecctl generate docs
- ecctl init
- ecctl platform
- ecctl platform allocator
- ecctl platform allocator list
- ecctl platform allocator maintenance
- ecctl platform allocator metadata
- ecctl platform allocator metadata delete
- ecctl platform allocator metadata set
- ecctl platform allocator metadata show
- ecctl platform allocator search
- ecctl platform allocator show
- ecctl platform allocator vacate
- ecctl platform constructor
- ecctl platform constructor list
- ecctl platform constructor maintenance
- ecctl platform constructor resync
- ecctl platform constructor show
- ecctl platform enrollment-token
- ecctl platform enrollment-token create
- ecctl platform enrollment-token delete
- ecctl platform enrollment-token list
- ecctl platform info
- ecctl platform instance-configuration
- ecctl platform instance-configuration create
- ecctl platform instance-configuration delete
- ecctl platform instance-configuration list
- ecctl platform instance-configuration pull
- ecctl platform instance-configuration show
- ecctl platform instance-configuration update
- ecctl platform proxy
- ecctl platform proxy filtered-group
- ecctl platform proxy filtered-group create
- ecctl platform proxy filtered-group delete
- ecctl platform proxy filtered-group list
- ecctl platform proxy filtered-group show
- ecctl platform proxy filtered-group update
- ecctl platform proxy list
- ecctl platform proxy settings
- ecctl platform proxy settings show
- ecctl platform proxy settings update
- ecctl platform proxy show
- ecctl platform repository
- ecctl platform repository create
- ecctl platform repository delete
- ecctl platform repository list
- ecctl platform repository show
- ecctl platform role
- ecctl platform role create
- ecctl platform role delete
- ecctl platform role list
- ecctl platform role show
- ecctl platform role update
- ecctl platform runner
- ecctl platform runner list
- ecctl platform runner resync
- ecctl platform runner search
- ecctl platform runner show
- ecctl stack
- ecctl stack delete
- ecctl stack list
- ecctl stack show
- ecctl stack upload
- ecctl user
- ecctl user create
- ecctl user delete
- ecctl user disable
- ecctl user enable
- ecctl user key
- ecctl user key delete
- ecctl user key list
- ecctl user key show
- ecctl user list
- ecctl user show
- ecctl user update
- ecctl version
- Contributing
- Release notes
ecctl deployment update
editecctl deployment update
editUpdates a deployment from a file definition, allowing certain flag overrides
Synopsis
editupdates a deployment from a file definition: Defaulting prune_orphans=false, making the default update action safe for partial updates. To override this behavior, toggle --prune-orphans. To track the changes toggle the --track flag.
It is possible to use "--generate-update-payload" as: "ecctl deployment show --generate-update-payload …" to obtain a valid update payload from an existing deployment which can be manually edited in before it is sent as a "--file" flag argument. See "ecctl deployment show --help" for a valid example.
Read more about the deployment definition in https://www.elastic.co/guide/en/cloud-enterprise/current/Deployment_-_CRUD.html
ecctl deployment update -f <file definition.json> [flags]
Examples
edit#### Same base deployment as the create example, changing cluster_topology[0].zone_count to 3. $ cat deployment_example_update.json { "resources": { "elasticsearch": [ { "display_name": "my elasticsearch cluster", "ref_id": "my-es-cluster", "plan": { "deployment_template": { "id": "default" }, "elasticsearch": { "version": "6.8.4" }, "cluster_topology": [ { "instance_configuration_id": "data.default", "memory_per_node": 1024, "node_count_per_zone": 1, "node_type": { "data": true, "ingest": true, "master": true, "ml": false }, "zone_count": 3 } ] } } ] } } $ ecctl deployment update f44c06c3af6f85dac05023cf243f4ab1 -f deployment_example_update.json ... #### Setting --prune-orphans, will cause any non-specified resources to be shut down. $ ecctl deployment update f44c06c3af6f85dac05023cf243f4ab1 -f deployment_example_update.json --prune-orphans setting --prune-orphans to "true" will cause any resources not specified in the update request to be removed from the deployment, do you want to continue? [y/n]: y ...
Options
edit-f, --file string Partial (default) or full JSON file deployment update payload -h, --help help for update --hide-pruned-orphans Hides orphaned resources that were shut down (only relevant if --prune-orphans=true) --prune-orphans When set to true, it will remove any resources not specified in the update request, treating the json file contents as the authoritative deployment definition --skip-snapshot Skips taking an Elasticsearch snapshot prior to shutting down the deployment -t, --track Tracks the progress of the performed task
Options inherited from parent commands
edit--api-key string API key to use to authenticate (If empty will look for EC_API_KEY environment variable) --config string Config name, used to have multiple configs in $HOME/.ecctl/<env> (default "config") --force Do not ask for confirmation --format string Formats the output using a Go template --host string Base URL to use --insecure Skips all TLS validation --message string A message to set on cluster operation --output string Output format [text|json] (default "text") --pass string Password to use to authenticate (If empty will look for EC_PASS environment variable) --pprof Enables pprofing and saves the profile to pprof-20060102150405 -q, --quiet Suppresses the configuration file used for the run, if any --region string Elasticsearch Service region --timeout duration Timeout to use on all HTTP calls (default 30s) --trace Enables tracing saves the trace to trace-20060102150405 --user string Username to use to authenticate (If empty will look for EC_USER environment variable) --verbose Enable verbose mode --verbose-credentials When set, Authorization headers on the request/response trail will be displayed as plain text --verbose-file string When set, the verbose request/response trail will be written to the defined file
SEE ALSO
edit- ecctl deployment - Manages deployments
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now