mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 17:34:17 -04:00
[DOCS] Clean up Asciidoc links in markdown files (#125046)
This commit is contained in:
Lisa Cawley
GitHub
parent
fbf4580369
commit
ec0f8be34d
6 changed files with 82 additions and 861 deletions
542
docs/docset.yml
542
docs/docset.yml
|
|
@ -26,483 +26,81 @@ toc:
|
||||||
- toc: release-notes
|
- toc: release-notes
|
||||||
- toc: extend
|
- toc: extend
|
||||||
subs:
|
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"
|
|
||||||
ech: "Elastic Cloud Hosted"
|
|
||||||
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-request-title: "Request"
|
||||||
api-prereq-title: "Prerequisites"
|
api-prereq-title: "Prerequisites"
|
||||||
api-description-title: "Description"
|
api-description-title: "Description"
|
||||||
api-path-parms-title: "Path parameters"
|
api-path-parms-title: "Path parameters"
|
||||||
api-query-parms-title: "Query parameters"
|
api-query-parms-title: "Query parameters"
|
||||||
api-request-body-title: "Request body"
|
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-examples-title: "Examples"
|
||||||
api-definitions-title: "Properties"
|
ecloud: "Elastic Cloud"
|
||||||
multi-arg: "†footnoteref:[multi-arg,This parameter accepts multiple arguments.]"
|
ess: "Elasticsearch Service"
|
||||||
multi-arg-ref: "†footnoteref:[multi-arg]"
|
ece: "Elastic Cloud Enterprise"
|
||||||
yes-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png[Yes,20,15]"
|
eck: "Elastic Cloud on Kubernetes"
|
||||||
no-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png[No,20,15]"
|
ech: "Elastic Cloud Hosted"
|
||||||
es-repo: "https://github.com/elastic/elasticsearch/"
|
|
||||||
es-issue: "https://github.com/elastic/elasticsearch/issues/"
|
es-issue: "https://github.com/elastic/elasticsearch/issues/"
|
||||||
es-pull: "https://github.com/elastic/elasticsearch/pull/"
|
serverless-full: "Elastic Cloud Serverless"
|
||||||
es-commit: "https://github.com/elastic/elasticsearch/commit/"
|
serverless-short: "Serverless"
|
||||||
kib-repo: "https://github.com/elastic/kibana/"
|
es-serverless: "Elasticsearch Serverless"
|
||||||
kib-issue: "https://github.com/elastic/kibana/issues/"
|
ess-utm-params: "?page=docs&placement=docs-body"
|
||||||
kibana-issue: "'{kib-repo}issues/'"
|
cloud-only: "This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported."
|
||||||
kib-pull: "https://github.com/elastic/kibana/pull/"
|
security-app: "Elastic Security app"
|
||||||
kibana-pull: "'{kib-repo}pull/'"
|
stack-monitor-app: "Stack Monitoring"
|
||||||
kib-commit: "https://github.com/elastic/kibana/commit/"
|
agent: "Elastic Agent"
|
||||||
ml-repo: "https://github.com/elastic/ml-cpp/"
|
fleet: "Fleet"
|
||||||
ml-issue: "https://github.com/elastic/ml-cpp/issues/"
|
stack: "Elastic Stack"
|
||||||
ml-pull: "https://github.com/elastic/ml-cpp/pull/"
|
xpack: "X-Pack"
|
||||||
ml-commit: "https://github.com/elastic/ml-cpp/commit/"
|
es: "Elasticsearch"
|
||||||
apm-repo: "https://github.com/elastic/apm-server/"
|
kib: "Kibana"
|
||||||
apm-issue: "https://github.com/elastic/apm-server/issues/"
|
ls: "Logstash"
|
||||||
apm-pull: "https://github.com/elastic/apm-server/pull/"
|
beats: "Beats"
|
||||||
kibana-blob: "https://github.com/elastic/kibana/blob/current/"
|
filebeat: "Filebeat"
|
||||||
apm-get-started-ref: "https://www.elastic.co/guide/en/apm/get-started/current"
|
metricbeat: "Metricbeat"
|
||||||
apm-server-ref: "https://www.elastic.co/guide/en/apm/server/current"
|
es-sql: "Elasticsearch SQL"
|
||||||
apm-server-ref-v: "https://www.elastic.co/guide/en/apm/server/current"
|
esql: "ES|QL"
|
||||||
apm-server-ref-m: "https://www.elastic.co/guide/en/apm/server/master"
|
security-features: "security features"
|
||||||
apm-server-ref-62: "https://www.elastic.co/guide/en/apm/server/6.2"
|
operator-feature: "operator privileges feature"
|
||||||
apm-server-ref-64: "https://www.elastic.co/guide/en/apm/server/6.4"
|
stack-security-features: "Elastic Stack security features"
|
||||||
apm-server-ref-70: "https://www.elastic.co/guide/en/apm/server/7.0"
|
monitoring: "X-Pack monitoring"
|
||||||
apm-overview-ref-v: "https://www.elastic.co/guide/en/apm/get-started/current"
|
monitor-features: "monitoring features"
|
||||||
apm-overview-ref-70: "https://www.elastic.co/guide/en/apm/get-started/7.0"
|
stack-monitor-features: "Elastic Stack monitoring features"
|
||||||
apm-overview-ref-m: "https://www.elastic.co/guide/en/apm/get-started/master"
|
watcher: "Watcher"
|
||||||
infra-guide: "https://www.elastic.co/guide/en/infrastructure/guide/current"
|
report-features: "reporting features"
|
||||||
a-data-source: "a data view"
|
ml: "machine learning"
|
||||||
icon-bug: "pass:[<span class=\"eui-icon icon-bug\"></span>]"
|
ml-cap: "Machine learning"
|
||||||
icon-checkInCircleFilled: "pass:[<span class=\"eui-icon icon-checkInCircleFilled\"></span>]"
|
ml-features: "machine learning features"
|
||||||
icon-warningFilled: "pass:[<span class=\"eui-icon icon-warningFilled\"></span>]"
|
ccr: "cross-cluster replication"
|
||||||
|
ccr-init: "CCR"
|
||||||
|
ccs: "cross-cluster search"
|
||||||
|
ccs-cap: "Cross-cluster search"
|
||||||
|
ilm: "index lifecycle management"
|
||||||
|
ilm-cap: "Index lifecycle management"
|
||||||
|
ilm-init: "ILM"
|
||||||
|
search-snap: "searchable snapshot"
|
||||||
|
search-snaps: "searchable snapshots"
|
||||||
|
slm: "snapshot lifecycle management"
|
||||||
|
slm-init: "SLM"
|
||||||
|
dfeed: "datafeed"
|
||||||
|
dfeeds: "datafeeds"
|
||||||
|
dfeeds-cap: "Datafeeds"
|
||||||
|
anomaly-detect: "anomaly detection"
|
||||||
|
anomaly-jobs: "anomaly detection jobs"
|
||||||
|
dataframe: "data frame"
|
||||||
|
dataframe-cap: "Data frame"
|
||||||
|
transform: "transform"
|
||||||
|
transforms: "transforms"
|
||||||
|
transforms-cap: "Transforms"
|
||||||
|
dfanalytics-cap: "Data frame analytics"
|
||||||
|
dfanalytics: "data frame analytics"
|
||||||
|
dfanalytics-job: "'{dataframe} analytics job'"
|
||||||
|
dfanalytics-jobs: "'{dataframe} analytics jobs'"
|
||||||
|
ctransforms: "continuous transforms"
|
||||||
|
regression: "regression"
|
||||||
|
regression-cap: "Regression"
|
||||||
|
classification: "classification"
|
||||||
|
classification-cap: "Classification"
|
||||||
|
infer-cap: "Inference"
|
||||||
|
infer: "inference"
|
||||||
|
feat-imp: "feature importance"
|
||||||
|
feat-imp-cap: "Feature importance"
|
||||||
|
nlp: "natural language processing"
|
||||||
|
|
|
||||||
|
|
@ -22,22 +22,24 @@ discovery.seed_providers: ec2
|
||||||
|
|
||||||
## Configuring EC2 discovery [_configuring_ec2_discovery]
|
## Configuring EC2 discovery [_configuring_ec2_discovery]
|
||||||
|
|
||||||
EC2 discovery supports a number of settings. Some settings are sensitive and must be stored in the [{{es}} keystore](docs-content://deploy-manage/security/secure-settings.md). For example, to authenticate using a particular access key and secret key, add these keys to the keystore by running the following commands:
|
EC2 discovery supports a number of settings. Some settings are sensitive and must be stored in the {{es}} keystore. For example, to authenticate using a particular access key and secret key, add these keys to the keystore by running the following commands:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
bin/elasticsearch-keystore add discovery.ec2.access_key
|
bin/elasticsearch-keystore add discovery.ec2.access_key
|
||||||
bin/elasticsearch-keystore add discovery.ec2.secret_key
|
bin/elasticsearch-keystore add discovery.ec2.secret_key
|
||||||
```
|
```
|
||||||
|
|
||||||
|
All **secure** settings of this plugin are reloadable, allowing you to update the secure settings for this plugin without needing to restart each node. For more information about secure and reloadable settings, go to [Secure your settings](docs-content://deploy-manage/security/secure-settings.md).
|
||||||
|
|
||||||
The available settings for the EC2 discovery plugin are as follows.
|
The available settings for the EC2 discovery plugin are as follows.
|
||||||
|
|
||||||
`discovery.ec2.access_key` ({{ref}}/secure-settings.html[Secure], [reloadable](docs-content://deploy-manage/security/secure-settings.md#reloadable-secure-settings))
|
`discovery.ec2.access_key` (Secure, reloadable)
|
||||||
: An EC2 access key. If set, you must also set `discovery.ec2.secret_key`. If unset, `discovery-ec2` will instead use the instance role. This setting is sensitive and must be stored in the {{es}} keystore.
|
: An EC2 access key. If set, you must also set `discovery.ec2.secret_key`. If unset, `discovery-ec2` will instead use the instance role. This setting is sensitive and must be stored in the {{es}} keystore.
|
||||||
|
|
||||||
`discovery.ec2.secret_key` ({{ref}}/secure-settings.html[Secure], [reloadable](docs-content://deploy-manage/security/secure-settings.md#reloadable-secure-settings))
|
`discovery.ec2.secret_key` (Secure, reloadable)
|
||||||
: An EC2 secret key. If set, you must also set `discovery.ec2.access_key`. This setting is sensitive and must be stored in the {{es}} keystore.
|
: An EC2 secret key. If set, you must also set `discovery.ec2.access_key`. This setting is sensitive and must be stored in the {{es}} keystore.
|
||||||
|
|
||||||
`discovery.ec2.session_token` ({{ref}}/secure-settings.html[Secure], [reloadable](docs-content://deploy-manage/security/secure-settings.md#reloadable-secure-settings))
|
`discovery.ec2.session_token` (Secure, reloadable)
|
||||||
: An EC2 session token. If set, you must also set `discovery.ec2.access_key` and `discovery.ec2.secret_key`. This setting is sensitive and must be stored in the {{es}} keystore.
|
: An EC2 session token. If set, you must also set `discovery.ec2.access_key` and `discovery.ec2.secret_key`. This setting is sensitive and must be stored in the {{es}} keystore.
|
||||||
|
|
||||||
`discovery.ec2.endpoint`
|
`discovery.ec2.endpoint`
|
||||||
|
|
@ -52,10 +54,10 @@ The available settings for the EC2 discovery plugin are as follows.
|
||||||
`discovery.ec2.proxy.scheme`
|
`discovery.ec2.proxy.scheme`
|
||||||
: The scheme to use when connecting to the EC2 service endpoint through proxy specified in `discovery.ec2.proxy.host`. Valid values are `http` or `https`. Defaults to `http`.
|
: The scheme to use when connecting to the EC2 service endpoint through proxy specified in `discovery.ec2.proxy.host`. Valid values are `http` or `https`. Defaults to `http`.
|
||||||
|
|
||||||
`discovery.ec2.proxy.username` ({{ref}}/secure-settings.html[Secure], [reloadable](docs-content://deploy-manage/security/secure-settings.md#reloadable-secure-settings))
|
`discovery.ec2.proxy.username` (Secure, reloadable)
|
||||||
: When the address of an HTTP proxy is given in `discovery.ec2.proxy.host`, this setting determines the username to use to connect to the proxy. When not set, no username is used. This setting is sensitive and must be stored in the {{es}} keystore.
|
: When the address of an HTTP proxy is given in `discovery.ec2.proxy.host`, this setting determines the username to use to connect to the proxy. When not set, no username is used. This setting is sensitive and must be stored in the {{es}} keystore.
|
||||||
|
|
||||||
`discovery.ec2.proxy.password` ({{ref}}/secure-settings.html[Secure], [reloadable](docs-content://deploy-manage/security/secure-settings.md#reloadable-secure-settings))
|
`discovery.ec2.proxy.password` (Secure, reloadable)
|
||||||
: When the address of an HTTP proxy is given in `discovery.ec2.proxy.host`, this setting determines the password to use to connect to the proxy. When not set, no password is used. This setting is sensitive and must be stored in the {{es}} keystore.
|
: When the address of an HTTP proxy is given in `discovery.ec2.proxy.host`, this setting determines the password to use to connect to the proxy. When not set, no password is used. This setting is sensitive and must be stored in the {{es}} keystore.
|
||||||
|
|
||||||
`discovery.ec2.read_timeout`
|
`discovery.ec2.read_timeout`
|
||||||
|
|
@ -97,9 +99,6 @@ The names of tags used for discovery may only contain ASCII letters, numbers, hy
|
||||||
`discovery.ec2.node_cache_time`
|
`discovery.ec2.node_cache_time`
|
||||||
: Sets the length of time for which the collection of discovered instances is cached. {{es}} waits at least this long between requests for discovery information from the EC2 API. AWS may reject discovery requests if they are made too often, and this would cause discovery to fail. Defaults to `10s`.
|
: Sets the length of time for which the collection of discovered instances is cached. {{es}} waits at least this long between requests for discovery information from the EC2 API. AWS may reject discovery requests if they are made too often, and this would cause discovery to fail. Defaults to `10s`.
|
||||||
|
|
||||||
All **secure** settings of this plugin are [reloadable](docs-content://deploy-manage/security/secure-settings.md#reloadable-secure-settings), allowing you to update the secure settings for this plugin without needing to restart each node.
|
|
||||||
|
|
||||||
|
|
||||||
## Recommended EC2 permissions [discovery-ec2-permissions]
|
## Recommended EC2 permissions [discovery-ec2-permissions]
|
||||||
|
|
||||||
The `discovery-ec2` plugin works by making a `DescribeInstances` call to the AWS EC2 API. You must configure your AWS account to allow this, which is normally done using an IAM policy. You can create a custom policy via the IAM Management Console. It should look similar to this.
|
The `discovery-ec2` plugin works by making a `DescribeInstances` call to the AWS EC2 API. You must configure your AWS account to allow this, which is normally done using an IAM policy. You can create a custom policy via the IAM Management Console. It should look similar to this.
|
||||||
|
|
|
||||||
|
|
@ -105,7 +105,7 @@ $$$built-in-roles-remote-monitoring-collector$$$ `remote_monitoring_collector`
|
||||||
: Grants the minimum privileges required to collect monitoring data for the {{stack}}.
|
: Grants the minimum privileges required to collect monitoring data for the {{stack}}.
|
||||||
|
|
||||||
$$$built-in-roles-reporting-user$$$ `reporting_user`
|
$$$built-in-roles-reporting-user$$$ `reporting_user`
|
||||||
: Grants the necessary privileges required to use {{reporting}} features in {{kib}}, including generating and downloading reports. This role implicitly grants access to all Kibana reporting features, with each user having access only to their own reports. Note that reporting users should also be assigned additional roles that grant read access to the [indices](https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html#roles-indices-priv) that will be used to generate reports.
|
: Grants the necessary privileges required to use {{report-features}} in {{kib}}, including generating and downloading reports. This role implicitly grants access to all Kibana reporting features, with each user having access only to their own reports. Note that reporting users should also be assigned additional roles that grant read access to the [indices](https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html#roles-indices-priv) that will be used to generate reports.
|
||||||
|
|
||||||
$$$built-in-roles-rollup-admin$$$ `rollup_admin`
|
$$$built-in-roles-rollup-admin$$$ `rollup_admin`
|
||||||
: Grants `manage_rollup` cluster privileges, which enable you to manage and execute all rollup actions.
|
: Grants `manage_rollup` cluster privileges, which enable you to manage and execute all rollup actions.
|
||||||
|
|
|
||||||
|
|
@ -1,376 +0,0 @@
|
||||||
[role="xpack"]
|
|
||||||
[[indices-get-data-stream]]
|
|
||||||
=== Get data stream API
|
|
||||||
++++
|
|
||||||
<titleabbrev>Get data stream</titleabbrev>
|
|
||||||
++++
|
|
||||||
|
|
||||||
.New API reference
|
|
||||||
[sidebar]
|
|
||||||
--
|
|
||||||
For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs].
|
|
||||||
--
|
|
||||||
|
|
||||||
Retrieves information about one or more <<data-streams,data streams>>.
|
|
||||||
See <<get-info-about-data-stream>>.
|
|
||||||
|
|
||||||
////
|
|
||||||
[source,console]
|
|
||||||
----
|
|
||||||
PUT /_ilm/policy/my-lifecycle-policy
|
|
||||||
{
|
|
||||||
"policy": {
|
|
||||||
"phases": {
|
|
||||||
"hot": {
|
|
||||||
"actions": {
|
|
||||||
"rollover": {
|
|
||||||
"max_primary_shard_size": "25GB"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"delete": {
|
|
||||||
"min_age": "30d",
|
|
||||||
"actions": {
|
|
||||||
"delete": {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
PUT /_index_template/my-index-template
|
|
||||||
{
|
|
||||||
"index_patterns": [ "my-data-stream*" ],
|
|
||||||
"data_stream": {},
|
|
||||||
"template": {
|
|
||||||
"settings": {
|
|
||||||
"index.lifecycle.name": "my-lifecycle-policy"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"_meta": {
|
|
||||||
"my-meta-field": "foo"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
PUT /_data_stream/my-data-stream
|
|
||||||
|
|
||||||
POST /my-data-stream/_rollover
|
|
||||||
|
|
||||||
PUT /_data_stream/my-data-stream-two
|
|
||||||
|
|
||||||
DELETE /_data_stream/my-data-stream*/_lifecycle
|
|
||||||
----
|
|
||||||
// TESTSETUP
|
|
||||||
////
|
|
||||||
|
|
||||||
////
|
|
||||||
[source,console]
|
|
||||||
----
|
|
||||||
DELETE /_data_stream/*
|
|
||||||
DELETE /_index_template/*
|
|
||||||
DELETE /_ilm/policy/my-lifecycle-policy
|
|
||||||
----
|
|
||||||
// TEARDOWN
|
|
||||||
////
|
|
||||||
|
|
||||||
[source,console]
|
|
||||||
----
|
|
||||||
GET /_data_stream/my-data-stream
|
|
||||||
----
|
|
||||||
|
|
||||||
[[get-data-stream-api-request]]
|
|
||||||
==== {api-request-title}
|
|
||||||
|
|
||||||
`GET /_data_stream/<data-stream>`
|
|
||||||
|
|
||||||
[[get-data-stream-api-prereqs]]
|
|
||||||
==== {api-prereq-title}
|
|
||||||
|
|
||||||
* If the {es} {security-features} are enabled, you must have the
|
|
||||||
`view_index_metadata` or `manage` <<privileges-list-indices,index privilege>>
|
|
||||||
for the data stream.
|
|
||||||
|
|
||||||
[[get-data-stream-api-path-params]]
|
|
||||||
==== {api-path-parms-title}
|
|
||||||
|
|
||||||
`<data-stream>`::
|
|
||||||
(Optional, string)
|
|
||||||
Comma-separated list of data stream names used to limit the request. Wildcard
|
|
||||||
(`*`) expressions are supported. If omitted, all data streams will be
|
|
||||||
returned.
|
|
||||||
|
|
||||||
[role="child_attributes"]
|
|
||||||
[[get-data-stream-api-query-parms]]
|
|
||||||
==== {api-query-parms-title}
|
|
||||||
|
|
||||||
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards]
|
|
||||||
+
|
|
||||||
Defaults to `open`.
|
|
||||||
|
|
||||||
`include_defaults`::
|
|
||||||
(Optional, Boolean) Functionality in preview:[]. If `true`, return all default settings in the response.
|
|
||||||
Defaults to `false`.
|
|
||||||
|
|
||||||
`verbose`::
|
|
||||||
(Optional, Boolean). If `true`, Returns the `maximum_timestamp` corresponding to the `@timestamp` field for documents in the data stream.
|
|
||||||
Defaults to `false`.
|
|
||||||
|
|
||||||
[role="child_attributes"]
|
|
||||||
[[get-data-stream-api-response-body]]
|
|
||||||
==== {api-response-body-title}
|
|
||||||
|
|
||||||
`data_streams`::
|
|
||||||
(array of objects)
|
|
||||||
Contains information about retrieved data streams.
|
|
||||||
+
|
|
||||||
.Properties of objects in `data_streams`
|
|
||||||
[%collapsible%open]
|
|
||||||
====
|
|
||||||
`name`::
|
|
||||||
(string)
|
|
||||||
Name of the data stream.
|
|
||||||
|
|
||||||
`timestamp_field`::
|
|
||||||
(object)
|
|
||||||
Contains information about the data stream's `@timestamp` field.
|
|
||||||
+
|
|
||||||
.Properties of `timestamp_field`
|
|
||||||
[%collapsible%open]
|
|
||||||
=====
|
|
||||||
`name`::
|
|
||||||
(string)
|
|
||||||
Name of the data stream's timestamp field, which must be `@timestamp`. The
|
|
||||||
`@timestamp` field must be included in every document indexed to the data
|
|
||||||
stream.
|
|
||||||
=====
|
|
||||||
|
|
||||||
`indices`::
|
|
||||||
(array of objects)
|
|
||||||
Array of objects containing information about the data stream's backing
|
|
||||||
indices.
|
|
||||||
+
|
|
||||||
The last item in this array contains information about the stream's current
|
|
||||||
<<data-stream-write-index,write index>>.
|
|
||||||
+
|
|
||||||
.Properties of `indices` objects
|
|
||||||
[%collapsible%open]
|
|
||||||
=====
|
|
||||||
`index_name`::
|
|
||||||
(string)
|
|
||||||
Name of the backing index. For naming conventions, see
|
|
||||||
<<data-streams-generation>>.
|
|
||||||
|
|
||||||
`index_uuid`::
|
|
||||||
(string)
|
|
||||||
Universally unique identifier (UUID) for the index.
|
|
||||||
|
|
||||||
`prefer_ilm`::
|
|
||||||
(boolean)
|
|
||||||
Functionality in preview:[]. Indicates if this index is configured to prefer {ilm}
|
|
||||||
when both {ilm-cap} and <<data-stream-lifecycle, Data stream lifecycle>> are configured to
|
|
||||||
manage this index.
|
|
||||||
|
|
||||||
`managed_by`::
|
|
||||||
(string)
|
|
||||||
Functionality in preview:[]. Indicates the system that managed this index.
|
|
||||||
=====
|
|
||||||
|
|
||||||
`generation`::
|
|
||||||
(integer)
|
|
||||||
Current <<data-streams-generation,generation>> for the data stream. This number
|
|
||||||
acts as a cumulative count of the stream's rollovers, starting at `1`.
|
|
||||||
|
|
||||||
`_meta`::
|
|
||||||
(object)
|
|
||||||
Custom metadata for the stream, copied from the `_meta` object of the
|
|
||||||
stream's matching <<create-index-template,index template>>. If empty,
|
|
||||||
the response omits this property.
|
|
||||||
|
|
||||||
`status`::
|
|
||||||
(string)
|
|
||||||
<<cluster-health,Health status>> of the data stream.
|
|
||||||
+
|
|
||||||
This health status is based on the state of the primary and replica shards of
|
|
||||||
the stream's backing indices.
|
|
||||||
+
|
|
||||||
.Values for `status`
|
|
||||||
[%collapsible%open]
|
|
||||||
=====
|
|
||||||
`GREEN`:::
|
|
||||||
All shards are assigned.
|
|
||||||
|
|
||||||
`YELLOW`:::
|
|
||||||
All primary shards are assigned, but one or more replica shards are
|
|
||||||
unassigned.
|
|
||||||
|
|
||||||
`RED`:::
|
|
||||||
One or more primary shards are unassigned, so some data is unavailable.
|
|
||||||
=====
|
|
||||||
|
|
||||||
`template`::
|
|
||||||
(string)
|
|
||||||
Name of the index template used to create the data stream's backing indices.
|
|
||||||
+
|
|
||||||
The template's index pattern must match the name of this data stream. See
|
|
||||||
<<create-index-template,create an index template>>.
|
|
||||||
|
|
||||||
`ilm_policy`::
|
|
||||||
(string)
|
|
||||||
Name of the current {ilm-init} lifecycle policy in the stream's matching index
|
|
||||||
template. This lifecycle policy is set in the `index.lifecycle.name` setting.
|
|
||||||
+
|
|
||||||
If the template does not include a lifecycle policy, this property is not
|
|
||||||
included in the response.
|
|
||||||
+
|
|
||||||
NOTE: A data stream's backing indices may be assigned different lifecycle
|
|
||||||
policies. To retrieve the lifecycle policy for individual backing indices,
|
|
||||||
use the <<indices-get-settings,get index settings API>>.
|
|
||||||
|
|
||||||
`next_generation_managed_by`::
|
|
||||||
(string)
|
|
||||||
Functionality in preview:[]. Indicates the system that will managed the next generation index
|
|
||||||
(i.e. the next data stream write index).
|
|
||||||
|
|
||||||
`prefer_ilm`::
|
|
||||||
(boolean)
|
|
||||||
Functionality in preview:[]. Indicates if the index template used to create the data
|
|
||||||
stream's backing indices is configured to prefer {ilm-cap} when both {ilm-cap} and
|
|
||||||
<<data-stream-lifecycle, Data stream lifecycle>> are configured to manage this index.
|
|
||||||
|
|
||||||
`hidden`::
|
|
||||||
(Boolean) If `true`, the data stream is <<multi-hidden,hidden>>.
|
|
||||||
|
|
||||||
`system`::
|
|
||||||
(Boolean)
|
|
||||||
If `true`, the data stream is created and managed by an Elastic stack component
|
|
||||||
and cannot be modified through normal user interaction.
|
|
||||||
|
|
||||||
`allow_custom_routing`::
|
|
||||||
(Boolean)
|
|
||||||
If `true`, the data stream this data stream allows custom routing on write request.
|
|
||||||
|
|
||||||
`replicated`::
|
|
||||||
(Boolean)
|
|
||||||
If `true`, the data stream is created and managed by {ccr} and the local
|
|
||||||
cluster can not write into this data stream or change its mappings.
|
|
||||||
|
|
||||||
`lifecycle`::
|
|
||||||
(object)
|
|
||||||
Functionality in preview:[]. Contains the configuration for the data stream lifecycle management of this data stream.
|
|
||||||
+
|
|
||||||
.Properties of `lifecycle`
|
|
||||||
[%collapsible%open]
|
|
||||||
=====
|
|
||||||
`data_retention`::
|
|
||||||
(string)
|
|
||||||
If defined, every document added to this data stream will be stored at least for this time frame. Any time after this
|
|
||||||
duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely.
|
|
||||||
|
|
||||||
`rollover`::
|
|
||||||
(object)
|
|
||||||
The conditions which will trigger the rollover of a backing index as configured by the cluster setting
|
|
||||||
`cluster.lifecycle.default.rollover`. This property is an implementation detail and it will only be retrieved when the query
|
|
||||||
param `include_defaults` is set to `true`. The contents of this field are subject to change.
|
|
||||||
=====
|
|
||||||
|
|
||||||
`rollover_on_write`::
|
|
||||||
(Boolean)
|
|
||||||
If `true`, the next write to this data stream will trigger a rollover first and the document will be
|
|
||||||
indexed in the new backing index. If the rollover fails the indexing request will fail too.
|
|
||||||
====
|
|
||||||
|
|
||||||
[[get-data-stream-api-example]]
|
|
||||||
==== {api-examples-title}
|
|
||||||
|
|
||||||
[source,console]
|
|
||||||
----
|
|
||||||
GET _data_stream/my-data-stream*
|
|
||||||
----
|
|
||||||
|
|
||||||
The API returns the following response:
|
|
||||||
|
|
||||||
[source,console-result]
|
|
||||||
----
|
|
||||||
{
|
|
||||||
"data_streams": [
|
|
||||||
{
|
|
||||||
"name": "my-data-stream",
|
|
||||||
"timestamp_field": {
|
|
||||||
"name": "@timestamp"
|
|
||||||
},
|
|
||||||
"indices": [
|
|
||||||
{
|
|
||||||
"index_name": ".ds-my-data-stream-2099.03.07-000001",
|
|
||||||
"index_uuid": "xCEhwsp8Tey0-FLNFYVwSg",
|
|
||||||
"prefer_ilm": true,
|
|
||||||
"ilm_policy": "my-lifecycle-policy",
|
|
||||||
"managed_by": "Index Lifecycle Management",
|
|
||||||
"index_mode": "standard"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"index_name": ".ds-my-data-stream-2099.03.08-000002",
|
|
||||||
"index_uuid": "PA_JquKGSiKcAKBA8DJ5gw",
|
|
||||||
"prefer_ilm": true,
|
|
||||||
"ilm_policy": "my-lifecycle-policy",
|
|
||||||
"managed_by": "Index Lifecycle Management",
|
|
||||||
"index_mode": "standard"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"generation": 2,
|
|
||||||
"_meta": {
|
|
||||||
"my-meta-field": "foo"
|
|
||||||
},
|
|
||||||
"status": "GREEN",
|
|
||||||
"index_mode": "standard",
|
|
||||||
"next_generation_managed_by": "Index Lifecycle Management",
|
|
||||||
"prefer_ilm": true,
|
|
||||||
"template": "my-index-template",
|
|
||||||
"ilm_policy": "my-lifecycle-policy",
|
|
||||||
"hidden": false,
|
|
||||||
"system": false,
|
|
||||||
"allow_custom_routing": false,
|
|
||||||
"replicated": false,
|
|
||||||
"rollover_on_write": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "my-data-stream-two",
|
|
||||||
"timestamp_field": {
|
|
||||||
"name": "@timestamp"
|
|
||||||
},
|
|
||||||
"indices": [
|
|
||||||
{
|
|
||||||
"index_name": ".ds-my-data-stream-two-2099.03.08-000001",
|
|
||||||
"index_uuid": "3liBu2SYS5axasRt6fUIpA",
|
|
||||||
"prefer_ilm": true,
|
|
||||||
"ilm_policy": "my-lifecycle-policy",
|
|
||||||
"managed_by": "Index Lifecycle Management",
|
|
||||||
"index_mode": "standard"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"generation": 1,
|
|
||||||
"_meta": {
|
|
||||||
"my-meta-field": "foo"
|
|
||||||
},
|
|
||||||
"status": "YELLOW",
|
|
||||||
"index_mode": "standard",
|
|
||||||
"next_generation_managed_by": "Index Lifecycle Management",
|
|
||||||
"prefer_ilm": true,
|
|
||||||
"template": "my-index-template",
|
|
||||||
"ilm_policy": "my-lifecycle-policy",
|
|
||||||
"hidden": false,
|
|
||||||
"system": false,
|
|
||||||
"allow_custom_routing": false,
|
|
||||||
"replicated": false,
|
|
||||||
"rollover_on_write": false
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
----
|
|
||||||
// TESTRESPONSE[s/"index_name": ".ds-my-data-stream-2099.03.07-000001"/"index_name": $body.data_streams.0.indices.0.index_name/]
|
|
||||||
// TESTRESPONSE[s/"index_uuid": "xCEhwsp8Tey0-FLNFYVwSg"/"index_uuid": $body.data_streams.0.indices.0.index_uuid/]
|
|
||||||
// TESTRESPONSE[s/"index_name": ".ds-my-data-stream-2099.03.08-000002"/"index_name": $body.data_streams.0.indices.1.index_name/]
|
|
||||||
// TESTRESPONSE[s/"index_uuid": "PA_JquKGSiKcAKBA8DJ5gw"/"index_uuid": $body.data_streams.0.indices.1.index_uuid/]
|
|
||||||
// TESTRESPONSE[s/"index_name": ".ds-my-data-stream-two-2099.03.08-000001"/"index_name": $body.data_streams.1.indices.0.index_name/]
|
|
||||||
// TESTRESPONSE[s/"index_uuid": "3liBu2SYS5axasRt6fUIpA"/"index_uuid": $body.data_streams.1.indices.0.index_uuid/]
|
|
||||||
// TESTRESPONSE[s/"status": "GREEN"/"status": "YELLOW"/]
|
|
||||||
// TESTRESPONSE[s/"replicated": false/"replicated": false,"failure_store":{"enabled": false, "indices": [], "rollover_on_write": true}/]
|
|
||||||
|
|
@ -159,7 +159,7 @@ cidrMatch(source.address, null) // returns null
|
||||||
|
|
||||||
|
|
||||||
`<cidr_block>`
|
`<cidr_block>`
|
||||||
: (Required{{multi-arg}}, string or `null`) CIDR block you wish to search. If `null`, the function returns `null`.
|
: (Required, string or `null`) CIDR block you wish to search. If `null`, the function returns `null`. This parameter accepts multiple arguments.
|
||||||
|
|
||||||
**Returns:** boolean or `null`
|
**Returns:** boolean or `null`
|
||||||
|
|
||||||
|
|
@ -202,7 +202,7 @@ concat(<value>[, <value>])
|
||||||
**Parameters**
|
**Parameters**
|
||||||
|
|
||||||
`<value>`
|
`<value>`
|
||||||
: (Required{{multi-arg-ref}}) Value to concatenate. If any of the arguments are `null`, the function returns `null`.
|
: (Required) Value to concatenate. If any of the arguments are `null`, the function returns `null`. This parameter accepts multiple arguments.
|
||||||
|
|
||||||
If using a field as the argument, this parameter does not support the [`text`](/reference/elasticsearch/mapping-reference/text.md) field data type.
|
If using a field as the argument, this parameter does not support the [`text`](/reference/elasticsearch/mapping-reference/text.md) field data type.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -55,7 +55,7 @@ In this step, you load the data that you later use to create embeddings from.
|
||||||
|
|
||||||
Use the `msmarco-passagetest2019-top1000` data set, which is a subset of the MS MARCO Passage Ranking data set. It consists of 200 queries, each accompanied by a list of relevant text passages. All unique passages, along with their IDs, have been extracted from that data set and compiled into a https://github.com/elastic/stack-docs/blob/main/docs/en/stack/ml/nlp/data/msmarco-passagetest2019-unique.tsv[tsv file].
|
Use the `msmarco-passagetest2019-top1000` data set, which is a subset of the MS MARCO Passage Ranking data set. It consists of 200 queries, each accompanied by a list of relevant text passages. All unique passages, along with their IDs, have been extracted from that data set and compiled into a https://github.com/elastic/stack-docs/blob/main/docs/en/stack/ml/nlp/data/msmarco-passagetest2019-unique.tsv[tsv file].
|
||||||
|
|
||||||
Download the file and upload it to your cluster using the {kibana-ref}/connect-to-elasticsearch.html#upload-data-kibana[Data Visualizer] in the {ml-app} UI. After your data is analyzed, click **Override settings**. Under **Edit field names**, assign `id` to the first column and `content` to the second. Click **Apply**, then **Import**. Name the index `test-data`, and click **Import**. After the upload is complete, you will see an index named `test-data` with 182,469 documents.
|
Download the file and upload it to your cluster using the [Data Visualizer](docs-content://manage-data/ingest/upload-data-files.md) in the {ml-app} UI. After your data is analyzed, click **Override settings**. Under **Edit field names**, assign `id` to the first column and `content` to the second. Click **Apply**, then **Import**. Name the index `test-data`, and click **Import**. After the upload is complete, you will see an index named `test-data` with 182,469 documents.
|
||||||
|
|
||||||
[discrete]
|
[discrete]
|
||||||
[[hybrid-search-reindex-data]]
|
[[hybrid-search-reindex-data]]
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue