diff --git a/docs/docset.yml b/docs/docset.yml new file mode 100644 index 000000000..8923f652a --- /dev/null +++ b/docs/docset.yml @@ -0,0 +1,487 @@ +project: 'Elastic cloud control (ECCTL) docs' +cross_links: + - cloud + - docs-content + - elasticsearch +toc: + - toc: reference +subs: + ref: "https://www.elastic.co/guide/en/elasticsearch/reference/current" + ref-bare: "https://www.elastic.co/guide/en/elasticsearch/reference" + ref-8x: "https://www.elastic.co/guide/en/elasticsearch/reference/8.1" + ref-80: "https://www.elastic.co/guide/en/elasticsearch/reference/8.0" + ref-7x: "https://www.elastic.co/guide/en/elasticsearch/reference/7.17" + ref-70: "https://www.elastic.co/guide/en/elasticsearch/reference/7.0" + ref-60: "https://www.elastic.co/guide/en/elasticsearch/reference/6.0" + ref-64: "https://www.elastic.co/guide/en/elasticsearch/reference/6.4" + xpack-ref: "https://www.elastic.co/guide/en/x-pack/6.2" + logstash-ref: "https://www.elastic.co/guide/en/logstash/current" + kibana-ref: "https://www.elastic.co/guide/en/kibana/current" + kibana-ref-all: "https://www.elastic.co/guide/en/kibana" + beats-ref-root: "https://www.elastic.co/guide/en/beats" + beats-ref: "https://www.elastic.co/guide/en/beats/libbeat/current" + beats-ref-60: "https://www.elastic.co/guide/en/beats/libbeat/6.0" + beats-ref-63: "https://www.elastic.co/guide/en/beats/libbeat/6.3" + beats-devguide: "https://www.elastic.co/guide/en/beats/devguide/current" + auditbeat-ref: "https://www.elastic.co/guide/en/beats/auditbeat/current" + packetbeat-ref: "https://www.elastic.co/guide/en/beats/packetbeat/current" + metricbeat-ref: "https://www.elastic.co/guide/en/beats/metricbeat/current" + filebeat-ref: "https://www.elastic.co/guide/en/beats/filebeat/current" + functionbeat-ref: "https://www.elastic.co/guide/en/beats/functionbeat/current" + winlogbeat-ref: "https://www.elastic.co/guide/en/beats/winlogbeat/current" + heartbeat-ref: "https://www.elastic.co/guide/en/beats/heartbeat/current" + journalbeat-ref: "https://www.elastic.co/guide/en/beats/journalbeat/current" + ingest-guide: "https://www.elastic.co/guide/en/ingest/current" + fleet-guide: "https://www.elastic.co/guide/en/fleet/current" + apm-guide-ref: "https://www.elastic.co/guide/en/apm/guide/current" + apm-guide-7x: "https://www.elastic.co/guide/en/apm/guide/7.17" + apm-app-ref: "https://www.elastic.co/guide/en/kibana/current" + apm-agents-ref: "https://www.elastic.co/guide/en/apm/agent" + apm-android-ref: "https://www.elastic.co/guide/en/apm/agent/android/current" + apm-py-ref: "https://www.elastic.co/guide/en/apm/agent/python/current" + apm-py-ref-3x: "https://www.elastic.co/guide/en/apm/agent/python/3.x" + apm-node-ref-index: "https://www.elastic.co/guide/en/apm/agent/nodejs" + apm-node-ref: "https://www.elastic.co/guide/en/apm/agent/nodejs/current" + apm-node-ref-1x: "https://www.elastic.co/guide/en/apm/agent/nodejs/1.x" + apm-rum-ref: "https://www.elastic.co/guide/en/apm/agent/rum-js/current" + apm-ruby-ref: "https://www.elastic.co/guide/en/apm/agent/ruby/current" + apm-java-ref: "https://www.elastic.co/guide/en/apm/agent/java/current" + apm-go-ref: "https://www.elastic.co/guide/en/apm/agent/go/current" + apm-dotnet-ref: "https://www.elastic.co/guide/en/apm/agent/dotnet/current" + apm-php-ref: "https://www.elastic.co/guide/en/apm/agent/php/current" + apm-ios-ref: "https://www.elastic.co/guide/en/apm/agent/swift/current" + apm-lambda-ref: "https://www.elastic.co/guide/en/apm/lambda/current" + apm-attacher-ref: "https://www.elastic.co/guide/en/apm/attacher/current" + docker-logging-ref: "https://www.elastic.co/guide/en/beats/loggingplugin/current" + esf-ref: "https://www.elastic.co/guide/en/esf/current" + kinesis-firehose-ref: "https://www.elastic.co/guide/en/kinesis/{{kinesis_version}}" + estc-welcome-current: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current" + estc-welcome: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current" + estc-welcome-all: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions" + hadoop-ref: "https://www.elastic.co/guide/en/elasticsearch/hadoop/current" + stack-ref: "https://www.elastic.co/guide/en/elastic-stack/current" + stack-ref-67: "https://www.elastic.co/guide/en/elastic-stack/6.7" + stack-ref-68: "https://www.elastic.co/guide/en/elastic-stack/6.8" + stack-ref-70: "https://www.elastic.co/guide/en/elastic-stack/7.0" + stack-ref-80: "https://www.elastic.co/guide/en/elastic-stack/8.0" + stack-ov: "https://www.elastic.co/guide/en/elastic-stack-overview/current" + stack-gs: "https://www.elastic.co/guide/en/elastic-stack-get-started/current" + stack-gs-current: "https://www.elastic.co/guide/en/elastic-stack-get-started/current" + javaclient: "https://www.elastic.co/guide/en/elasticsearch/client/java-api/current" + java-api-client: "https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current" + java-rest: "https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current" + jsclient: "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current" + jsclient-current: "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current" + es-ruby-client: "https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current" + es-dotnet-client: "https://www.elastic.co/guide/en/elasticsearch/client/net-api/current" + es-php-client: "https://www.elastic.co/guide/en/elasticsearch/client/php-api/current" + es-python-client: "https://www.elastic.co/guide/en/elasticsearch/client/python-api/current" + defguide: "https://www.elastic.co/guide/en/elasticsearch/guide/2.x" + painless: "https://www.elastic.co/guide/en/elasticsearch/painless/current" + plugins: "https://www.elastic.co/guide/en/elasticsearch/plugins/current" + plugins-8x: "https://www.elastic.co/guide/en/elasticsearch/plugins/8.1" + plugins-7x: "https://www.elastic.co/guide/en/elasticsearch/plugins/7.17" + plugins-6x: "https://www.elastic.co/guide/en/elasticsearch/plugins/6.8" + glossary: "https://www.elastic.co/guide/en/elastic-stack-glossary/current" + upgrade_guide: "https://www.elastic.co/products/upgrade_guide" + blog-ref: "https://www.elastic.co/blog/" + curator-ref: "https://www.elastic.co/guide/en/elasticsearch/client/curator/current" + curator-ref-current: "https://www.elastic.co/guide/en/elasticsearch/client/curator/current" + metrics-ref: "https://www.elastic.co/guide/en/metrics/current" + metrics-guide: "https://www.elastic.co/guide/en/metrics/guide/current" + logs-ref: "https://www.elastic.co/guide/en/logs/current" + logs-guide: "https://www.elastic.co/guide/en/logs/guide/current" + uptime-guide: "https://www.elastic.co/guide/en/uptime/current" + observability-guide: "https://www.elastic.co/guide/en/observability/current" + observability-guide-all: "https://www.elastic.co/guide/en/observability" + siem-guide: "https://www.elastic.co/guide/en/siem/guide/current" + security-guide: "https://www.elastic.co/guide/en/security/current" + security-guide-all: "https://www.elastic.co/guide/en/security" + endpoint-guide: "https://www.elastic.co/guide/en/endpoint/current" + sql-odbc: "https://www.elastic.co/guide/en/elasticsearch/sql-odbc/current" + ecs-ref: "https://www.elastic.co/guide/en/ecs/current" + ecs-logging-ref: "https://www.elastic.co/guide/en/ecs-logging/overview/current" + ecs-logging-go-logrus-ref: "https://www.elastic.co/guide/en/ecs-logging/go-logrus/current" + ecs-logging-go-zap-ref: "https://www.elastic.co/guide/en/ecs-logging/go-zap/current" + ecs-logging-go-zerolog-ref: "https://www.elastic.co/guide/en/ecs-logging/go-zap/current" + ecs-logging-java-ref: "https://www.elastic.co/guide/en/ecs-logging/java/current" + ecs-logging-dotnet-ref: "https://www.elastic.co/guide/en/ecs-logging/dotnet/current" + ecs-logging-nodejs-ref: "https://www.elastic.co/guide/en/ecs-logging/nodejs/current" + ecs-logging-php-ref: "https://www.elastic.co/guide/en/ecs-logging/php/current" + ecs-logging-python-ref: "https://www.elastic.co/guide/en/ecs-logging/python/current" + ecs-logging-ruby-ref: "https://www.elastic.co/guide/en/ecs-logging/ruby/current" + ml-docs: "https://www.elastic.co/guide/en/machine-learning/current" + eland-docs: "https://www.elastic.co/guide/en/elasticsearch/client/eland/current" + eql-ref: "https://eql.readthedocs.io/en/latest/query-guide" + extendtrial: "https://www.elastic.co/trialextension" + wikipedia: "https://en.wikipedia.org/wiki" + forum: "https://discuss.elastic.co/" + xpack-forum: "https://discuss.elastic.co/c/50-x-pack" + security-forum: "https://discuss.elastic.co/c/x-pack/shield" + watcher-forum: "https://discuss.elastic.co/c/x-pack/watcher" + monitoring-forum: "https://discuss.elastic.co/c/x-pack/marvel" + graph-forum: "https://discuss.elastic.co/c/x-pack/graph" + apm-forum: "https://discuss.elastic.co/c/apm" + enterprise-search-ref: "https://www.elastic.co/guide/en/enterprise-search/current" + app-search-ref: "https://www.elastic.co/guide/en/app-search/current" + workplace-search-ref: "https://www.elastic.co/guide/en/workplace-search/current" + enterprise-search-node-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/enterprise-search-node/current" + enterprise-search-php-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/php/current" + enterprise-search-python-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/python/current" + enterprise-search-ruby-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current" + elastic-maps-service: "https://maps.elastic.co" + integrations-docs: "https://docs.elastic.co/en/integrations" + integrations-devguide: "https://www.elastic.co/guide/en/integrations-developer/current" + time-units: "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#time-units" + byte-units: "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units" + apm-py-ref-v: "https://www.elastic.co/guide/en/apm/agent/python/current" + apm-node-ref-v: "https://www.elastic.co/guide/en/apm/agent/nodejs/current" + apm-rum-ref-v: "https://www.elastic.co/guide/en/apm/agent/rum-js/current" + apm-ruby-ref-v: "https://www.elastic.co/guide/en/apm/agent/ruby/current" + apm-java-ref-v: "https://www.elastic.co/guide/en/apm/agent/java/current" + apm-go-ref-v: "https://www.elastic.co/guide/en/apm/agent/go/current" + apm-ios-ref-v: "https://www.elastic.co/guide/en/apm/agent/swift/current" + apm-dotnet-ref-v: "https://www.elastic.co/guide/en/apm/agent/dotnet/current" + apm-php-ref-v: "https://www.elastic.co/guide/en/apm/agent/php/current" + ecloud: "Elastic Cloud" + esf: "Elastic Serverless Forwarder" + ess: "Elasticsearch Service" + ece: "Elastic Cloud Enterprise" + eck: "Elastic Cloud on Kubernetes" + serverless-full: "Elastic Cloud Serverless" + serverless-short: "Serverless" + es-serverless: "Elasticsearch Serverless" + es3: "Elasticsearch Serverless" + obs-serverless: "Elastic Observability Serverless" + sec-serverless: "Elastic Security Serverless" + serverless-docs: "https://docs.elastic.co/serverless" + cloud: "https://www.elastic.co/guide/en/cloud/current" + ess-utm-params: "?page=docs&placement=docs-body" + ess-baymax: "?page=docs&placement=docs-body" + ess-trial: "https://cloud.elastic.co/registration?page=docs&placement=docs-body" + ess-product: "https://www.elastic.co/cloud/elasticsearch-service?page=docs&placement=docs-body" + ess-console: "https://cloud.elastic.co?page=docs&placement=docs-body" + ess-console-name: "Elasticsearch Service Console" + ess-deployments: "https://cloud.elastic.co/deployments?page=docs&placement=docs-body" + ece-ref: "https://www.elastic.co/guide/en/cloud-enterprise/current" + eck-ref: "https://www.elastic.co/guide/en/cloud-on-k8s/current" + ess-leadin: "You can run Elasticsearch on your own hardware or use our hosted Elasticsearch Service that is available on AWS, GCP, and Azure. https://cloud.elastic.co/registration{ess-utm-params}[Try the Elasticsearch Service for free]." + ess-leadin-short: "Our hosted Elasticsearch Service is available on AWS, GCP, and Azure, and you can https://cloud.elastic.co/registration{ess-utm-params}[try it for free]." + ess-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"https://cloud.elastic.co/registration{ess-utm-params}\", title=\"Supported on Elasticsearch Service\"]" + ece-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud_ece.svg[link=\"https://cloud.elastic.co/registration{ess-utm-params}\", title=\"Supported on Elastic Cloud Enterprise\"]" + cloud-only: "This feature is designed for indirect use by https://cloud.elastic.co/registration{ess-utm-params}[Elasticsearch Service], https://www.elastic.co/guide/en/cloud-enterprise/{ece-version-link}[Elastic Cloud Enterprise], and https://www.elastic.co/guide/en/cloud-on-k8s/current[Elastic Cloud on Kubernetes]. Direct use is not supported." + ess-setting-change: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"{ess-trial}\", title=\"Supported on {ess}\"] indicates a change to a supported https://www.elastic.co/guide/en/cloud/current/ec-add-user-settings.html[user setting] for Elasticsearch Service." + ess-skip-section: "If you use Elasticsearch Service, skip this section. Elasticsearch Service handles these changes for you." + api-cloud: "https://www.elastic.co/docs/api/doc/cloud" + api-ece: "https://www.elastic.co/docs/api/doc/cloud-enterprise" + api-kibana-serverless: "https://www.elastic.co/docs/api/doc/serverless" + es-feature-flag: "This feature is in development and not yet available for use. This documentation is provided for informational purposes only." + es-ref-dir: "'{{elasticsearch-root}}/docs/reference'" + apm-app: "APM app" + uptime-app: "Uptime app" + synthetics-app: "Synthetics app" + logs-app: "Logs app" + metrics-app: "Metrics app" + infrastructure-app: "Infrastructure app" + siem-app: "SIEM app" + security-app: "Elastic Security app" + ml-app: "Machine Learning" + dev-tools-app: "Dev Tools" + ingest-manager-app: "Ingest Manager" + stack-manage-app: "Stack Management" + stack-monitor-app: "Stack Monitoring" + alerts-ui: "Alerts and Actions" + rules-ui: "Rules" + rac-ui: "Rules and Connectors" + connectors-ui: "Connectors" + connectors-feature: "Actions and Connectors" + stack-rules-feature: "Stack Rules" + user-experience: "User Experience" + ems: "Elastic Maps Service" + ems-init: "EMS" + hosted-ems: "Elastic Maps Server" + ipm-app: "Index Pattern Management" + ingest-pipelines: "ingest pipelines" + ingest-pipelines-app: "Ingest Pipelines" + ingest-pipelines-cap: "Ingest pipelines" + ls-pipelines: "Logstash pipelines" + ls-pipelines-app: "Logstash Pipelines" + maint-windows: "maintenance windows" + maint-windows-app: "Maintenance Windows" + maint-windows-cap: "Maintenance windows" + custom-roles-app: "Custom Roles" + data-source: "data view" + data-sources: "data views" + data-source-caps: "Data View" + data-sources-caps: "Data Views" + data-source-cap: "Data view" + data-sources-cap: "Data views" + project-settings: "Project settings" + manage-app: "Management" + index-manage-app: "Index Management" + data-views-app: "Data Views" + rules-app: "Rules" + saved-objects-app: "Saved Objects" + tags-app: "Tags" + api-keys-app: "API keys" + transforms-app: "Transforms" + connectors-app: "Connectors" + files-app: "Files" + reports-app: "Reports" + maps-app: "Maps" + alerts-app: "Alerts" + crawler: "Enterprise Search web crawler" + ents: "Enterprise Search" + app-search-crawler: "App Search web crawler" + agent: "Elastic Agent" + agents: "Elastic Agents" + fleet: "Fleet" + fleet-server: "Fleet Server" + integrations-server: "Integrations Server" + ingest-manager: "Ingest Manager" + ingest-management: "ingest management" + package-manager: "Elastic Package Manager" + integrations: "Integrations" + package-registry: "Elastic Package Registry" + artifact-registry: "Elastic Artifact Registry" + aws: "AWS" + stack: "Elastic Stack" + xpack: "X-Pack" + es: "Elasticsearch" + kib: "Kibana" + esms: "Elastic Stack Monitoring Service" + esms-init: "ESMS" + ls: "Logstash" + beats: "Beats" + auditbeat: "Auditbeat" + filebeat: "Filebeat" + heartbeat: "Heartbeat" + metricbeat: "Metricbeat" + packetbeat: "Packetbeat" + winlogbeat: "Winlogbeat" + functionbeat: "Functionbeat" + journalbeat: "Journalbeat" + es-sql: "Elasticsearch SQL" + esql: "ES|QL" + elastic-agent: "Elastic Agent" + k8s: "Kubernetes" + log-driver-long: "Elastic Logging Plugin for Docker" + security: "X-Pack security" + security-features: "security features" + operator-feature: "operator privileges feature" + es-security-features: "Elasticsearch security features" + stack-security-features: "Elastic Stack security features" + endpoint-sec: "Endpoint Security" + endpoint-cloud-sec: "Endpoint and Cloud Security" + elastic-defend: "Elastic Defend" + elastic-sec: "Elastic Security" + elastic-endpoint: "Elastic Endpoint" + swimlane: "Swimlane" + sn: "ServiceNow" + sn-itsm: "ServiceNow ITSM" + sn-itom: "ServiceNow ITOM" + sn-sir: "ServiceNow SecOps" + jira: "Jira" + ibm-r: "IBM Resilient" + webhook: "Webhook" + webhook-cm: "Webhook - Case Management" + opsgenie: "Opsgenie" + bedrock: "Amazon Bedrock" + gemini: "Google Gemini" + hive: "TheHive" + monitoring: "X-Pack monitoring" + monitor-features: "monitoring features" + stack-monitor-features: "Elastic Stack monitoring features" + watcher: "Watcher" + alert-features: "alerting features" + reporting: "X-Pack reporting" + report-features: "reporting features" + graph: "X-Pack graph" + graph-features: "graph analytics features" + searchprofiler: "Search Profiler" + xpackml: "X-Pack machine learning" + ml: "machine learning" + ml-cap: "Machine learning" + ml-init: "ML" + ml-features: "machine learning features" + stack-ml-features: "Elastic Stack machine learning features" + ccr: "cross-cluster replication" + ccr-cap: "Cross-cluster replication" + ccr-init: "CCR" + ccs: "cross-cluster search" + ccs-cap: "Cross-cluster search" + ccs-init: "CCS" + ilm: "index lifecycle management" + ilm-cap: "Index lifecycle management" + ilm-init: "ILM" + dlm: "data lifecycle management" + dlm-cap: "Data lifecycle management" + dlm-init: "DLM" + search-snap: "searchable snapshot" + search-snaps: "searchable snapshots" + search-snaps-cap: "Searchable snapshots" + slm: "snapshot lifecycle management" + slm-cap: "Snapshot lifecycle management" + slm-init: "SLM" + rollup-features: "data rollup features" + ipm: "index pattern management" + ipm-cap: "Index pattern" + rollup: "rollup" + rollup-cap: "Rollup" + rollups: "rollups" + rollups-cap: "Rollups" + rollup-job: "rollup job" + rollup-jobs: "rollup jobs" + rollup-jobs-cap: "Rollup jobs" + dfeed: "datafeed" + dfeeds: "datafeeds" + dfeed-cap: "Datafeed" + dfeeds-cap: "Datafeeds" + ml-jobs: "machine learning jobs" + ml-jobs-cap: "Machine learning jobs" + anomaly-detect: "anomaly detection" + anomaly-detect-cap: "Anomaly detection" + anomaly-job: "anomaly detection job" + anomaly-jobs: "anomaly detection jobs" + anomaly-jobs-cap: "Anomaly detection jobs" + dataframe: "data frame" + dataframes: "data frames" + dataframe-cap: "Data frame" + dataframes-cap: "Data frames" + watcher-transform: "payload transform" + watcher-transforms: "payload transforms" + watcher-transform-cap: "Payload transform" + watcher-transforms-cap: "Payload transforms" + transform: "transform" + transforms: "transforms" + transform-cap: "Transform" + transforms-cap: "Transforms" + dataframe-transform: "transform" + dataframe-transform-cap: "Transform" + dataframe-transforms: "transforms" + dataframe-transforms-cap: "Transforms" + dfanalytics-cap: "Data frame analytics" + dfanalytics: "data frame analytics" + dataframe-analytics-config: "'{dataframe} analytics config'" + dfanalytics-job: "'{dataframe} analytics job'" + dfanalytics-jobs: "'{dataframe} analytics jobs'" + dfanalytics-jobs-cap: "'{dataframe-cap} analytics jobs'" + cdataframe: "continuous data frame" + cdataframes: "continuous data frames" + cdataframe-cap: "Continuous data frame" + cdataframes-cap: "Continuous data frames" + cdataframe-transform: "continuous transform" + cdataframe-transforms: "continuous transforms" + cdataframe-transforms-cap: "Continuous transforms" + ctransform: "continuous transform" + ctransform-cap: "Continuous transform" + ctransforms: "continuous transforms" + ctransforms-cap: "Continuous transforms" + oldetection: "outlier detection" + oldetection-cap: "Outlier detection" + olscore: "outlier score" + olscores: "outlier scores" + fiscore: "feature influence score" + evaluatedf-api: "evaluate {dataframe} analytics API" + evaluatedf-api-cap: "Evaluate {dataframe} analytics API" + binarysc: "binary soft classification" + binarysc-cap: "Binary soft classification" + regression: "regression" + regression-cap: "Regression" + reganalysis: "regression analysis" + reganalysis-cap: "Regression analysis" + depvar: "dependent variable" + feature-var: "feature variable" + feature-vars: "feature variables" + feature-vars-cap: "Feature variables" + classification: "classification" + classification-cap: "Classification" + classanalysis: "classification analysis" + classanalysis-cap: "Classification analysis" + infer-cap: "Inference" + infer: "inference" + lang-ident-cap: "Language identification" + lang-ident: "language identification" + data-viz: "Data Visualizer" + file-data-viz: "File Data Visualizer" + feat-imp: "feature importance" + feat-imp-cap: "Feature importance" + nlp: "natural language processing" + nlp-cap: "Natural language processing" + apm-agent: "APM agent" + apm-go-agent: "Elastic APM Go agent" + apm-go-agents: "Elastic APM Go agents" + apm-ios-agent: "Elastic APM iOS agent" + apm-ios-agents: "Elastic APM iOS agents" + apm-java-agent: "Elastic APM Java agent" + apm-java-agents: "Elastic APM Java agents" + apm-dotnet-agent: "Elastic APM .NET agent" + apm-dotnet-agents: "Elastic APM .NET agents" + apm-node-agent: "Elastic APM Node.js agent" + apm-node-agents: "Elastic APM Node.js agents" + apm-php-agent: "Elastic APM PHP agent" + apm-php-agents: "Elastic APM PHP agents" + apm-py-agent: "Elastic APM Python agent" + apm-py-agents: "Elastic APM Python agents" + apm-ruby-agent: "Elastic APM Ruby agent" + apm-ruby-agents: "Elastic APM Ruby agents" + apm-rum-agent: "Elastic APM Real User Monitoring (RUM) JavaScript agent" + apm-rum-agents: "Elastic APM RUM JavaScript agents" + apm-lambda-ext: "Elastic APM AWS Lambda extension" + project-monitors: "project monitors" + project-monitors-cap: "Project monitors" + private-location: "Private Location" + private-locations: "Private Locations" + pwd: "YOUR_PASSWORD" + esh: "ES-Hadoop" + default-dist: "default distribution" + oss-dist: "OSS-only distribution" + observability: "Observability" + api-request-title: "Request" + api-prereq-title: "Prerequisites" + api-description-title: "Description" + api-path-parms-title: "Path parameters" + api-query-parms-title: "Query parameters" + api-request-body-title: "Request body" + api-response-codes-title: "Response codes" + api-response-body-title: "Response body" + api-example-title: "Example" + api-examples-title: "Examples" + api-definitions-title: "Properties" + multi-arg: "†footnoteref:[multi-arg,This parameter accepts multiple arguments.]" + multi-arg-ref: "†footnoteref:[multi-arg]" + yes-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png[Yes,20,15]" + no-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png[No,20,15]" + es-repo: "https://github.com/elastic/elasticsearch/" + es-issue: "https://github.com/elastic/elasticsearch/issues/" + es-pull: "https://github.com/elastic/elasticsearch/pull/" + es-commit: "https://github.com/elastic/elasticsearch/commit/" + kib-repo: "https://github.com/elastic/kibana/" + kib-issue: "https://github.com/elastic/kibana/issues/" + kibana-issue: "'{kib-repo}issues/'" + kib-pull: "https://github.com/elastic/kibana/pull/" + kibana-pull: "'{kib-repo}pull/'" + kib-commit: "https://github.com/elastic/kibana/commit/" + ml-repo: "https://github.com/elastic/ml-cpp/" + ml-issue: "https://github.com/elastic/ml-cpp/issues/" + ml-pull: "https://github.com/elastic/ml-cpp/pull/" + ml-commit: "https://github.com/elastic/ml-cpp/commit/" + apm-repo: "https://github.com/elastic/apm-server/" + apm-issue: "https://github.com/elastic/apm-server/issues/" + apm-pull: "https://github.com/elastic/apm-server/pull/" + kibana-blob: "https://github.com/elastic/kibana/blob/current/" + apm-get-started-ref: "https://www.elastic.co/guide/en/apm/get-started/current" + apm-server-ref: "https://www.elastic.co/guide/en/apm/server/current" + apm-server-ref-v: "https://www.elastic.co/guide/en/apm/server/current" + apm-server-ref-m: "https://www.elastic.co/guide/en/apm/server/master" + apm-server-ref-62: "https://www.elastic.co/guide/en/apm/server/6.2" + apm-server-ref-64: "https://www.elastic.co/guide/en/apm/server/6.4" + apm-server-ref-70: "https://www.elastic.co/guide/en/apm/server/7.0" + apm-overview-ref-v: "https://www.elastic.co/guide/en/apm/get-started/current" + apm-overview-ref-70: "https://www.elastic.co/guide/en/apm/get-started/7.0" + apm-overview-ref-m: "https://www.elastic.co/guide/en/apm/get-started/master" + infra-guide: "https://www.elastic.co/guide/en/infrastructure/guide/current" + a-data-source: "a data view" + icon-bug: "pass:[]" + icon-checkInCircleFilled: "pass:[]" + icon-warningFilled: "pass:[]" diff --git a/docs/ecctl-command-reference-index.adoc b/docs/ecctl-command-reference-index.adoc deleted file mode 100644 index fb17b43b9..000000000 --- a/docs/ecctl-command-reference-index.adoc +++ /dev/null @@ -1,137 +0,0 @@ -include::ecctl.adoc[] -include::ecctl_auth.adoc[] -include::ecctl_auth_key.adoc[] -include::ecctl_auth_key_create.adoc[] -include::ecctl_auth_key_delete.adoc[] -include::ecctl_auth_key_list.adoc[] -include::ecctl_auth_key_show.adoc[] -include::ecctl_comment.adoc[] -include::ecctl_comment_create.adoc[] -include::ecctl_comment_delete.adoc[] -include::ecctl_comment_list.adoc[] -include::ecctl_comment_show.adoc[] -include::ecctl_comment_update.adoc[] -include::ecctl_deployment.adoc[] -include::ecctl_deployment_create.adoc[] -include::ecctl_deployment_delete.adoc[] -include::ecctl_deployment_elasticsearch.adoc[] -include::ecctl_deployment_elasticsearch_keystore.adoc[] -include::ecctl_deployment_elasticsearch_keystore_show.adoc[] -include::ecctl_deployment_elasticsearch_keystore_update.adoc[] -include::ecctl_deployment_extension.adoc[] -include::ecctl_deployment_extension_create.adoc[] -include::ecctl_deployment_extension_delete.adoc[] -include::ecctl_deployment_extension_list.adoc[] -include::ecctl_deployment_extension_show.adoc[] -include::ecctl_deployment_extension_update.adoc[] -include::ecctl_deployment_list.adoc[] -include::ecctl_deployment_plan.adoc[] -include::ecctl_deployment_plan_cancel.adoc[] -include::ecctl_deployment_resource.adoc[] -include::ecctl_deployment_resource_delete.adoc[] -include::ecctl_deployment_resource_restore.adoc[] -include::ecctl_deployment_resource_shutdown.adoc[] -include::ecctl_deployment_resource_start-maintenance.adoc[] -include::ecctl_deployment_resource_start.adoc[] -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[] -include::ecctl_deployment_template.adoc[] -include::ecctl_deployment_template_create.adoc[] -include::ecctl_deployment_template_delete.adoc[] -include::ecctl_deployment_template_list.adoc[] -include::ecctl_deployment_template_show.adoc[] -include::ecctl_deployment_template_update.adoc[] -include::ecctl_deployment_traffic-filter.adoc[] -include::ecctl_deployment_traffic-filter_association.adoc[] -include::ecctl_deployment_traffic-filter_association_create.adoc[] -include::ecctl_deployment_traffic-filter_association_delete.adoc[] -include::ecctl_deployment_traffic-filter_create.adoc[] -include::ecctl_deployment_traffic-filter_delete.adoc[] -include::ecctl_deployment_traffic-filter_list.adoc[] -include::ecctl_deployment_traffic-filter_show.adoc[] -include::ecctl_deployment_traffic-filter_update.adoc[] -include::ecctl_deployment_update.adoc[] -include::ecctl_generate.adoc[] -include::ecctl_generate_completions.adoc[] -include::ecctl_generate_docs.adoc[] -include::ecctl_init.adoc[] -include::ecctl_platform.adoc[] -include::ecctl_platform_allocator.adoc[] -include::ecctl_platform_allocator_list.adoc[] -include::ecctl_platform_allocator_maintenance.adoc[] -include::ecctl_platform_allocator_metadata.adoc[] -include::ecctl_platform_allocator_metadata_delete.adoc[] -include::ecctl_platform_allocator_metadata_set.adoc[] -include::ecctl_platform_allocator_metadata_show.adoc[] -include::ecctl_platform_allocator_search.adoc[] -include::ecctl_platform_allocator_show.adoc[] -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_enrollment-token.adoc[] -include::ecctl_platform_enrollment-token_create.adoc[] -include::ecctl_platform_enrollment-token_delete.adoc[] -include::ecctl_platform_enrollment-token_list.adoc[] -include::ecctl_platform_info.adoc[] -include::ecctl_platform_instance-configuration.adoc[] -include::ecctl_platform_instance-configuration_create.adoc[] -include::ecctl_platform_instance-configuration_delete.adoc[] -include::ecctl_platform_instance-configuration_list.adoc[] -include::ecctl_platform_instance-configuration_pull.adoc[] -include::ecctl_platform_instance-configuration_show.adoc[] -include::ecctl_platform_instance-configuration_update.adoc[] -include::ecctl_platform_proxy.adoc[] -include::ecctl_platform_proxy_filtered-group.adoc[] -include::ecctl_platform_proxy_filtered-group_create.adoc[] -include::ecctl_platform_proxy_filtered-group_delete.adoc[] -include::ecctl_platform_proxy_filtered-group_list.adoc[] -include::ecctl_platform_proxy_filtered-group_show.adoc[] -include::ecctl_platform_proxy_filtered-group_update.adoc[] -include::ecctl_platform_proxy_list.adoc[] -include::ecctl_platform_proxy_settings.adoc[] -include::ecctl_platform_proxy_settings_show.adoc[] -include::ecctl_platform_proxy_settings_update.adoc[] -include::ecctl_platform_proxy_show.adoc[] -include::ecctl_platform_repository.adoc[] -include::ecctl_platform_repository_create.adoc[] -include::ecctl_platform_repository_delete.adoc[] -include::ecctl_platform_repository_list.adoc[] -include::ecctl_platform_repository_show.adoc[] -include::ecctl_platform_role.adoc[] -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_role_update.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_stack.adoc[] -include::ecctl_stack_delete.adoc[] -include::ecctl_stack_list.adoc[] -include::ecctl_stack_show.adoc[] -include::ecctl_stack_upload.adoc[] -include::ecctl_user.adoc[] -include::ecctl_user_create.adoc[] -include::ecctl_user_delete.adoc[] -include::ecctl_user_disable.adoc[] -include::ecctl_user_enable.adoc[] -include::ecctl_user_key.adoc[] -include::ecctl_user_key_delete.adoc[] -include::ecctl_user_key_list.adoc[] -include::ecctl_user_key_show.adoc[] -include::ecctl_user_list.adoc[] -include::ecctl_user_show.adoc[] -include::ecctl_user_update.adoc[] -include::ecctl_version.adoc[] diff --git a/docs/ecctl-getting-started.asciidoc b/docs/ecctl-getting-started.asciidoc deleted file mode 100644 index 3ddb37b8d..000000000 --- a/docs/ecctl-getting-started.asciidoc +++ /dev/null @@ -1,643 +0,0 @@ -[id="{p}-overview"] -== Overview - -{p} is the command-line interface for the Elasticsearch Service and Elastic Cloud Enterprise (ECE) APIs. -It wraps typical operations commonly needed by operators within a single command line tool. - -Benefits of {p}: - -* Easier to use than the Cloud UI or using the RESTful API directly -* Helps you automate the deployment lifecycle -* Provides a foundation for integration with other tools - -[id="{p}-installing"] -== Installing - -The latest stable binaries can be found on the -https://github.com/elastic/ecctl/releases[release page] or compiled from -the latest on the master branch to leverage the most recently merged -features. - -To learn more about building {p} from the source, see -the steps from our link:https://github.com/elastic/ecctl/blob/master/CONTRIBUTING.md#setting-up-a-dev-environment[Setting up a dev environment]. - -[float] -[id="{p}-installing-macos"] -=== Install on macOS - -The simplest installation for macOS users is to install {p} with -link:https://brew.sh/[Homebrew]: - -[source] ----- -$ brew tap elastic/tap -$ brew install elastic/tap/ecctl - -Updating Homebrew... -==> Installing ecctl from elastic/tap -... -==> Caveats -To get autocompletions working make sure to run "source <(ecctl generate completions)". -If you prefer to add to your shell interpreter configuration file run, for bash or zsh respectively: -* `echo "source <(ecctl generate completions)" >> ~/.bash_profile` -* `echo "source <(ecctl generate completions)" >> ~/.zshrc`. -==> Summary -🍺 /usr/local/Cellar/ecctl/1.5.0: 5 files, 22.6MB, built in 4 seconds - ----- - -NOTE: To get autocompletions working, follow the instructions in the Homebrew output. - -[float] -[id="{p}-upgrading-macos"] -=== Upgrade on macOS - -To upgrade {p} via brew: - -[source] ----- -$ brew upgrade ecctl - ----- - -//// -[float] -[id="{p}-installing-linux"] -== Install on Linux - -// NR TO DO with info from https://github.com/elastic/cloud-cli#linux-based-os - -The simplest installation for Linux-based users is to install ecl with apt-get. We are hosting ecl binaries in a temporary apt repository so you need to do the following: - -[source,console] ----- -$ echo "deb [trusted=yes] https://s3.us-east-2.amazonaws.com/cloud-soteria-apt-repo stable main" >> etc/apt/sources.list.d/myrepo.list -$ apt-get install ece-ctl -y -The following NEW packages will be installed: - ece-ctl -0 upgraded, 1 newly installed, 0 to remove and 16 not upgraded. -Need to get 4379 kB of archives. -After this operation, 13.8 MB of additional disk space will be used. -Get:1 https://s3.us-east-2.amazonaws.com/cloud-soteria-apt-repo/ stable/main ece-ctl amd64 0.12.0 [4379 kB] -debconf: delaying package configuration, since apt-utils is not installed -Fetched 4379 kB in 4s (1052 kB/s) -dpkg: warning: parsing file '/var/lib/dpkg/tmp.ci/control' near line 11 package 'ece-ctl': - missing maintainer -Selecting previously unselected package ece-ctl. -(Reading database ... 7965 files and directories currently installed.) -Preparing to unpack .../ece-ctl_0.12.0_amd64.deb ... -Unpacking ece-ctl (0.12.0) ... -dpkg: warning: parsing file '/var/lib/dpkg/status' near line 1607 package 'ece-ctl': - missing maintainer -Setting up ece-ctl (0.12.0) ... -dpkg: warning: parsing file '/var/lib/dpkg/status' near line 1607 package 'ece-ctl': - missing maintainer ----- - -//// - -[id="{p}-configuring"] -== Configuring - -In order for {p} to be able to communicate with the RESTful API, it needs -to have a set of configuration parameters defined. -These parameters can be set in a configuration file, through environment -variables, or at runtime using the CLI’s global flags. - -[float] -=== Before you begin -The hierarchy for configuration parameters is as follows, from higher precedence to lower: - -. Command line flags `--api-key`, `--region`, `--verbose` -. Environment variables -. Shared configuration file -`$HOME/.ecctl/config.` - -[float] -== Generate a configuration file - -If it’s your first time using {p}, use the `init` command to assist you in generating a configuration file. The resulting configuration file will be saved under `~/.ecctl/config.json`: - -[source] ----- -$ ecctl init -Welcome to Elastic Cloud Control (ecctl)! This command will guide you through authenticating and setting some default values. - -Missing configuration file, would you like to initialise it? [y/n]: y - -Select which type of Elastic Cloud offering you will be working with: - [1] Elasticsearch Service (default). - [2] Elastic Cloud Enterprise (ECE). - [3] Elasticsearch Service Private (ESSP). - -Please enter your choice: 1 - -Using "https://api.elastic-cloud.com" as the API endpoint. - -Select a region you would like to have as default: - - GCP - [1] us-central1 (Iowa) - [2] us-east1 (S. Carolina) - [3] us-east4 (N. Virginia) - [4] us-west1 (Oregon) - [5] northamerica-northeast1 (Montreal) - [6] southamerica-east1 (São Paulo) - [7] australia-southeast1 (Sydney) - [8] europe-west1 (Belgium) - [9] europe-west2 (London) - [10] europe-west3 (Frankfurt) - [11] asia-northeast1 (Tokyo) - [12] asia-south1 (Mumbai) - [13] asia-southeast1 (Singapore) - - AWS - [14] us-east-1 (N. Virginia) - [15] us-west-1 (N. California) - [16] us-west-2 (Oregon) - [17] eu-central-1 (Frankfurt) - [18] eu-west-2 (London) - [19] eu-west-1 (Ireland) - [20] ap-northeast-1 (Tokyo) - [21] ap-southeast-1 (Singapore) - [22] ap-southeast-2 (Sydney) - [23] sa-east-1 (São Paulo) - - Azure - [24] eastus2 (Virginia) - [25] westus2 (Washington) - [26] westeurope (Netherlands) - [27] uksouth (London) - [28] japaneast (Tokyo) - [29] southeastasia (Singapore) - -Please enter your choice: 1 - -Create a new Elasticsearch Service API key (https://cloud.elastic.co/account/keys) and/or -Paste your API Key and press enter: xxxxx - -What default output format would you like? - [1] text - Human-readable output format, commands with no output templates defined will fall back to JSON. - [2] json - JSON formatted output API responses. - -Please enter a choice: 1 - -Your credentials seem to be valid. - -You're all set! Here are some commands to try: - $ ecctl deployment list - -Config written to /home/myuser/.ecctl/config.json ----- - -[id="{p}-authentication"] -=== Authentication - -Elastic Cloud uses API keys to authenticate users against its API. -Additionally, it supports the usage of https://jwt.io/[JWT] to validate -authenticated clients. The preferred authentication method is API keys. - -There are two ways to authenticate against the Elasticsearch Service or the Elastic Cloud Enterprise APIs -{p}: - -* By specifying an API key using the `--api-key` flag -* By specifying the `--user` and `--pass` flags - -The first method requires the user to already have an API key, if this -is the case, all the outgoing API requests will use an Authentication -API key header. - -The second method uses the `user` and `pass` values to obtain a -valid JWT token, that token is then used as the Authentication -Bearer header for every API call. A goroutine that refreshes the token -every minute is started, so that the token doesn’t expire while we’re -performing actions. - -[id="{p}-example-shared-configuration-file"] -=== Example: A shared configuration file - -Below is an example `YAML` configuration file -`$HOME/.ecctl/config.yaml` that will effectively point and configure -the binary for Elastic Cloud: - -[source,yaml] ----- -host: https://api.elastic-cloud.com # URL of your Elasticsearch Service or Elastic Cloud Enterprise API endpoint - -# Credentials -## api_key is the preferred authentication mechanism. -api_key: bWFyYzo4ZTJmNmZkNjY5ZmQ0MDBkOTQ3ZjI3MTg3ZWI5MWZhYjpOQktHY05jclE0cTBzcUlnTXg3QTd3 - -## username and password can be used when no API key is available. -user: username -pass: password ----- - -[id="{p}-environment-variables"] -=== Environment variables - -The same settings can be defined as environment variables instead of a -configuration file or to override certain settings of the `YAML` file. -If setting environment variables, you’ll need to prefix the -configuration parameter with `EC_` and capitalize the setting, -i.e. `EC_HOST` or `EC_USER`. - -[source,sh] ----- -export EC_API_KEY=bWFyYzo4ZTJmNmZkNjY5ZmQ0MDBkOTQ3ZjI3MTg3ZWI5MWZhYjpOQktHY05jclE0cTBzcUlnTXg3QTd3 ----- - -[float] -[id="{p}-special-environment-variables"] -==== Special Environment Variables - -[source,sh] ----- -export EC_CONFIG=$HOME/.ecctl/cloud.yaml ----- - -[id="{p}-multiple-configuration-files"] -=== Multiple configuration files - -{p} supports having multiple configuration files out of the box. -This allows for easy management of multiple environments or specialized -targets. By default it will use -`$HOME/.ecctl/config.`, but when the `--config` -flag is specified, it will append the `--config` name to the file: - -[source] ----- -# Default behaviour -$ ecctl version -# will use ~/.ecctl/config.yaml - -# When an environment is specified, the configuration file used will change -$ ecctl version --config ece -# will use ~/.ecctl/ece.yaml ----- - -[id="{p}-output-format"] -=== Output format - -The `--output` flag allows for the response to be presented in a -particular way (see `ecctl help` for an updated list of allowed -formats). The default formatter behavior is to fallback to `json` when -there’s no _text_ format template or if the formatting fails. - -[id="{p}-custom-formatting"] -=== Custom formatting - -{p} supports a global `--format` flag which can be passed to any -existing command or subcommand. Using the `--format` flag allows you -to obtain a specific part of a command response that might not have been -shown before with the default `--output=text`. The `--format` -internally uses Go templates which means that you can use the power of -the Go built-in -https://golang.org/pkg/text/template/[`text/templates`] on demand. - -[id="{p}-examples"] -== Usage examples - -Once you've <<{p}-installing,installed>> and <<{p}-configuring,configured>> {p} you're ready to take it for a test drive. Try these examples with basic Create, Read, Update and Delete operations using {p}: - -* <<{p}-example-list-deployments,List deploymments>> -* <<{p}-example-create-deployment,Create a deployment>> -* <<{p}-example-update-deployment,Update a deployment>> -* <<{p}-example-delete-deployment,Delete a deployment>> - - -To compare the {p} commands against their API equivalents, see the {cloud}/ec-api-examples.html[API examples]. - - - -[id="{p}-example-list-deployments"] -=== List deployments - -As a first example of using {p}, run the <> command to retrieve information about existing deployments. This is a good way to check if {p} is configured correctly and if you have any deployments already created. - -[source, sh] --- -ecctl deployment list --- - -[source, sh] --- -ID NAME ELASTICSEARCH KIBANA APM APPSEARCH -00be03849b6a49c1a6541e3ccb5958d2 marvin 00be03849b6a49c1a6541e3ccb5958d2 266e456acf257588a9cde6fb4569d4a0 78c096c22e12408b878083b2d5ff6bcf - -147cdeace6404c3e4b5018e1401647e4 biggerdata 147cdeace6404c3e4b5018e1401647e4 443a9df7b33952f45921c5823cbad4bc 4678ce52d45547e463455ede663cb4a4 - --- - -[id="{p}-example-create-deployment"] -=== Create a deployment - -Let's create a basic deployment. Elasticsearch Service supports {cloud}/ec-getting-started-solutions.html[solutions] and {cloud}/ec-getting-started-profiles.html[hardware profiles], which pre-configure the Elastic Stack components in your deployment to best suit your particular use case. For this example, use Google Cloud Platform (GCP) to host the deployment in region `US Central 1 (Iowa)`. To know which deployment options are available by platform, see {cloud}/ec-regions-templates-instances.html[available regions, deployment templates and instance configurations]. - -Copy the following JSON payload and save it as file `create-deployment.json`. - -[source, json] --- -{ - "name": "My first ecctl deployment", - "resources": { - "elasticsearch": [ - { - "region": "gcp-us-central1", <1> - "ref_id": "main-elasticsearch", - "plan": { - "cluster_topology": [ - { - "node_type": { - "master": true, - "data": true, - "ingest": true, - "ml": false - }, - "instance_configuration_id": "gcp.data.highio.1", <2> - "zone_count": 2, <3> - "size": { - "resource": "memory", - "value": 2048 <4> - } - } - ], - "elasticsearch": { - "version": "7.6.0" <5> - }, - "deployment_template": { - "id": "gcp-io-optimized" <6> - } - } - } - ], - "kibana": [ - { - "region": "gcp-us-central1", - "elasticsearch_cluster_ref_id": "main-elasticsearch", - "ref_id": "main-kibana", - "plan": { - "cluster_topology": [ - { - "instance_configuration_id": "gcp.kibana.1", - "zone_count": 1, <7> - "size": { - "resource": "memory", - "value": 1024 <8> - } - } - ], - "kibana": { - "version": "7.6.0" <9> - } - } - } - ], - "apm": [ - { - "region": "gcp-us-central1", - "elasticsearch_cluster_ref_id": "main-elasticsearch", - "ref_id": "main-apm", - "plan": { - "cluster_topology": [ - { - "instance_configuration_id": "gcp.apm.1", - "zone_count": 1, <10> - "size": { - "resource": "memory", - "value": 512 <11> - } - } - ], - "apm": { - "version": "7.6.0" <12> - } - } - } - ] - } -} --- -<1> The region for the Elasticsearch cluster -<2> Instance configuration ID -<3> The number of availability zones for the Elasticsearch cluster -<4> The amount of memory allocated for each Elasticsearch node -<5> The version of the Elasticsearch cluster -<6> The template on which to base the deployment -<7> The number of availability zones for Kibana -<8> The amount of memory allocated for Kibana -<9> The version of the Kibana instance -<10> The number of availability zones for APM -<11> The amount of memory allocated for APM -<12> The version of the APM instance - -This JSON contains the settings for a highly available Elasticsearch cluster deployed across two availability zones, a single instance of Kibana, and a single APM server. - -Run the <> command with `create-deployment.json` as a parameter. For this and other commands, you can add an optional `--track` parameter to monitor the progress. - -[source, sh] --- -ecctl deployment create [--track] -f create-deployment.json --- - -[source, sh] --- -{ - "created": true, - "id": "7229888e7bf8350c7e4d07d7374171c0", - "name": "My first ecctl deployment", - "resources": [ - { - "cloud_id": "My_first_ecctl_deployment:dXMtY2VudHJhbDEuZ2NwLmZvdW5kaXQubm8kYjFlZWVjOGQ0YWVlNGY3ZDgxNTM2Zjc1ZjZhN2Y1MDgkM2ViZTAzNmI0NDhkNDc3Y2E2ZTJjZTQ5NmE4ZDQ5ODA=", - "credentials": { - "password": "REDACTED", - "username": "elastic" - }, - "id": "b1eeec8d4aee4f7d81536f75f6a7f508", - "kind": "elasticsearch", - "ref_id": "main-elasticsearch", - "region": "gcp-us-central1" - }, - { - "elasticsearch_cluster_ref_id": "main-elasticsearch", - "id": "3ebe036b448d477ca6e2ce496a8d4980", - "kind": "kibana", - "ref_id": "main-kibana", - "region": "gcp-us-central1" - }, - { - "elasticsearch_cluster_ref_id": "main-elasticsearch", - "id": "5a03472f6dfe4f17acbe62622823b9cb", - "kind": "apm", - "ref_id": "main-apm", - "region": "gcp-us-central1", - "secret_token": "zfufcfe15eCVJk78b5" - } - ] -} --- - -The response indicates that the request was submitted successfully. It includes the `elastic` user password, which you can use to log in to Kibana or to access the Elasticsearch REST API. Make a note of the deployment ID, which you will use in the next example. - -[id="{p}-example-update-deployment"] -=== Update a deployment - -Now that you have used {p} to create a deployment, you can scale it up, by increasing the size of the Elasticsearch data nodes from 1024 to 4096 MB. - -Copy the following JSON payload and save it as file `update-deployment.json`. - -[source, json] --- -{ - "prune_orphans": false, - "resources": { - "elasticsearch": [ - { - "region": "gcp-us-central1", - "ref_id": "main-elasticsearch", - "plan": { - "cluster_topology": [ - { - "node_type": { - "master": true, - "data": true, - "ingest": true, - "ml": false - }, - "instance_configuration_id": "gcp.data.highio.1", - "zone_count": 2, - "size": { - "resource": "memory", - "value": 4096 - } - } - ], - "elasticsearch": { - "version": "7.6.0" - }, - "deployment_template": { - "id": "gcp-io-optimized" - } - } - } - ] - } -} --- - -The JSON body is similar to what we used to create the deployment, with the following differences: - -- The name of the deployment can be modified or it will stay the same if not specified. -- A `prune_orphans` parameter is added. This important parameter specifies how resources not included in the JSON should be handled: - * if `true`, those resources not included are removed - * if `false`, those resources not included are kept intact - -In this example, prune_orphans is set to `false`, so the Kibana and APM instances are not changed or removed, while the Elasticsearch resource is modified according to the configuration specified in the JSON file. - -To monitor the progress, use the `--track` flag. - -[source, sh] --- -ecctl deployment update [--track] $DEPLOYMENT_ID -f update-deployment.json --- -* `$DEPLOYMENT_ID` is the ID for the deployment that was created in the previous <<{p}-example-create-deployment,create a deployment>> example. - -[source, json] --- -{ - "id": "20e174f6800c55261e4dfcc278b6a004", - "name": "My second ecctl deployment", - "resources": [ - { - "cloud_id": "My_second_ecctl_deployment:dXMtY2VudHJhbDEuZ2NwLmZvdW5kaXQubm8kYjc0OWU2ZWExN2Y4NDg5Yzg4Y2UyOTVjZTA4ZDVjNWUkNTliZWJiYjE3ZmFkNDk2MWEwMmNkMDRmNzYyOWYxMTk=", - "id": "b749e6ea17f8489c88ce295ce08d5c5e", - "kind": "elasticsearch", - "ref_id": "main-elasticsearch", - "region": "gcp-us-central1" - }, - { - "elasticsearch_cluster_ref_id": "main-elasticsearch", - "id": "59bebbb17fad4961a02cd04f7629f119", - "kind": "kibana", - "ref_id": "main-kibana", - "region": "gcp-us-central1" - }, - { - "elasticsearch_cluster_ref_id": "main-elasticsearch", - "id": "1ec19461253c4175a2cea6b3ccc399a8", - "kind": "apm", - "ref_id": "main-apm", - "region": "gcp-us-central1" - } - ] -} --- - -[id="{p}-example-delete-deployment"] -=== Delete a deployment - -In this last example, you can use the <> command to delete the deployment that you created. - -[source, sh] --- -ecctl deployment shutdown [--track] $DEPLOYMENT_ID --- -* `$DEPLOYMENT_ID` is the ID for the deployment that was created in the previous <<{p}-example-create-deployment,create a deployment>> example. - -On running this and other destructive commands, {p} prompts you with a confirmation message. Use the `--force` option to skip the confirmation step, if you are using {p} for automation. - -To monitor the progress, use the `--track` flag. - -To see the different options that {p} supports, run `ecctl `. - - -// NR as per Omer, ecctl elasticsearch is no longer supported (do we need to mention this in the release notes for beta1?) -//// -Obtaining the ID, Version and health status - -[source] ----- -$ ecctl elasticsearch list --format '{{.ClusterID}} {{.PlanInfo.Current.Plan.Elasticsearch.Version}} {{.Healthy}}' -a2c4f423c1014941b75a48292264dd25 6.7.0 true -a4f29ff3ba554e69a1e1b40c3ee1b6e3 6.7.0 true -5e29960763ef496ea8cf6a5371328a6a 6.7.0 true -53023f28d68b4b329d9d913f110709d2 6.7.0 true ----- - -Since the template is executed we can also embed logic inside of the -template to filter the results. - -[source] ----- -$ export EC_FORMAT='{{range .Elasticsearch.DefaultPlugins}}{{if eq . "discovery-file" }}{{$.Version}}{{end}}{{end}}' -# Since the template is executed on every item of the list, filter the empty lines to have a cleaner output. -$ ecctl stack list --format "${EC_FORMAT}" | sed '/^\s*$/d' - - -6.2.3 -$ unset EC_FORMAT ----- -//// - -[id="{p}-command-reference"] -== Command reference - -{n} includes commands to administer: - -* Elastic Stack deployments -* Platform components -* And more - -:leveloffset: +1 -include::ecctl-command-reference-index.adoc[] -:leveloffset: 0 - -[id="{p}-contributing"] -== Contributing - -If you are interested in becoming a part of this project, take a look at link:https://github.com/elastic/ecctl/blob/master/CONTRIBUTING.md[Contributing to ecctl]. - -//// -[id="{p}-release-process"] -== Release Process - -See the link:https://github.com/elastic/ecctl/blob/master/developer_docs/RELEASE.md[release guide]. -//// diff --git a/docs/ecctl-release-notes.asciidoc b/docs/ecctl-release-notes.asciidoc deleted file mode 100644 index 8a6a26df4..000000000 --- a/docs/ecctl-release-notes.asciidoc +++ /dev/null @@ -1,50 +0,0 @@ -[id="{p}-release-notes"] -== Release notes - -This section summarizes the changes in each {n} release. - -* <<{p}-release-notes-v1.14.3>> -* <<{p}-release-notes-v1.14.2>> -* <<{p}-release-notes-v1.14.1>> -* <<{p}-release-notes-v1.14.0>> -* <<{p}-release-notes-v1.13.0>> -* <<{p}-release-notes-v1.12.0>> -* <<{p}-release-notes-v1.11.0>> -* <<{p}-release-notes-v1.10.0>> -* <<{p}-release-notes-v1.9.0>> -* <<{p}-release-notes-v1.8.0>> -* <<{p}-release-notes-v1.7.0>> -* <<{p}-release-notes-v1.6.0>> -* <<{p}-release-notes-v1.5.0>> -* <<{p}-release-notes-v1.4.0>> -* <<{p}-release-notes-v1.3.1>> -* <<{p}-release-notes-v1.3.0>> -* <<{p}-release-notes-v1.2.0>> -* <<{p}-release-notes-v1.1.0>> -* <<{p}-release-notes-v1.0.0>> -* <<{p}-release-notes-v1.0.0-beta3>> -* <<{p}-release-notes-v1.0.0-beta2>> -* <<{p}-release-notes-v1.0.0-beta1>> - -include::release_notes/v1.14.3.adoc[] -include::release_notes/v1.14.2.adoc[] -include::release_notes/v1.14.1.adoc[] -include::release_notes/v1.14.0.adoc[] -include::release_notes/v1.13.0.adoc[] -include::release_notes/v1.12.0.adoc[] -include::release_notes/v1.11.0.adoc[] -include::release_notes/v1.10.0.adoc[] -include::release_notes/v1.9.0.adoc[] -include::release_notes/v1.8.0.adoc[] -include::release_notes/v1.7.0.adoc[] -include::release_notes/v1.6.0.adoc[] -include::release_notes/v1.5.0.adoc[] -include::release_notes/v1.4.0.adoc[] -include::release_notes/v1.3.1.adoc[] -include::release_notes/v1.3.0.adoc[] -include::release_notes/v1.2.0.adoc[] -include::release_notes/v1.1.0.adoc[] -include::release_notes/v1.0.0.adoc[] -include::release_notes/v1.0.0-beta3.adoc[] -include::release_notes/v1.0.0-beta2.adoc[] -include::release_notes/v1.0.0-beta1.adoc[] diff --git a/docs/ecctl.adoc b/docs/ecctl.adoc deleted file mode 100644 index a4e459a75..000000000 --- a/docs/ecctl.adoc +++ /dev/null @@ -1,42 +0,0 @@ -[#ecctl] -== ecctl - -Elastic Cloud Control - -[float] -=== Options - ----- - --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/ (default "config") - --force Do not ask for confirmation - --format string Formats the output using a Go template - -h, --help help for ecctl - --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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_auth[ecctl auth] - Manages authentication settings -* xref:ecctl_comment[ecctl comment] - Manages resource comments {ece-icon} (Available for ECE only) -* 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 {ece-icon} (Available for ECE only) -* xref:ecctl_stack[ecctl stack] - Manages Elastic StackPacks -* xref:ecctl_user[ecctl user] - Manages the platform users {ece-icon} (Available for ECE only) -* xref:ecctl_version[ecctl version] - Shows ecctl version diff --git a/docs/ecctl_auth.adoc b/docs/ecctl_auth.adoc deleted file mode 100644 index 92151badd..000000000 --- a/docs/ecctl_auth.adoc +++ /dev/null @@ -1,45 +0,0 @@ -[#ecctl_auth] -== ecctl auth - -Manages authentication settings - ----- -ecctl auth [flags] ----- - -[float] -=== Options - ----- - -h, --help help for auth ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl[ecctl] - Elastic Cloud Control -* xref:ecctl_auth_key[ecctl auth key] - Manages the current authenticated user API keys diff --git a/docs/ecctl_auth_key.adoc b/docs/ecctl_auth_key.adoc deleted file mode 100644 index a00c6d9d4..000000000 --- a/docs/ecctl_auth_key.adoc +++ /dev/null @@ -1,48 +0,0 @@ -[#ecctl_auth_key] -== ecctl auth key - -Manages the current authenticated user API keys - ----- -ecctl auth key [flags] ----- - -[float] -=== Options - ----- - -h, --help help for key ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_auth[ecctl auth] - Manages authentication settings -* xref:ecctl_auth_key_create[ecctl auth key create] - Creates a new API key for the current authenticated user -* xref:ecctl_auth_key_delete[ecctl auth key delete] - Deletes one or more existing API keys for the specified user -* xref:ecctl_auth_key_list[ecctl auth key list] - Lists the API keys for the current authenticated user -* xref:ecctl_auth_key_show[ecctl auth key show] - Shows the API key details for the current authenticated user diff --git a/docs/ecctl_auth_key_create.adoc b/docs/ecctl_auth_key_create.adoc deleted file mode 100644 index a536fdabe..000000000 --- a/docs/ecctl_auth_key_create.adoc +++ /dev/null @@ -1,45 +0,0 @@ -[#ecctl_auth_key_create] -== ecctl auth key create - -Creates a new API key for the current authenticated user - ----- -ecctl auth key create [flags] ----- - -[float] -=== Options - ----- - --description string User API key description - -h, --help help for create ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_auth_key[ecctl auth key] - Manages the current authenticated user API keys diff --git a/docs/ecctl_auth_key_delete.adoc b/docs/ecctl_auth_key_delete.adoc deleted file mode 100644 index 270aa8e2a..000000000 --- a/docs/ecctl_auth_key_delete.adoc +++ /dev/null @@ -1,44 +0,0 @@ -[#ecctl_auth_key_delete] -== ecctl auth key delete - -Deletes one or more existing API keys for the specified user - ----- -ecctl auth key delete ... [flags] ----- - -[float] -=== Options - ----- - -h, --help help for delete ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_auth_key[ecctl auth key] - Manages the current authenticated user API keys diff --git a/docs/ecctl_auth_key_list.adoc b/docs/ecctl_auth_key_list.adoc deleted file mode 100644 index 190f5d00c..000000000 --- a/docs/ecctl_auth_key_list.adoc +++ /dev/null @@ -1,44 +0,0 @@ -[#ecctl_auth_key_list] -== ecctl auth key list - -Lists the API keys for the current authenticated user - ----- -ecctl auth key list [flags] ----- - -[float] -=== Options - ----- - -h, --help help for list ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_auth_key[ecctl auth key] - Manages the current authenticated user API keys diff --git a/docs/ecctl_auth_key_show.adoc b/docs/ecctl_auth_key_show.adoc deleted file mode 100644 index e30f0b70e..000000000 --- a/docs/ecctl_auth_key_show.adoc +++ /dev/null @@ -1,44 +0,0 @@ -[#ecctl_auth_key_show] -== ecctl auth key show - -Shows the API key details for the current authenticated user - ----- -ecctl auth key show [flags] ----- - -[float] -=== Options - ----- - -h, --help help for show ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_auth_key[ecctl auth key] - Manages the current authenticated user API keys diff --git a/docs/ecctl_comment.adoc b/docs/ecctl_comment.adoc deleted file mode 100644 index 16851367e..000000000 --- a/docs/ecctl_comment.adoc +++ /dev/null @@ -1,49 +0,0 @@ -[#ecctl_comment] -== ecctl comment - -Manages resource comments {ece-icon} (Available for ECE only) - ----- -ecctl comment [flags] ----- - -[float] -=== Options - ----- - -h, --help help for comment ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl[ecctl] - Elastic Cloud Control -* xref:ecctl_comment_create[ecctl comment create] - Creates a new resource comment {ece-icon} (Available for ECE only) -* xref:ecctl_comment_delete[ecctl comment delete] - Deletes a resource comment {ece-icon} (Available for ECE only) -* xref:ecctl_comment_list[ecctl comment list] - Lists all resource comments {ece-icon} (Available for ECE only) -* xref:ecctl_comment_show[ecctl comment show] - Shows information about a resource comment {ece-icon} (Available for ECE only) -* xref:ecctl_comment_update[ecctl comment update] - Updates an existing resource comment {ece-icon} (Available for ECE only) diff --git a/docs/ecctl_comment_create.adoc b/docs/ecctl_comment_create.adoc deleted file mode 100644 index 8b57faacf..000000000 --- a/docs/ecctl_comment_create.adoc +++ /dev/null @@ -1,46 +0,0 @@ -[#ecctl_comment_create] -== ecctl comment create - -Creates a new resource comment {ece-icon} (Available for ECE only) - ----- -ecctl comment create --resource-type --resource-id [flags] ----- - -[float] -=== Options - ----- - -h, --help help for create - --resource-id string ID of the resource that a comment belongs to. - --resource-type string The kind of resource that a comment belongs to. Should be one of [elasticsearch, kibana, apm, appsearch, enterprise_search, allocator, constructor, runner, proxy]. ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_comment[ecctl comment] - Manages resource comments {ece-icon} (Available for ECE only) diff --git a/docs/ecctl_comment_delete.adoc b/docs/ecctl_comment_delete.adoc deleted file mode 100644 index 4fe2856ff..000000000 --- a/docs/ecctl_comment_delete.adoc +++ /dev/null @@ -1,47 +0,0 @@ -[#ecctl_comment_delete] -== ecctl comment delete - -Deletes a resource comment {ece-icon} (Available for ECE only) - ----- -ecctl comment delete --resource-type --resource-id [flags] ----- - -[float] -=== Options - ----- - -h, --help help for delete - --resource-id string ID of the resource that the comment belongs to. - --resource-type string The kind of resource that a comment belongs to. Should be one of [elasticsearch, kibana, apm, appsearch, enterprise_search, allocator, constructor, runner, proxy]. - --version string If specified then checks for conflicts against the version stored in the persistent store. ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_comment[ecctl comment] - Manages resource comments {ece-icon} (Available for ECE only) diff --git a/docs/ecctl_comment_list.adoc b/docs/ecctl_comment_list.adoc deleted file mode 100644 index cd688422f..000000000 --- a/docs/ecctl_comment_list.adoc +++ /dev/null @@ -1,46 +0,0 @@ -[#ecctl_comment_list] -== ecctl comment list - -Lists all resource comments {ece-icon} (Available for ECE only) - ----- -ecctl comment list --resource-type --resource-id [flags] ----- - -[float] -=== Options - ----- - -h, --help help for list - --resource-id string Id of the resource that a comment belongs to. - --resource-type string The kind of resource that a comment belongs to. Should be one of [elasticsearch, kibana, apm, appsearch, enterprise_search, allocator, constructor, runner, proxy]. ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_comment[ecctl comment] - Manages resource comments {ece-icon} (Available for ECE only) diff --git a/docs/ecctl_comment_show.adoc b/docs/ecctl_comment_show.adoc deleted file mode 100644 index f1208c44d..000000000 --- a/docs/ecctl_comment_show.adoc +++ /dev/null @@ -1,46 +0,0 @@ -[#ecctl_comment_show] -== ecctl comment show - -Shows information about a resource comment {ece-icon} (Available for ECE only) - ----- -ecctl comment show --resource-type --resource-id [flags] ----- - -[float] -=== Options - ----- - -h, --help help for show - --resource-id string ID of the resource that the comment belongs to. - --resource-type string The kind of resource that a comment belongs to. Should be one of [elasticsearch, kibana, apm, appsearch, enterprise_search, allocator, constructor, runner, proxy]. ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_comment[ecctl comment] - Manages resource comments {ece-icon} (Available for ECE only) diff --git a/docs/ecctl_comment_update.adoc b/docs/ecctl_comment_update.adoc deleted file mode 100644 index 3d8fe5f5d..000000000 --- a/docs/ecctl_comment_update.adoc +++ /dev/null @@ -1,47 +0,0 @@ -[#ecctl_comment_update] -== ecctl comment update - -Updates an existing resource comment {ece-icon} (Available for ECE only) - ----- -ecctl comment update --resource-type --resource-id [flags] ----- - -[float] -=== Options - ----- - -h, --help help for update - --resource-id string Id of the Resource that a Comment belongs to. - --resource-type string The kind of Resource that a Comment belongs to. Should be one of [elasticsearch, kibana, apm, appsearch, enterprise_search, allocator, constructor, runner, proxy]. - --version string If specified then checks for conflicts against the version stored in the persistent store. ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_comment[ecctl comment] - Manages resource comments {ece-icon} (Available for ECE only) diff --git a/docs/ecctl_deployment.adoc b/docs/ecctl_deployment.adoc deleted file mode 100644 index 7d672aedb..000000000 --- a/docs/ecctl_deployment.adoc +++ /dev/null @@ -1,59 +0,0 @@ -[#ecctl_deployment] -== ecctl deployment - -Manages deployments - ----- -ecctl deployment [flags] ----- - -[float] -=== Options - ----- - -h, --help help for deployment ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl[ecctl] - Elastic Cloud Control -* xref:ecctl_deployment_create[ecctl deployment create] - Creates a deployment -* xref:ecctl_deployment_delete[ecctl deployment delete] - Deletes a previously shutdown deployment {ece-icon} (Available for ECE only) -* xref:ecctl_deployment_elasticsearch[ecctl deployment elasticsearch] - Manages Elasticsearch resources -* xref:ecctl_deployment_extension[ecctl deployment extension] - Manages deployment extensions, such as custom plugins or bundles -* xref:ecctl_deployment_list[ecctl deployment list] - Lists the platform's deployments -* 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 -* xref:ecctl_deployment_template[ecctl deployment template] - Interacts with deployment template APIs -* xref:ecctl_deployment_traffic-filter[ecctl deployment traffic-filter] - Manages traffic filter rulesets -* xref:ecctl_deployment_update[ecctl deployment update] - Updates a deployment from a file definition, allowing certain flag overrides diff --git a/docs/ecctl_deployment.md b/docs/ecctl_deployment.md deleted file mode 100644 index 84820c5f2..000000000 --- a/docs/ecctl_deployment.md +++ /dev/null @@ -1,56 +0,0 @@ -## ecctl deployment - -Manages deployments - -``` -ecctl deployment [flags] -``` - -### Options - -``` - -h, --help help for deployment -``` - -### Options inherited from parent commands - -``` - --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/ (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 - -* [ecctl](ecctl.md) - Elastic Cloud Control -* [ecctl deployment create](ecctl_deployment_create.md) - Creates a deployment -* [ecctl deployment delete](ecctl_deployment_delete.md) - Deletes a previously shutdown deployment (Available for ECE only) -* [ecctl deployment elasticsearch](ecctl_deployment_elasticsearch.md) - Manages Elasticsearch resources -* [ecctl deployment extension](ecctl_deployment_extension.md) - Manages deployment extensions, such as custom plugins or bundles -* [ecctl deployment list](ecctl_deployment_list.md) - Lists the platform's deployments -* [ecctl deployment plan](ecctl_deployment_plan.md) - Manages deployment plans -* [ecctl deployment resource](ecctl_deployment_resource.md) - Manages deployment resources -* [ecctl deployment restore](ecctl_deployment_restore.md) - Restores a previously shut down deployment and all of its associated sub-resources -* [ecctl deployment resync](ecctl_deployment_resync.md) - Resynchronizes the search index and cache for the selected deployment or all -* [ecctl deployment search](ecctl_deployment_search.md) - Performs advanced deployment search using the Elasticsearch Query DSL -* [ecctl deployment show](ecctl_deployment_show.md) - Shows the specified deployment resources -* [ecctl deployment shutdown](ecctl_deployment_shutdown.md) - Shuts down a deployment and all of its associated sub-resources -* [ecctl deployment template](ecctl_deployment_template.md) - Interacts with deployment template APIs -* [ecctl deployment traffic-filter](ecctl_deployment_traffic-filter.md) - Manages traffic filter rulesets -* [ecctl deployment update](ecctl_deployment_update.md) - Updates a deployment from a file definition, allowing certain flag overrides - diff --git a/docs/ecctl_deployment_create.md b/docs/ecctl_deployment_create.md deleted file mode 100644 index fc70ccac3..000000000 --- a/docs/ecctl_deployment_create.md +++ /dev/null @@ -1,92 +0,0 @@ -## ecctl deployment create - -Creates a deployment - -### Synopsis - -Creates a deployment from a file definition or using the defaults from the deployment template. -Default values are provided by the deployment template, simplifying the getting started experience. -When version is not specified, the latest available stack version will automatically be used. -These are the available options: - - * Using the deployment template defaults with --deployment-template= - * Using the deployment template defaults with --deployment-template= and - --generate-payload to use the deployment template, modify certain fields of the definition and - use the --file flag to create the deployment. - * File definition: --file= (shorthand: -f). 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 - -As an option "--generate-payload" can be used in order to obtain the generated payload that would be sent as a request. -Save it, update or extend the topology and create a deployment using the saved payload with the "--file" flag. - -``` -ecctl deployment create {--file | --es-size --es-zones | --es-node-topology } [flags] -``` - -### Examples - -``` -## Create a deployment with the default values -$ ecctl deployment create --name my-deployment --deployment-template=aws-io-optimized-v2 --region=us-east-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. -$ ecctl deployment create --name my-deployment --deployment-template=aws-io-optimized-v2 --region=us-east-1 --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) - -## In order to use the "--deployment-template" flag, you'll need to know which deployment templates ara available to you. -You'll need to run the following command to view your deployment templates: -$ ecctl platform deployment-template list - -## Use the "--generate-payload" flag to save the definition to a file for later use. -$ ecctl deployment create --name my-deployment --version=7.11.2 --generate-payload > create_example.json - -## Create a deployment through the file definition. -$ ecctl deployment create --file create_example.json --track - -## To retry a deployment when the previous deployment creation failed, use the request ID provided in the error response of the previous command: -$ ecctl deployment create --request-id=GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb -``` - -### Options - -``` - --deployment-template string Deployment template ID on which to base the deployment from - -f, --file string DeploymentCreateRequest file definition. See help for more information - --generate-payload Returns the deployment payload without actually creating the deployment resources - -h, --help help for create - --name string Optional name for the deployment - --request-id string Optional request ID - 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 Version to use, if not specified, the latest available stack version will be used -``` - -### Options inherited from parent commands - -``` - --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/ (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 - -* [ecctl deployment](ecctl_deployment.md) - Manages deployments - diff --git a/docs/ecctl_deployment_delete.adoc b/docs/ecctl_deployment_delete.adoc deleted file mode 100644 index 79bebf48f..000000000 --- a/docs/ecctl_deployment_delete.adoc +++ /dev/null @@ -1,44 +0,0 @@ -[#ecctl_deployment_delete] -== ecctl deployment delete - -Deletes a previously shutdown deployment {ece-icon} (Available for ECE only) - ----- -ecctl deployment delete [flags] ----- - -[float] -=== Options - ----- - -h, --help help for delete ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments diff --git a/docs/ecctl_deployment_elasticsearch.adoc b/docs/ecctl_deployment_elasticsearch.adoc deleted file mode 100644 index 5100fe206..000000000 --- a/docs/ecctl_deployment_elasticsearch.adoc +++ /dev/null @@ -1,45 +0,0 @@ -[#ecctl_deployment_elasticsearch] -== ecctl deployment elasticsearch - -Manages Elasticsearch resources - ----- -ecctl deployment elasticsearch [flags] ----- - -[float] -=== Options - ----- - -h, --help help for elasticsearch ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments -* xref:ecctl_deployment_elasticsearch_keystore[ecctl deployment elasticsearch keystore] - Manages Elasticsearch resource keystores diff --git a/docs/ecctl_deployment_elasticsearch_keystore.adoc b/docs/ecctl_deployment_elasticsearch_keystore.adoc deleted file mode 100644 index 1b6d3cbef..000000000 --- a/docs/ecctl_deployment_elasticsearch_keystore.adoc +++ /dev/null @@ -1,46 +0,0 @@ -[#ecctl_deployment_elasticsearch_keystore] -== ecctl deployment elasticsearch keystore - -Manages Elasticsearch resource keystores - ----- -ecctl deployment elasticsearch keystore [flags] ----- - -[float] -=== Options - ----- - -h, --help help for keystore ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_elasticsearch[ecctl deployment elasticsearch] - Manages Elasticsearch resources -* xref:ecctl_deployment_elasticsearch_keystore_show[ecctl deployment elasticsearch keystore show] - Shows the settings from the Elasticsearch resource keystore -* xref:ecctl_deployment_elasticsearch_keystore_update[ecctl deployment elasticsearch keystore update] - Updates the contents of an Elasticsearch keystore diff --git a/docs/ecctl_deployment_elasticsearch_keystore_show.adoc b/docs/ecctl_deployment_elasticsearch_keystore_show.adoc deleted file mode 100644 index 9109c13c2..000000000 --- a/docs/ecctl_deployment_elasticsearch_keystore_show.adoc +++ /dev/null @@ -1,45 +0,0 @@ -[#ecctl_deployment_elasticsearch_keystore_show] -== ecctl deployment elasticsearch keystore show - -Shows the settings from the Elasticsearch resource keystore - ----- -ecctl deployment elasticsearch keystore show [--ref-id ] [flags] ----- - -[float] -=== Options - ----- - -h, --help help for show - --ref-id string Optional ref_id to use for the Elasticsearch resource, auto-discovered if not specified. ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_elasticsearch_keystore[ecctl deployment elasticsearch keystore] - Manages Elasticsearch resource keystores diff --git a/docs/ecctl_deployment_elasticsearch_keystore_update.adoc b/docs/ecctl_deployment_elasticsearch_keystore_update.adoc deleted file mode 100644 index 7b828a500..000000000 --- a/docs/ecctl_deployment_elasticsearch_keystore_update.adoc +++ /dev/null @@ -1,100 +0,0 @@ -[#ecctl_deployment_elasticsearch_keystore_update] -== ecctl deployment elasticsearch keystore update - -Updates the contents of an Elasticsearch keystore - -[float] -=== Synopsis - -Changes the contents of the Elasticsearch resource keystore from the specified -deployment by using the PATCH method. The payload is a partial payload where any -omitted current keystore items are not removed, unless the secrets are set to "null": -{"secrets": {"my-secret": null}}. - -The contents of the specified file should be formatted to match the Elasticsearch Service -API "KeystoreContents" model. - ----- -ecctl deployment elasticsearch keystore update [--ref-id ] {--file=.json} [flags] ----- - -[float] -=== Examples - ----- -# Set credentials for a GCS snapshot repository -$ cat gcs-creds.json -{ - "secrets": { - "gcs.client.default.credentials_file": { - "as_file": true, - "value": { - "type": "service_account", - "project_id": "project-id", - "private_key_id": "key-id", - "private_key": "-----BEGIN PRIVATE KEY-----\nprivate-key\n-----END PRIVATE KEY-----\n", - "client_email": "service-account-email", - "client_id": "client-id", - "auth_uri": "https://accounts.google.com/o/oauth2/auth", - "token_uri": "https://accounts.google.com/o/oauth2/token", - "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", - "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service-account-email" - } - } - } -} -$ ecctl deployment elasticsearch keystore set --file=gcs-creds.json -... -# Set multiple secrets in one playload -$ cat multiple.json -{ - "secrets": { - "my-secret": { - "value": "my-value" - }, - "my-other-secret": { - "value": "my-other-value" - } - } -} -$ ecctl deployment elasticsearch keystore set --file=multiple.json -... ----- - -[float] -=== Options - ----- - -f, --file string Required json formatted file path with the keystore secret contents. - -h, --help help for update - --ref-id string Optional ref_id to use for the Elasticsearch resource, auto-discovered if not specified. ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_elasticsearch_keystore[ecctl deployment elasticsearch keystore] - Manages Elasticsearch resource keystores diff --git a/docs/ecctl_deployment_extension.adoc b/docs/ecctl_deployment_extension.adoc deleted file mode 100644 index 6506d5391..000000000 --- a/docs/ecctl_deployment_extension.adoc +++ /dev/null @@ -1,49 +0,0 @@ -[#ecctl_deployment_extension] -== ecctl deployment extension - -Manages deployment extensions, such as custom plugins or bundles - ----- -ecctl deployment extension [flags] ----- - -[float] -=== Options - ----- - -h, --help help for extension ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments -* xref:ecctl_deployment_extension_create[ecctl deployment extension create] - Creates an extension -* xref:ecctl_deployment_extension_delete[ecctl deployment extension delete] - Deletes a deployment extension -* xref:ecctl_deployment_extension_list[ecctl deployment extension list] - Lists all deployment extensions -* xref:ecctl_deployment_extension_show[ecctl deployment extension show] - Shows information about a deployment extension -* xref:ecctl_deployment_extension_update[ecctl deployment extension update] - Updates an extension diff --git a/docs/ecctl_deployment_extension_create.adoc b/docs/ecctl_deployment_extension_create.adoc deleted file mode 100644 index 38d0e3fdd..000000000 --- a/docs/ecctl_deployment_extension_create.adoc +++ /dev/null @@ -1,49 +0,0 @@ -[#ecctl_deployment_extension_create] -== ecctl deployment extension create - -Creates an extension - ----- -ecctl deployment extension create --version --type {--file | --download-url } [--description ] [flags] ----- - -[float] -=== Options - ----- - --description string Optional flag to add a description to the extension. - --download-url string Optional flag to define the URL to download the extension archive. - --file string Optional flag to upload an extension from a local file path. - -h, --help help for create - --type string Extension type. Can be one of [bundle, plugin]. - --version string Elastic stack version. Numeric version for plugins, e.g. 7.10.0. Major version e.g. 7.*, or wildcards e.g. * for bundles. ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_extension[ecctl deployment extension] - Manages deployment extensions, such as custom plugins or bundles diff --git a/docs/ecctl_deployment_extension_delete.adoc b/docs/ecctl_deployment_extension_delete.adoc deleted file mode 100644 index 430771236..000000000 --- a/docs/ecctl_deployment_extension_delete.adoc +++ /dev/null @@ -1,44 +0,0 @@ -[#ecctl_deployment_extension_delete] -== ecctl deployment extension delete - -Deletes a deployment extension - ----- -ecctl deployment extension delete [flags] ----- - -[float] -=== Options - ----- - -h, --help help for delete ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_extension[ecctl deployment extension] - Manages deployment extensions, such as custom plugins or bundles diff --git a/docs/ecctl_deployment_extension_list.adoc b/docs/ecctl_deployment_extension_list.adoc deleted file mode 100644 index 402580f9f..000000000 --- a/docs/ecctl_deployment_extension_list.adoc +++ /dev/null @@ -1,44 +0,0 @@ -[#ecctl_deployment_extension_list] -== ecctl deployment extension list - -Lists all deployment extensions - ----- -ecctl deployment extension list [flags] ----- - -[float] -=== Options - ----- - -h, --help help for list ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_extension[ecctl deployment extension] - Manages deployment extensions, such as custom plugins or bundles diff --git a/docs/ecctl_deployment_extension_show.adoc b/docs/ecctl_deployment_extension_show.adoc deleted file mode 100644 index 86c9cab5f..000000000 --- a/docs/ecctl_deployment_extension_show.adoc +++ /dev/null @@ -1,45 +0,0 @@ -[#ecctl_deployment_extension_show] -== ecctl deployment extension show - -Shows information about a deployment extension - ----- -ecctl deployment extension show [--include-deployments] [flags] ----- - -[float] -=== Options - ----- - -h, --help help for show - --include-deployments Include deployments referencing this extension. Up to only 10000 deployments will be included. ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_extension[ecctl deployment extension] - Manages deployment extensions, such as custom plugins or bundles diff --git a/docs/ecctl_deployment_extension_update.adoc b/docs/ecctl_deployment_extension_update.adoc deleted file mode 100644 index e321c8e16..000000000 --- a/docs/ecctl_deployment_extension_update.adoc +++ /dev/null @@ -1,62 +0,0 @@ -[#ecctl_deployment_extension_update] -== ecctl deployment extension update - -Updates an extension - ----- -ecctl deployment extension update {--file | --generate-payload} [--extension-file ] [flags] ----- - -[float] -=== Examples - ----- - -* Return the current extension state as a valid update payload. - ecctl deployment extension update --generate-payload > update.json - -* After editing the file with your new values pass it as an argument to the --file flag. - ecctl deployment extension update --file update.json - -* The extensions uploaded from a local file will remain unchanged unless the --extension-file flag is used. - ecctl deployment extension update --file update.json --extension-file extension.zip ----- - -[float] -=== Options - ----- - --extension-file string Optional flag to upload an extension from a local file path. - --file string Path to the file containing the update JSON definition. - --generate-payload Outputs JSON which can be used as an argument for the --file flag. - -h, --help help for update ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_extension[ecctl deployment extension] - Manages deployment extensions, such as custom plugins or bundles diff --git a/docs/ecctl_deployment_list.adoc b/docs/ecctl_deployment_list.adoc deleted file mode 100644 index 3a6ce81ea..000000000 --- a/docs/ecctl_deployment_list.adoc +++ /dev/null @@ -1,44 +0,0 @@ -[#ecctl_deployment_list] -== ecctl deployment list - -Lists the platform's deployments - ----- -ecctl deployment list [flags] ----- - -[float] -=== Options - ----- - -h, --help help for list ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments diff --git a/docs/ecctl_deployment_plan.adoc b/docs/ecctl_deployment_plan.adoc deleted file mode 100644 index eea3d67fc..000000000 --- a/docs/ecctl_deployment_plan.adoc +++ /dev/null @@ -1,45 +0,0 @@ -[#ecctl_deployment_plan] -== ecctl deployment plan - -Manages deployment plans - ----- -ecctl deployment plan [flags] ----- - -[float] -=== Options - ----- - -h, --help help for plan ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments -* xref:ecctl_deployment_plan_cancel[ecctl deployment plan cancel] - Cancels a resource's pending plan diff --git a/docs/ecctl_deployment_plan_cancel.adoc b/docs/ecctl_deployment_plan_cancel.adoc deleted file mode 100644 index 381630418..000000000 --- a/docs/ecctl_deployment_plan_cancel.adoc +++ /dev/null @@ -1,46 +0,0 @@ -[#ecctl_deployment_plan_cancel] -== ecctl deployment plan cancel - -Cancels a resource's pending plan - ----- -ecctl deployment plan cancel --kind [--ref-id ] [flags] ----- - -[float] -=== Options - ----- - -h, --help help for cancel - --kind string Required deployment resource kind (apm, appsearch, kibana, elasticsearch) - --ref-id string Optional deployment RefId, if not set, the RefId will be auto-discovered ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_plan[ecctl deployment plan] - Manages deployment plans diff --git a/docs/ecctl_deployment_resource.adoc b/docs/ecctl_deployment_resource.adoc deleted file mode 100644 index 1a01cfd44..000000000 --- a/docs/ecctl_deployment_resource.adoc +++ /dev/null @@ -1,52 +0,0 @@ -[#ecctl_deployment_resource] -== ecctl deployment resource - -Manages deployment resources - ----- -ecctl deployment resource [flags] ----- - -[float] -=== Options - ----- - -h, --help help for resource ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments -* xref:ecctl_deployment_resource_delete[ecctl deployment resource delete] - Deletes a previously shut down deployment resource -* xref:ecctl_deployment_resource_restore[ecctl deployment resource restore] - Restores a previously shut down deployment resource -* xref:ecctl_deployment_resource_shutdown[ecctl deployment resource shutdown] - Shuts down a deployment resource by its kind and ref-id -* xref:ecctl_deployment_resource_start[ecctl deployment resource start] - Starts a previously stopped deployment resource -* xref:ecctl_deployment_resource_start-maintenance[ecctl deployment resource start-maintenance] - Starts maintenance mode on a deployment resource -* xref:ecctl_deployment_resource_stop[ecctl deployment resource stop] - Stops a deployment resource -* xref:ecctl_deployment_resource_stop-maintenance[ecctl deployment resource stop-maintenance] - Stops maintenance mode on a deployment resource -* xref:ecctl_deployment_resource_upgrade[ecctl deployment resource upgrade] - Upgrades a deployment resource diff --git a/docs/ecctl_deployment_resource_delete.adoc b/docs/ecctl_deployment_resource_delete.adoc deleted file mode 100644 index 5d35cc2bd..000000000 --- a/docs/ecctl_deployment_resource_delete.adoc +++ /dev/null @@ -1,46 +0,0 @@ -[#ecctl_deployment_resource_delete] -== ecctl deployment resource delete - -Deletes a previously shut down deployment resource - ----- -ecctl deployment resource delete --kind --ref-id [flags] ----- - -[float] -=== Options - ----- - -h, --help help for delete - --kind string Required stateless deployment resource kind (apm, appsearch, kibana) - --ref-id string Optional deployment RefId, auto-discovered if not specified ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_resource[ecctl deployment resource] - Manages deployment resources diff --git a/docs/ecctl_deployment_resource_restore.adoc b/docs/ecctl_deployment_resource_restore.adoc deleted file mode 100644 index 90c9120bc..000000000 --- a/docs/ecctl_deployment_resource_restore.adoc +++ /dev/null @@ -1,47 +0,0 @@ -[#ecctl_deployment_resource_restore] -== ecctl deployment resource restore - -Restores a previously shut down deployment resource - ----- -ecctl deployment resource restore --kind --ref-id [flags] ----- - -[float] -=== Options - ----- - -h, --help help for restore - --kind string Required deployment resource kind (apm, appsearch, kibana, elasticsearch) - --ref-id string Optional deployment RefId, auto-discovered if not specified - --restore-snapshot Optional flag to toggle restoring a snapshot for an Elasticsearch resource. It has no effect for other resources ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_resource[ecctl deployment resource] - Manages deployment resources diff --git a/docs/ecctl_deployment_resource_shutdown.adoc b/docs/ecctl_deployment_resource_shutdown.adoc deleted file mode 100644 index cd38f23ba..000000000 --- a/docs/ecctl_deployment_resource_shutdown.adoc +++ /dev/null @@ -1,54 +0,0 @@ -[#ecctl_deployment_resource_shutdown] -== ecctl deployment resource shutdown - -Shuts down a deployment resource by its kind and ref-id - -[float] -=== Synopsis - -Shuts down a deployment resource kind (APM, Appsearch, Elasticsearch, Kibana). Shutting down a -kind doesn't necessarily shut down the deployment itself but rather a specific resource. - ----- -ecctl deployment resource shutdown --kind --ref-id [flags] ----- - -[float] -=== Options - ----- - -h, --help help for shutdown - --hide Optionally hides the deployment resource from being listed by default - --kind string Required deployment resource kind (apm, appsearch, kibana, elasticsearch) - --ref-id string Optional deployment RefId, auto-discovered if not specified - --skip-snapshot Optional flag to toggle skipping the resource snapshot before shutting it down ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_resource[ecctl deployment resource] - Manages deployment resources diff --git a/docs/ecctl_deployment_resource_start-maintenance.adoc b/docs/ecctl_deployment_resource_start-maintenance.adoc deleted file mode 100644 index 7a80dfe02..000000000 --- a/docs/ecctl_deployment_resource_start-maintenance.adoc +++ /dev/null @@ -1,49 +0,0 @@ -[#ecctl_deployment_resource_start-maintenance] -== ecctl deployment resource start-maintenance - -Starts maintenance mode on a deployment resource - ----- -ecctl deployment resource start-maintenance --kind [--all|--i ,] [flags] ----- - -[float] -=== Options - ----- - --all Starts maintenance mode on all instances of a defined resource kind - -h, --help help for start-maintenance - --ignore-missing If set and the specified instance does not exist, then quietly proceed to the next instance - -i, --instance-id strings Deployment instance IDs to use (e.g. instance-0000000001) - --kind string Required deployment resource kind (apm, appsearch, kibana, elasticsearch) - --ref-id string Optional deployment RefId, if not set, the RefId will be auto-discovered ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_resource[ecctl deployment resource] - Manages deployment resources diff --git a/docs/ecctl_deployment_resource_start.adoc b/docs/ecctl_deployment_resource_start.adoc deleted file mode 100644 index c5b03bb8b..000000000 --- a/docs/ecctl_deployment_resource_start.adoc +++ /dev/null @@ -1,49 +0,0 @@ -[#ecctl_deployment_resource_start] -== ecctl deployment resource start - -Starts a previously stopped deployment resource - ----- -ecctl deployment resource start --kind [--all|--i ,] [flags] ----- - -[float] -=== Options - ----- - --all Starts all instances of a defined resource kind - -h, --help help for start - --ignore-missing If set and the specified instance does not exist, then quietly proceed to the next instance - -i, --instance-id strings Deployment instance IDs to start (e.g. instance-0000000001) - --kind string Required deployment resource kind (apm, appsearch, kibana, elasticsearch) - --ref-id string Optional deployment RefId, if not set, the RefId will be auto-discovered ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_resource[ecctl deployment resource] - Manages deployment resources diff --git a/docs/ecctl_deployment_resource_stop-maintenance.adoc b/docs/ecctl_deployment_resource_stop-maintenance.adoc deleted file mode 100644 index b9a93faee..000000000 --- a/docs/ecctl_deployment_resource_stop-maintenance.adoc +++ /dev/null @@ -1,49 +0,0 @@ -[#ecctl_deployment_resource_stop-maintenance] -== ecctl deployment resource stop-maintenance - -Stops maintenance mode on a deployment resource - ----- -ecctl deployment resource stop-maintenance --kind [--all|--i ,] [flags] ----- - -[float] -=== Options - ----- - --all Stops maintenance mode on all instances of a defined resource kind - -h, --help help for stop-maintenance - --ignore-missing If set and the specified instance does not exist, then quietly proceed to the next instance - -i, --instance-id strings Deployment instance IDs to use (e.g. instance-0000000001) - --kind string Required deployment resource kind (apm, appsearch, kibana, elasticsearch) - --ref-id string Optional deployment RefId, if not set, the RefId will be auto-discovered ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_resource[ecctl deployment resource] - Manages deployment resources diff --git a/docs/ecctl_deployment_resource_stop.adoc b/docs/ecctl_deployment_resource_stop.adoc deleted file mode 100644 index 993c1f615..000000000 --- a/docs/ecctl_deployment_resource_stop.adoc +++ /dev/null @@ -1,49 +0,0 @@ -[#ecctl_deployment_resource_stop] -== ecctl deployment resource stop - -Stops a deployment resource - ----- -ecctl deployment resource stop --kind [--all|--i ,] [flags] ----- - -[float] -=== Options - ----- - --all Stops all instances of a defined resource kind - -h, --help help for stop - --ignore-missing If set and the specified instance does not exist, then quietly proceed to the next instance - -i, --instance-id strings Deployment instance IDs to stop (e.g. instance-0000000001) - --kind string Required deployment resource kind (apm, appsearch, kibana, elasticsearch) - --ref-id string Optional deployment RefId, if not set, the RefId will be auto-discovered ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_resource[ecctl deployment resource] - Manages deployment resources diff --git a/docs/ecctl_deployment_resource_upgrade.adoc b/docs/ecctl_deployment_resource_upgrade.adoc deleted file mode 100644 index b7767f4f6..000000000 --- a/docs/ecctl_deployment_resource_upgrade.adoc +++ /dev/null @@ -1,53 +0,0 @@ -[#ecctl_deployment_resource_upgrade] -== ecctl deployment resource upgrade - -Upgrades a deployment resource - -[float] -=== Synopsis - -Upgrades a stateless deployment resource so it matches the Elasticsearch -deployment version. Only stateless resources are supported in the --kind flag - ----- -ecctl deployment resource upgrade --kind --ref-id [flags] ----- - -[float] -=== Options - ----- - -h, --help help for upgrade - --kind string Required deployment resource kind (apm, appsearch, kibana, elasticsearch) - --ref-id string Optional deployment RefId, if not set, the RefId will be auto-discovered - -t, --track Tracks the progress of the performed task ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_resource[ecctl deployment resource] - Manages deployment resources diff --git a/docs/ecctl_deployment_restore.adoc b/docs/ecctl_deployment_restore.adoc deleted file mode 100644 index f51b38dab..000000000 --- a/docs/ecctl_deployment_restore.adoc +++ /dev/null @@ -1,58 +0,0 @@ -[#ecctl_deployment_restore] -== ecctl deployment restore - -Restores a previously shut down deployment and all of its associated sub-resources - -[float] -=== Synopsis - -Use --restore-snapshot to automatically restore the latest available Elasticsearch snapshot (if applicable) - ----- -ecctl deployment restore [flags] ----- - -[float] -=== Examples - - $ ecctl deployment restore 5c17ad7c8df73206baa54b6e2829d9bc - { - "id": "5c17ad7c8df73206baa54b6e2829d9bc" - } - -[float] -=== Options - ----- - -h, --help help for restore - --restore-snapshot Restores snapshots for those resources that allow it (Elasticsearch) ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments diff --git a/docs/ecctl_deployment_resync.adoc b/docs/ecctl_deployment_resync.adoc deleted file mode 100644 index 868a86956..000000000 --- a/docs/ecctl_deployment_resync.adoc +++ /dev/null @@ -1,45 +0,0 @@ -[#ecctl_deployment_resync] -== ecctl deployment resync - -Resynchronizes the search index and cache for the selected deployment or all - ----- -ecctl deployment resync { | --all} [flags] ----- - -[float] -=== Options - ----- - --all Resynchronizes the search index for all deployments - -h, --help help for resync ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments diff --git a/docs/ecctl_deployment_search.adoc b/docs/ecctl_deployment_search.adoc deleted file mode 100644 index b3fa8dbec..000000000 --- a/docs/ecctl_deployment_search.adoc +++ /dev/null @@ -1,66 +0,0 @@ -[#ecctl_deployment_search] -== ecctl deployment search - -Performs advanced deployment search using the Elasticsearch Query DSL - -[float] -=== Synopsis - -Read more about Query DSL in https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html - ----- -ecctl deployment search -f [flags] ----- - -[float] -=== Examples - - $ cat query_string_query.json - { - "query": { - "query_string": { - "query": "name: admin" - } - } - } - $ ecctl deployment search -f query_string_query.json - [...] - -[float] -=== Options - ----- - -a, --all-matches Uses a cursor to return all matches of the query (ignoring the size in the query). This can be used to query more than 10k results. - -f, --file string JSON file that contains JSON-style domain-specific language query - -h, --help help for search - --size int32 Defines the size per request when using the --all-matches option. (default 500) ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments diff --git a/docs/ecctl_deployment_show.adoc b/docs/ecctl_deployment_show.adoc deleted file mode 100644 index 305766b84..000000000 --- a/docs/ecctl_deployment_show.adoc +++ /dev/null @@ -1,69 +0,0 @@ -[#ecctl_deployment_show] -== ecctl deployment show - -Shows the specified deployment resources - ----- -ecctl deployment show [flags] ----- - -[float] -=== Examples - ----- - -* Shows kibana resource information from a given deployment: - ecctl deployment show --kind kibana - -* Shows apm resource information from a given deployment with a specified ref-id. - ecctl deployment show --kind apm --ref-id apm-server - -* Return the current deployment state as a valid update payload. - ecctl deployment show --generate-update-payload > update.json ----- - -[float] -=== Options - ----- - --clear-transient Removes the transient field in order to make read - edit - write loop safer. The default value of clear-transient depends on the value of generate-update-payload. If generate-update-payload is true then clear-transient defaults to true. Otherwise defaults to false. - --generate-update-payload Outputs JSON which can be used as an argument for the --file flag with the update command. - -h, --help help for show - --kind string Optional deployment resource kind (apm, appsearch, kibana, elasticsearch) - -m, --metadata Shows the deployment metadata - --plan-defaults Shows the deployment plan defaults - --plan-history Shows the deployment plan history - --plan-logs Shows the deployment plan logs - --plans Shows the deployment plans - --ref-id string Optional deployment kind RefId, if not set, the RefId will be auto-discovered - -s, --settings Shows the deployment settings ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments diff --git a/docs/ecctl_deployment_shutdown.adoc b/docs/ecctl_deployment_shutdown.adoc deleted file mode 100644 index d1d7846d9..000000000 --- a/docs/ecctl_deployment_shutdown.adoc +++ /dev/null @@ -1,46 +0,0 @@ -[#ecctl_deployment_shutdown] -== ecctl deployment shutdown - -Shuts down a deployment and all of its associated sub-resources - ----- -ecctl deployment shutdown [flags] ----- - -[float] -=== Options - ----- - -h, --help help for shutdown - --skip-snapshot Skips taking an Elasticsearch snapshot prior to shutting down the deployment - -t, --track Tracks the progress of the performed task ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments diff --git a/docs/ecctl_deployment_template.adoc b/docs/ecctl_deployment_template.adoc deleted file mode 100644 index c124838b9..000000000 --- a/docs/ecctl_deployment_template.adoc +++ /dev/null @@ -1,49 +0,0 @@ -[#ecctl_deployment_template] -== ecctl deployment template - -Interacts with deployment template APIs - ----- -ecctl deployment template [flags] ----- - -[float] -=== Options - ----- - -h, --help help for template ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment[ecctl deployment] - Manages deployments -* xref:ecctl_deployment_template_create[ecctl deployment template create] - Creates a new deployment template {ece-icon} (Available for ECE only) -* xref:ecctl_deployment_template_delete[ecctl deployment template delete] - Deletes an existing deployment template {ece-icon} (Available for ECE only) -* xref:ecctl_deployment_template_list[ecctl deployment template list] - Lists deployment templates -* xref:ecctl_deployment_template_show[ecctl deployment template show] - Displays a deployment template {ece-icon} (Available for ECE only) -* xref:ecctl_deployment_template_update[ecctl deployment template update] - Updates an existing deployment template {ece-icon} (Available for ECE only) diff --git a/docs/ecctl_deployment_template_create.adoc b/docs/ecctl_deployment_template_create.adoc deleted file mode 100644 index 6c59e757d..000000000 --- a/docs/ecctl_deployment_template_create.adoc +++ /dev/null @@ -1,47 +0,0 @@ -[#ecctl_deployment_template_create] -== ecctl deployment template create - -Creates a new deployment template {ece-icon} (Available for ECE only) - ----- -ecctl deployment template create --file [flags] ----- - -[float] -=== Options - ----- - -f, --file string Deployment template definition. - -h, --help help for create - --hide-instance-configurations Hides instance configurations - only visible when using the JSON output. - --template-id string Optional deployment template ID. Otherwise the deployment template will be created with an auto-generated ID. ----- - -[float] -=== Options inherited from parent commands - ----- - --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/ (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 ----- - -[float] -=== SEE ALSO - -* xref:ecctl_deployment_template[ecctl deployment template] - Interacts with deployment template APIs diff --git a/docs/ecctl_deployment_template_delete.adoc b/docs/ecctl_deployment_template_delete.adoc deleted file mode 100644 index b5964cd8b..000000000 --- a/docs/ecctl_deployment_template_delete.adoc +++ /dev/null @@ -1,45 +0,0 @@ -[#ecctl_deployment_template_delete] -== ecctl deployment template delete - -Deletes an existing deployment template {ece-icon} (Available for ECE only) - ----- -ecctl deployment template delete --template-id