docs: Update asciidocs to reflect latest changes (#244)

Updates the .adoc files to reflect the recent changes in the markdown files

Author: karencfv

docs/ecctl-command-reference-index.adoc

@@ -6,20 +6,6 @@ include::ecctl_auth_key_delete.adoc[]
 include::ecctl_auth_key_list.adoc[]
 include::ecctl_auth_key_show.adoc[]
 include::ecctl_deployment.adoc[]
-include::ecctl_deployment_apm.adoc[]
-include::ecctl_deployment_apm_create.adoc[]
-include::ecctl_deployment_apm_delete.adoc[]
-include::ecctl_deployment_apm_list.adoc[]
-include::ecctl_deployment_apm_plan.adoc[]
-include::ecctl_deployment_apm_plan_cancel.adoc[]
-include::ecctl_deployment_apm_plan_history.adoc[]
-include::ecctl_deployment_apm_plan_monitor.adoc[]
-include::ecctl_deployment_apm_plan_reapply.adoc[]
-include::ecctl_deployment_apm_restart.adoc[]
-include::ecctl_deployment_apm_resync.adoc[]
-include::ecctl_deployment_apm_show.adoc[]
-include::ecctl_deployment_apm_stop.adoc[]
-include::ecctl_deployment_apm_upgrade.adoc[]
 include::ecctl_deployment_create.adoc[]
 include::ecctl_deployment_delete.adoc[]
 include::ecctl_deployment_elasticsearch.adoc[]
@@ -84,6 +70,7 @@ include::ecctl_deployment_resource_stop-maintenance.adoc[]
 include::ecctl_deployment_resource_stop.adoc[]
 include::ecctl_deployment_resource_upgrade.adoc[]
 include::ecctl_deployment_restore.adoc[]
+include::ecctl_deployment_resync.adoc[]
 include::ecctl_deployment_search.adoc[]
 include::ecctl_deployment_show.adoc[]
 include::ecctl_deployment_shutdown.adoc[]
@@ -106,6 +93,7 @@ include::ecctl_platform_allocator_vacate.adoc[]
 include::ecctl_platform_constructor.adoc[]
 include::ecctl_platform_constructor_list.adoc[]
 include::ecctl_platform_constructor_maintenance.adoc[]
+include::ecctl_platform_constructor_resync.adoc[]
 include::ecctl_platform_constructor_show.adoc[]
 include::ecctl_platform_deployment-template.adoc[]
 include::ecctl_platform_deployment-template_create.adoc[]
@@ -145,6 +133,11 @@ include::ecctl_platform_role_create.adoc[]
 include::ecctl_platform_role_delete.adoc[]
 include::ecctl_platform_role_list.adoc[]
 include::ecctl_platform_role_show.adoc[]
+include::ecctl_platform_runner.adoc[]
+include::ecctl_platform_runner_list.adoc[]
+include::ecctl_platform_runner_resync.adoc[]
+include::ecctl_platform_runner_search.adoc[]
+include::ecctl_platform_runner_show.adoc[]
 include::ecctl_platform_stack.adoc[]
 include::ecctl_platform_stack_delete.adoc[]
 include::ecctl_platform_stack_list.adoc[]

docs/ecctl.adoc

@@ -24,19 +24,20 @@ Elastic Cloud Control
       --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
 ----
 
 [float]
-=== See also
+=== SEE ALSO
 
 * xref:ecctl_auth[ecctl auth]	 - Manages the platform auth
 * xref:ecctl_deployment[ecctl deployment]	 - Manages deployments
 * xref:ecctl_generate[ecctl generate]	 - Generates completions and docs
 * xref:ecctl_init[ecctl init]	 - Creates an initial configuration file.
 * xref:ecctl_platform[ecctl platform]	 - Manages the platform
-* xref:ecctl_user[ecctl user]	 - Manages the platform users
+* xref:ecctl_user[ecctl user]	 - Manages the platform users (Available for ECE only)
 * xref:ecctl_version[ecctl version]	 - Shows ecctl version

docs/ecctl_auth.adoc

@@ -34,14 +34,15 @@ ecctl auth [flags]
       --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
 ----
 
 [float]
-=== See also
+=== SEE ALSO
 
 * xref:ecctl[ecctl]	 - Elastic Cloud Control
 * xref:ecctl_auth_key[ecctl auth key]	 - Manages the current authenticated user API keys

docs/ecctl_auth_key.adoc

@@ -34,14 +34,15 @@ ecctl auth key [flags]
       --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
 ----
 
 [float]
-=== See also
+=== SEE ALSO
 
 * xref:ecctl_auth[ecctl auth]	 - Manages the platform auth
 * xref:ecctl_auth_key_create[ecctl auth key create]	 - Creates a new API key for the current authenticated user

docs/ecctl_auth_key_create.adoc

@@ -36,13 +36,14 @@ ecctl auth key create [flags]
       --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
 ----
 
 [float]
-=== See also
+=== SEE ALSO
 
 * xref:ecctl_auth_key[ecctl auth key]	 - Manages the current authenticated user API keys

docs/ecctl_auth_key_delete.adoc

@@ -34,13 +34,14 @@ ecctl auth key delete <key id> <key id> ... [flags]
       --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
 ----
 
 [float]
-=== See also
+=== SEE ALSO
 
 * xref:ecctl_auth_key[ecctl auth key]	 - Manages the current authenticated user API keys

docs/ecctl_auth_key_list.adoc

@@ -34,13 +34,14 @@ ecctl auth key list [flags]
       --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
 ----
 
 [float]
-=== See also
+=== SEE ALSO
 
 * xref:ecctl_auth_key[ecctl auth key]	 - Manages the current authenticated user API keys

docs/ecctl_auth_key_show.adoc

@@ -34,13 +34,14 @@ ecctl auth key show <key id> [flags]
       --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
 ----
 
 [float]
-=== See also
+=== SEE ALSO
 
 * xref:ecctl_auth_key[ecctl auth key]	 - Manages the current authenticated user API keys

docs/ecctl_deployment.adoc

@@ -34,26 +34,27 @@ ecctl deployment [flags]
       --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
 ----
 
 [float]
-=== See also
+=== SEE ALSO
 
 * xref:ecctl[ecctl]	 - Elastic Cloud Control
-* xref:ecctl_deployment_apm[ecctl deployment apm]	 - Manages APM deployments
-* xref:ecctl_deployment_create[ecctl deployment create]	 - Creates a deployment from a file definition, allowing certain flag overrides
-* xref:ecctl_deployment_delete[ecctl deployment delete]	 - Deletes a previously stopped deployment from the platform
+* xref:ecctl_deployment_create[ecctl deployment create]	 - Creates a deployment
+* xref:ecctl_deployment_delete[ecctl deployment delete]	 - Deletes a previously shutdown deployment (Available for ECE only)
 * xref:ecctl_deployment_elasticsearch[ecctl deployment elasticsearch]	 - Manages Elasticsearch clusters
 * xref:ecctl_deployment_kibana[ecctl deployment kibana]	 - Manages Kibana instances
 * xref:ecctl_deployment_list[ecctl deployment list]	 - Lists the platform's deployments
 * xref:ecctl_deployment_note[ecctl deployment note]	 - Manages a deployment's notes
 * xref:ecctl_deployment_plan[ecctl deployment plan]	 - Manages deployment plans
 * xref:ecctl_deployment_resource[ecctl deployment resource]	 - Manages deployment resources
 * xref:ecctl_deployment_restore[ecctl deployment restore]	 - Restores a previously shut down deployment and all of its associated sub-resources
+* xref:ecctl_deployment_resync[ecctl deployment resync]	 - Resynchronizes the search index and cache for the selected deployment or all
 * xref:ecctl_deployment_search[ecctl deployment search]	 - Performs advanced deployment search using the Elasticsearch Query DSL
 * xref:ecctl_deployment_show[ecctl deployment show]	 - Shows the specified deployment resources
 * xref:ecctl_deployment_shutdown[ecctl deployment shutdown]	 - Shuts down a deployment and all of its associated sub-resources

docs/ecctl_deployment_create.adoc

@@ -1,122 +1,48 @@
 [#ecctl_deployment_create]
 == ecctl deployment create
 
-Creates a deployment from a file definition, allowing certain flag overrides
+Creates a deployment
 
 [float]
 === Synopsis
 
-Creates a deployment from a file definition with an automatically generated idempotency token.
-On creation failure, please use the displayed idempotency token to retry the cluster creation with --request-id=+++<token>+++. To track the creation of the resources toggle the --track flag.+++</token>+++
+Creates a deployment which is defined from a file definition using the --file=+++<file path="">+++(shorthand: -f) flag.+++</file>+++
 
-Read more about the deployment definition in https://www.elastic.co/guide/en/cloud-enterprise/current/Deployment_-_CRUD.html
+You can create a definition by using the sample JSON seen here:
+  https://elastic.co/guide/en/cloud/current/ec-api-deployment-crud.html#ec_create_a_deployment
 
 ----
-ecctl deployment create -f <file definition.json> [flags]
+ecctl deployment create {--file | --size <int> --zones <string> | --topology-element <obj>} [flags]
 ----
 
 [float]
 === Examples
 
-[source,console]
 ----
-$ cat deployment_example.json
-{
-    "name": "my example cluster",
-    "resources": {
-        "apm": [
-            {
-                "display_name": "my apm instance",
-                "ref_id": "my-apm-instance",
-                "elasticsearch_cluster_ref_id": "my-es-cluster",
-                "plan": {
-                    "apm": {
-                        "version": "6.8.4"
-                    },
-                    "cluster_topology": [{
-                        "instance_configuration_id": "apm",
-                        "size": {
-                            "resource": "memory",
-                            "value": 512
-                        },
-                        "zone_count": 1
-                    }]
-                }
-            }
-        ],
-        "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": 1
-                        }
-                    ]
-                }
-            }
-        ],
-        "kibana": [
-            {
-                "display_name": "my kibana instance",
-                "ref_id": "my-kibana-instance",
-                "elasticsearch_cluster_ref_id": "my-es-cluster",
-                "plan": {
-                    "kibana": {
-                        "version": "6.8.4"
-                    },
-                    "cluster_topology": [
-                        {
-                            "instance_configuration_id": "kibana",
-                            "memory_per_node": 1024,
-                            "node_count_per_zone": 1,
-                            "zone_count": 1
-                        }
-                    ]
-                }
-            }
-        ]
-    }
-}
-$ ecctl deployment create -f deployment_example.json --version=7.4.1
+## To make the command wait until the resources have been created use the "--track" flag, which will output
+the current stage on which the deployment resources are in.
+$ deployment create --file create_example.json --track
 [...]
+Deployment [b6ecbea3d5c84124b7dca457f2892086] - [Elasticsearch][b6ecbea3d5c84124b7dca457f2892086]: finished running all the plan steps (Total plan duration: 5m11.s)
+Deployment [91c4d60acb804ba0a27651fac02780ec] - [Kibana][8a9d9916cd6e46a7bb0912211d76e2af]: finished running all the plan steps (Total plan duration: 4m29.58s)
 
-## If the previous deployment creation failed
-$ ecctl deployment create -f deployment_example.json --name adeploy --version=7.4.1
+## To retry a when the previous deployment creation failed:
+$ ecctl deployment create --file create_example.json
 The deployment creation returned with an error, please use the displayed idempotency token
 to recreate the deployment resources
 Idempotency token: GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb
 unknown error (status 500)
-$ ecctl deployment create -f deployment_example.json --name adeploy --version=7.4.1 --request-id=GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb
-[...]
+$ ecctl deployment create --file create_example.json --request-id=GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb
 ----
 
 [float]
 === Options
 
 ----
-  -f, --file string         JSON file that contains JSON-style domain-specific deployment definition
+  -f, --file string         DeploymentCreateRequest file definition. See help for more information
   -h, --help                help for create
-      --name string         Overrides the deployment name
       --request-id string   Optional idempotency token - Can be found in the Stderr device when a previous deployment creation failed, for more information see the examples in the help command page
   -t, --track               Tracks the progress of the performed task
-      --version string      Overrides all the deployment's resources to the specified version
 ----
 
 [float]
@@ -134,13 +60,14 @@ $ ecctl deployment create -f deployment_example.json --name adeploy --version=7.
       --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
 ----
 
 [float]
-=== See also
+=== SEE ALSO
 
 * xref:ecctl_deployment[ecctl deployment]	 - Manages deployments