diff --git a/README.md b/README.md index 90e769f5..cd4ab2b5 100644 --- a/README.md +++ b/README.md @@ -29,18 +29,36 @@ collections: ## Usage +Our default configuration will collect filesystem logs placed by `rsyslog`. Therefor our example playbook makes sure, `rsyslog` is installed. If you don't want that, please change the configuration of the `beats` module. Without syslog you won't receive any messages with the default configuration. + +There are some comments in the Playbook. Either fill them with the correct values (`remote_user`) or consider them as a hint to commonly used options. ``` -- name: Install Elasticsearch - hosts: all +--- +- hosts: all + # remote_user: my_username + become: true collections: - - NETWAYS.elasticstack + - netways.elasticstack vars: - elastic_variant: oss + elastic_variant: elastic #oss elasticsearch_jna_workaround: true + elastic_override_beats_tls: true + # elastic_release: 8 #7 + pre_tasks: + - name: Install Rsyslog + package: + name: rsyslog + - name: Start rsyslog + service: + name: rsyslog + state: started + enabled: true roles: - repos - - beats - elasticsearch + - geerlingguy.redis - logstash - kibana + - beats + ```