diff --git a/README.md b/README.md index c3d538d..40d5e86 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,21 @@ # Graylog Demo -This is a demonstration of Graylog, a centralized log management system featuring a shell provisioned CentOS 7 Vagrant box. To illustrate various log collection methods `httpd`, `rsyslog` and `docker` are installed and a simple WordPress instance is deployed via Docker Compose. Log collection incorporates Fluentd to ship logs into a Graylog instance from containers, the syslog, and arbitrary filesystem logs. +This is a demonstration of Graylog, a centralized log management system featuring a shell provisioned CentOS 7 Vagrant box. To illustrate various log collection methods `httpd`, `rsyslog` and `docker` are installed and a simple WordPress instance is deployed via Docker Compose. Log collection incorporates td-agent (a version of Fluentd) to ship logs into a Graylog instance from containers, the syslog, and arbitrary filesystem logs. This demonstration assumes you are familiar with using Vagrant + VirtualBox to automate the installation of virtual machines, although you can reference the Vagrantfile's shell provisioning sections to manually set up a system if you so desire. Please install these prerequisites before attempting the quick start below. #### Notes about setup -- This demonstration uses Traefik for routing and the [xip.io](http://xip.io/) wildcard DNS service. If DNS fails to resolve for whatever reason you may want to set the domains to the IP inside your operating system's hosts file, e.g. +- This demonstration uses Traefik for some routing and the [xip.io](http://xip.io/) wildcard DNS service. If DNS fails to resolve for whatever reason you may want to set the domains to the IP inside your operating system's hosts file, e.g. ``` 172.28.128.30 traefik.172.28.128.30.xip.io 172.28.128.30 graylog.172.28.128.30.xip.io -172.28.128.30 wordpress.172.28.128.30.xip.io ``` -- Vagrant will provision a virtual machine with a static private Class B address (specifically `172.28.128.30`). If you would like to change this IP address to something different you will need to change the `PRIVATE_NET_IP` variable and the scripted API calls in the `Vagrantfile`. You'll also need to modify the few wildcard DNS references to it in the two `docker-compose.yml` files. +- Vagrant will provision two virtual machines with two consecutive private Class B addresses (starting from `172.28.128.30`). If you would like to change this base IP address to something different you will need to look through the project and find various references. Unfortunately, this is not a simple variable you can set for the entire project. -- Vagrant is set to allocate 4 cores and 4 GB of RAM, you may need to adjust this for your machine if necessary. +- Vagrant is set to allocate 4 cores and 4 GB of RAM per machine (this is 8 cores / 8 GB of memory total) you may need to adjust this for your machine if necessary. - After deploying, Graylog takes the longest to become available and it may take 30 seconds to a few minutes to bring it up depending on your machine. @@ -26,7 +25,7 @@ This demonstration assumes you are familiar with using Vagrant + VirtualBox to a ## Quick Start -_This section assumes you will be using the default `172.28.128.30` IP address_ +_This section assumes you will be using the default `172.28.128.30` and `172.28.128.31` IP addresses_ 1. Clone the repository and navigate inside its directory 2. Create and provision the VM using `vagrant up` 3. Navigate to [http://graylog.172.28.128.30.xip.io:8080/](http://graylog.172.28.128.30.xip.io:8080/) @@ -36,13 +35,13 @@ _This section assumes you will be using the default `172.28.128.30` IP address_ 7. Press the start button on the top right to start updating the feed every second #### Docker Test -- Generate Docker logs by simply navigating to the WordPress install page [http://wordpress.172.28.128.30.xip.io:8080/](http://wordpress.172.28.128.30.xip.io:8080/) +- Generate Docker logs by simply navigating to the WordPress install page: [http://172.28.128.31:8080](http://172.28.128.31:8080/wp-admin/install.php) #### File Test -- Collect logs from Apache's `access_log` file by going to [http://172.28.128.30/](http://172.28.128.30/) +- Collect logs from Apache's `access_log` file by going to [http://172.28.128.31/](http://172.28.128.31/) #### Syslog Test -1. Go back to the terminal inside the project's directory and type `vagrant ssh` +1. Go back to the terminal inside the project's directory and type `vagrant ssh systems` or `vagrant ssh graylog` 2. You can test Syslog collection with `logger` e.g. `logger -t test Hello world` (or just wait for some to appear) ### Copyrights and Licenses