https://github.com/observeinc/linux-host-configuration-scripts
Single line installer script for Linux Host Monitoring collection agents. Includes files and scripts for configuration of osquery, fluent, and telegraf.
https://github.com/observeinc/linux-host-configuration-scripts
bash-script installation-scripts integrationname-host-monitoring integrations linux
Last synced: 29 days ago
JSON representation
Single line installer script for Linux Host Monitoring collection agents. Includes files and scripts for configuration of osquery, fluent, and telegraf.
- Host: GitHub
- URL: https://github.com/observeinc/linux-host-configuration-scripts
- Owner: observeinc
- License: other
- Created: 2022-04-29T02:12:34.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-13T19:04:52.000Z (about 1 year ago)
- Last Synced: 2025-01-13T20:19:47.908Z (about 1 year ago)
- Topics: bash-script, installation-scripts, integrationname-host-monitoring, integrations, linux
- Language: HCL
- Homepage: https://docs.observeinc.com/en/latest/content/integrations/linux/Linux-pkgs.html#installing-host-monitoring-on-linux
- Size: 733 KB
- Stars: 5
- Watchers: 8
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Configuration script for Linux [Legacy]
---
***This content is being deprecated in favor of [Host Quick Start Integration](https://docs.observeinc.com/en/latest/content/integrations/host/quickstart.html) and will be removed in a future release.***
---
## Assumptions:
- Assumes user running script can use passwordless sudo
- Assumes Ubuntu, Debian, Amazon Linux, CentOS, or Red Hat
## What does it do
- Creates a config_files directory in home of logged in user
- Downloads configuration files from this git repository
- Installs osquery, fluentbit and telegraf
- Subsitutes values for data center, hostname, customer id, data ingest token and observe endpoint in configuration files
- Copies files to respective agent locations, renames existing files with suffix OLD
- Outputs status of services
## Steps to configure
1. Login to machine via ssh
2. Run script with flag values set
Run --help command for list of flags and options
###########################################
## HELP CONTENT
###########################################
### Required inputs
- Required --customer_id OBSERVE_CUSTOMER
- Required --ingest_token OBSERVE_TOKEN
## Optional inputs
- Optional --observe_host_name - Defaults to https://<_OBSERVE_CUSTOMER>.collect.observeinc.com/
- Optional --config_files_clean TRUE or FALSE - Defaults to FALSE
- controls whether to delete created config_files temp directory
- Optional --ec2metadata TRUE or FALSE - Defaults to FALSE
- controls fluentbit config for whether to use default ec2 metrics
- Optional --cloud_metadata TRUE or FALSE - Defaults to FALSE
- controls fluentbit config for whether to poll for VM metadata
- Optional --datacenter defaults to AWS
- Optional --appgroup id supplied sets value in fluentbit config
- Optional --branch_input branch of repository to pull scrips and config files from -Defaults to main
- Optional --validate_endpoint of observe_hostname using customer_id and ingest_token -Defaults to TRUE
- Optional --module to use for installs -Defaults to linux_host which installs osquery, fluentbit, and telegraf
- Optional module flag: securityonion adds a config to fluentbit. If securityonion is specified without linux_host, only fluent bit will be installed.
- Optional module flag: jenkins adds a config to fluentbit. If jenkins is specified without linux_host, only fluent bit will be installed.
- Optional --observe_jenkins_path used in combination with jenkins module - location of jenkins logs
- Optional --custom_fluentbit_config add an additional configuration file for fluentbit
- Optional --osquery_version value for which osquery version to install (defaults to "latest"). Note this needs to be the full version number: i.e. '5.9.1-1.linux'"
- Optional --telegraf_version value for which telegraf version to install (defaults to "latest"). Note this needs to be the full version number: i.e. '1.28.2-1'"
- Optional --fluentbit_version value for which fluentbit version to install (defaults to "latest"). Note this needs to be the full version number: i.e. '2.1.10'"
- Optional --shell_history_enable add option to capture user's shell history, TRUE or FALSE - Defaults to FALSE"
***************************
### Sample command:
``` curl https://raw.githubusercontent.com/observeinc/linux-host-configuration-scripts/main/observe_configure_script.sh | bash -s -- --customer_id OBSERVE_CUSTOMER --ingest_token OBSERVE_TOKEN --observe_host_name https://.collect.observeinc.com/ --config_files_clean TRUE --ec2metadata TRUE --datacenter MY_DATA_CENTER --appgroup MY_APP_GROUP```
***************************
## Other Configs:
Other configs are files used in use case specific scenarios and should only be used when advised by Observe personnel