Code Monkey home page Code Monkey logo

puppet-osquery's Introduction

Build Status

OSQuery

Table of Contents

  1. Overview
  2. Setup - The basics of getting started with osquery
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.

Overview

OSQuery installation and configuration Puppet module.

Setup

What OSQuery affects

  • osquery repo installed by default, can be disabled.
  • osquery package installed.
  • osquery JSON config file setup.
  • osquery service ran.

Setup Requirements

Uses apt module for Ubuntu to setup the repository or yum if Redhat family to install the repo RPM.

Usage

Basic usage example with defaults.

include osquery

Usage example including some custom settings.

class { 'osquery':
  settings => {
    'options' => {
      'event_pubsub_expiry' => '86000',
      'debug' => false,
      'worker_threads' => $::processorcount,
    },
    'schedule' => {
      'info' => {
        'query' => 'SELECT * FROM osquery_info',
        'interval' => '3600',
      },
    },
  }
}

Reference

  • osquery::settings - hash converted into a JSON string for the OSQuery config file. Default is based on upstream package example config.
  • osquery::package_name - Package name to install. Default is auto detect based on OSFamily.
  • osquery::service_name - Service name to run. Default is auto detect based on OSFamily.
  • osquery::package_ver - latest or present. Defaults to latest.
  • osquery::params::config - Full path to config file. Defaults to /etc/osquery/osquery.conf.
  • osquery::params::repo_install - Boolan, manage the repo or not. Default is true.
  • osquery::params::repo_url - Repo URL.
  • osquery::params::repo_name - Redhat repo RPM name.
  • osquery::params::repo_key_id - Apt repo signature key ID.
  • osquery::params::repo_key_server - Apt repo key server.

Limitations

OSQuery is developed for CentOS6/7 as well as Ubuntu Trusty 14.04 LTS and Precise 12.04 LTS only.

puppet-osquery's People

Contributors

biandrews avatar keeleysam avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.