ecctl platform allocator vacate
Elastic Cloud Enterprise is a self-managed orchestration platform for deploying and managing the Elastic Stack at scale. Availability This functionality is generally available and ready for production usage. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
ECE
Generally available
Moves all the resources from the specified allocator.
ecctl platform allocator vacate <allocator-id> [flags]
ecctl platform allocator vacate i-05e245252362f7f1d
# Move everything from multiple allocators
ecctl platform allocator vacate i-05e245252362f7f1d i-2362f7f1d252362f7
# filter by a resource kind
ecctl platform allocator vacate -k kibana i-05e245252362f7f1d
# Only move specific resource IDs
ecctl platform allocator vacate -r f521dedb07194c478fbbc6624f3bbf8f -r f404eea372cc4ea5bd553d47a09705cd i-05e245252362f7f1d
# Specify multiple allocator targets
ecctl platform allocator vacate -t i-05e245252362f7f2d -t i-2362f7f1d252362f7 i-05e245252362f7f1d
ecctl platform allocator vacate --target i-05e245252362f7f2d --target i-2362f7f1d252362f7 --kind kibana i-05e245252362f7f1d
# Set the allocators to maintenance mode before vacating them
ecctl platform allocator vacate --maintenance -t i-05e245252362f7f2d -t i-2362f7f1d252362f7 i-05e245252362f7f1d
# Set the amount of maximum moves to happen at any time
ecctl platform allocator vacate --concurrency 10 i-05e245252362f7f1d
# Override the allocator health auto discovery
ecctl platform allocator vacate --allocator-down=true i-05e245252362f7f1d
# Override the skip_snapshot setting
ecctl platform allocator vacate --skip-snapshot=true i-05e245252362f7f1d -r f521dedb07194c478fbbc6624f3bbf8f
# Override the skip_data_migration setting
ecctl platform allocator vacate --skip-data-migration=true i-05e245252362f7f1d -r f521dedb07194c478fbbc6624f3bbf8f
# Skips tracking the vacate progress which will cause the command to return almost immediately.
# Not recommended since it can lead to failed vacates without the operator knowing about them.
ecctl platform allocator vacate --skip-tracking i-05e245252362f7f1d
--allocator-down string Disables the allocator health auto-discovery, setting the allocator-down to either [true|false]
--concurrency uint Maximum number of concurrent moves to perform at any time (default 8)
-h, --help help for vacate
-k, --kind string Kind of workload to vacate (elasticsearch|kibana|apm|appsearch|enterprise_search)
-m, --maintenance Whether to set the allocator(s) in maintenance before performing the vacate
--max-poll-retries int Optional maximum plan tracking retries (default 2)
--move-only Keeps the resource in its current -possibly broken- state and just does the bare minimum to move the requested instances across to another allocator. [true|false] (default true)
--override-failsafe If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints. [true|false]
--poll-frequency duration Optional polling frequency to check for plan change updates (default 10s)
-r, --resource-id strings Resource IDs to include in the vacate
--skip-data-migration string Skips the data-migration operation on the specified resource IDs. ONLY available when the resource IDs are specified and --move-only is true. [true|false]
--skip-snapshot string Skips the snapshot operation on the specified resource IDs. ONLY available when the resource IDs are specified. [true|false]
--skip-tracking Skips tracking the vacate progress causing the command to return after the move operation has been executed. Not recommended.
-t, --target strings Target allocator(s) on which to place the vacated workload
--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 Elastic Cloud Hosted 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
- ecctl platform allocator - Manages allocators