Skip to content
This repository was archived by the owner on Jun 5, 2024. It is now read-only.

observeinc/host-configuration-scripts

 
 

Repository files navigation

Pass/Fail Tests - AWS

Pass/Fail Tests - Azure

Pass/Fail Tests - GCP

Configuration script for Linux

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

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://<OBSERVE_CUSTOMER>.collect.observeinc.com/ --config_files_clean TRUE --ec2metadata TRUE --datacenter MY_DATA_CENTER --appgroup MY_APP_GROUP


About

Files and scripts for configuration of osquery, fluent, and telegraf

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HCL 44.0%
  • Shell 43.8%
  • Python 10.6%
  • PostScript 1.6%