Skip to content

Commit

Permalink
Update installation tasks and remove persistent install steps (#22290) (
Browse files Browse the repository at this point in the history
#22504)

* Update installation tasks and remove persistent install steps

* Fix bugs in widget code

* Add fixes from review and add to-do items
  • Loading branch information
dedemorton authored Nov 9, 2020
1 parent c3cc3e9 commit f3e77b9
Show file tree
Hide file tree
Showing 28 changed files with 1,191 additions and 1,171 deletions.

This file was deleted.

38 changes: 18 additions & 20 deletions x-pack/elastic-agent/docs/elastic-agent-configuration.asciidoc
Original file line number Diff line number Diff line change
@@ -1,28 +1,17 @@
[[elastic-agent-configuration]]
[role="xpack"]
= Configuration settings
= Policy settings

beta[]

// TODO: This topic assumes users know what standalone and fleet are. When we
// add the settings reference, we should clean this up: describe the available
// options, then show how to configure them manually for standalone. We should
// assume Fleet is the common use case, even if it's not the default, and make
// sure this reference is useful for both use cases.
The policy settings for {fleet}-managed agents are specified through the UI.
You do not set them explicitly in a configuration file.

By default {agent} runs in standalone mode to ingest system data and send it to
a local {es} instance running on port 9200. It uses the demo credentials of the
`elastic` user. It's also configured to monitor all programs managed by {agent}
and send the logs and metrics to the same {es} instance.
For standalone agents, you need to configure settings in the `elastic-agent.yml`
file.

To alter this behavior, configure the output and other configuration settings.
When running the agent standalone, specify configuration settings in the
`elastic-agent.yml` file. When using {fleet}, do not modify settings in
the `elastic-agent.yml` file. Instead, use {fleet} in {kib} to change
settings.

//TIP: To get started quickly, you can use {fleet} to generate a standalone
//configuration. For more information, see <<agent-standalone-mode>>.
TIP: To get started quickly, you can use {fleet} to generate a standalone
configuration. For more information, see <<run-elastic-agent-standalone>>.

[discrete]
[[elastic-agent-output-configuration]]
Expand Down Expand Up @@ -117,5 +106,14 @@ inputs:

If `use_output` is not specified, the `default` output is used.

//For more examples, see
//<<elastic-agent-configuration-example,`elastic-agent_configuration_example.yml`>>.
== Reference yaml

The {agent} installation includes an `elastic-agent.reference.yml` file that
describes all the settings available in a standalone configuration.

The contents of the file are included here for your convenience.

[source,yaml]
----
include::elastic-agent-reference-yaml.yml[]
----
202 changes: 202 additions & 0 deletions x-pack/elastic-agent/docs/elastic-agent-reference-yaml.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
######################################
# Fleet configuration
######################################
outputs:
default:
type: elasticsearch
hosts: [127.0.0.1:9200]
username: elastic
password: changeme

inputs:
- type: system/metrics

# The only two requirement are that it has only characters allowed in an Elasticsearch index name
# Index names must meet the following criteria:
# Lowercase only
# Cannot include \, /, *, ?, ", <, >, |, ` ` (space character), ,, #
# Cannot start with -, _, +
# Cannot be . or ..
data_stream.namespace: default
use_output: default
streams:
- metricset: cpu
# The only two requirement are that it has only characters allowed in an Elasticsearch index name
# Index names must meet the following criteria:
# Lowercase only
# Cannot include \, /, *, ?, ", <, >, |, ` ` (space character), ,, #
# Cannot start with -, _, +
# Cannot be . or ..
data_stream.dataset: system.cpu
- metricset: memory
data_stream.dataset: system.memory
- metricset: network
data_stream.dataset: system.network
- metricset: filesystem
data_stream.dataset: system.filesystem

# management:
# # Mode of management, the Elastic Agent support two modes of operation:
# #
# # local: The Elastic Agent will expect to find the inputs configuration in the local file.
# #
# # Default is local.
# mode: "local"

# fleet:
# access_api_key: ""
# kibana:
# # kibana minimal configuration
# hosts: ["localhost:5601"]
# ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

# # optional values
# #protocol: "https"
# #username: "elastic"
# #password: "changeme"
# #path: ""
# #ssl.verification_mode: full
# #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
# #ssl.cipher_suites: []
# #ssl.curve_types: []
# reporting:
# # Reporting threshold indicates how many events should be kept in-memory before reporting them to fleet.
# #reporting_threshold: 10000
# # Frequency used to check the queue of events to be sent out to fleet.
# #reporting_check_frequency_sec: 30

# agent.download:
# # source of the artifacts, requires elastic like structure and naming of the binaries
# # e.g /windows-x86.zip
# sourceURI: "https://artifacts.elastic.co/downloads/beats/"
# # path to the directory containing downloaded packages
# target_directory: "${path.data}/downloads"
# # timeout for downloading package
# timeout: 30s
# # file path to a public key used for verifying downloaded artifacts
# # if not file is present agent will try to load public key from elastic.co website.
# pgpfile: "${path.data}/elastic.pgp"
# # install_path describes the location of installed packages/programs. It is also used
# # for reading program specifications.
# install_path: "${path.data}/install"

# agent.process:
# # timeout for creating new processes. when process is not successfully created by this timeout
# # start operation is considered a failure
# spawn_timeout: 30s
# # timeout for stopping processes. when process is not stopped by this timeout then the process.
# # is force killed
# stop_timeout: 30s

# agent.grpc:
# # listen address for the GRPC server that spawned processes connect back to.
# address: localhost
# # port for the GRPC server that spawned processes connect back to.
# port: 6789

# agent.retry:
# # Enabled determines whether retry is possible. Default is false.
# enabled: true
# # RetriesCount specifies number of retries. Default is 3.
# # Retry count of 1 means it will be retried one time after one failure.
# retriesCount: 3
# # Delay specifies delay in ms between retries. Default is 30s
# delay: 30s
# # MaxDelay specifies maximum delay in ms between retries. Default is 300s
# maxDelay: 5m
# # Exponential determines whether delay is treated as exponential.
# # With 30s delay and 3 retries: 30, 60, 120s
# # Default is false
# exponential: false

# agent.monitoring:
# # enabled turns on monitoring of running processes
# enabled: false
# # enables log monitoring
# logs: false
# # enables metrics monitoring
# metrics: false

# # Allow fleet to reload his configuration locally on disk.
# # Notes: Only specific process configuration will be reloaded.
# agent.reload:
# # enabled configure the Elastic Agent to reload or not the local configuration.
# #
# # Default is true
# enabled: true

# # period define how frequent we should look for changes in the configuration.
# period: 10s

# Logging

# There are four options for the log output: file, stderr, syslog, eventlog
# The file output is the default.

# Sets log level. The default log level is info.
# Available log levels are: error, warning, info, debug
#agent.logging.level: info

# Enable debug output for selected components. To enable all selectors use ["*"]
# Other available selectors are "beat", "publish", "service"
# Multiple selectors can be chained.
#agent.logging.selectors: [ ]

# Send all logging output to stderr. The default is false.
agent.logging.to_stderr: true

# Send all logging output to syslog. The default is false.
#agent.logging.to_syslog: false

# Send all logging output to Windows Event Logs. The default is false.
#agent.logging.to_eventlog: false

# If enabled, Elastic-Agent periodically logs its internal metrics that have changed
# in the last period. For each metric that changed, the delta from the value at
# the beginning of the period is logged. Also, the total values for
# all non-zero internal metrics are logged on shutdown. The default is true.
#agent.logging.metrics.enabled: true

# The period after which to log the internal metrics. The default is 30s.
#agent.logging.metrics.period: 30s

# Logging to rotating files. Set logging.to_files to false to disable logging to
# files.
#agent.logging.to_files: true
#agent.logging.files:
# Configure the path where the logs are written. The default is the logs directory
# under the home path (the binary location).
#path: /var/log/elastic-agent

# The name of the files where the logs are written to.
#name: elastic-agent

# Configure log file size limit. If limit is reached, log file will be
# automatically rotated
#rotateeverybytes: 10485760 # = 10MB

# Number of rotated log files to keep. Oldest files will be deleted first.
#keepfiles: 7

# The permissions mask to apply when rotating log files. The default value is 0600.
# Must be a valid Unix-style file permissions mask expressed in octal notation.
#permissions: 0600

# Enable log file rotation on time intervals in addition to size-based rotation.
# Intervals must be at least 1s. Values of 1m, 1h, 24h, 7*24h, 30*24h, and 365*24h
# are boundary-aligned with minutes, hours, days, weeks, months, and years as
# reported by the local system clock. All other intervals are calculated from the
# Unix epoch. Defaults to disabled.
#interval: 0

# Rotate existing logs on startup rather than appending to the existing
# file. Defaults to true.
# rotateonstartup: true

# Set to true to log messages in JSON format.
#agent.logging.json: false

# Set to true, to log messages with minimal required Elastic Common Schema (ECS)
# information. Recommended to use in combination with `logging.json=true`
# Defaults to false.
#agent.logging.ecs: false
12 changes: 10 additions & 2 deletions x-pack/elastic-agent/docs/elastic-agent.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,30 @@ collect data and send it to the {stack}. Behind the scenes, {agent} runs the
To learn how to install, configure, and run your {agent}s, see:

* <<elastic-agent-installation>>
* <<run-elastic-agent>>
* <<upgrade-elastic-agent>>
* <<run-elastic-agent-standalone>>
* <<stop-elastic-agent>>
* <<unenroll-elastic-agent>>
* <<uninstall-elastic-agent>>
* <<elastic-agent-cmd-options>>
* <<elastic-agent-configuration>>

include::install-elastic-agent.asciidoc[leveloffset=+1]

include::run-elastic-agent.asciidoc[leveloffset=+1]
include::upgrade-elastic-agent.asciidoc[leveloffset=+1]

include::run-elastic-agent-standalone.asciidoc[leveloffset=+1]

include::stop-elastic-agent.asciidoc[leveloffset=+1]

include::unenroll-elastic-agent.asciidoc[leveloffset=+1]

include::uninstall-elastic-agent.asciidoc[leveloffset=+1]

include::elastic-agent-command-line.asciidoc[leveloffset=+1]

include::elastic-agent-configuration.asciidoc[leveloffset=+1]

include::elastic-agent-dynamic-inputs.asciidoc[leveloffset=+1]

include::redirects.asciidoc[leveloffset=+1]
Loading

0 comments on commit f3e77b9

Please sign in to comment.