openstack/openstack-ansible-ops
Code Issues Proposed changes

Merge "clean up readme"

Browse Source
This commit is contained in:
Zuul 2018-10-19 02:24:37 +00:00 committed by Gerrit Code Review
commit 6ee136fea9
1 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
osquery/README.rst
View File

@ -31,7 +31,7 @@ OpenStack-Ansible Integration
----------------------------- -----------------------------
These playbooks can be used as standalone inventory or as an integrated part of These playbooks can be used as standalone inventory or as an integrated part of
an OpenStack-Ansible deployment. For a simple example of standalone inventory, an OpenStack-Ansible deployment. For a simple example of standalone inventory
see ``inventory.example.yml``. see ``inventory.example.yml``.
Setup | system configuration Setup | system configuration
@ -44,6 +44,7 @@ Clone the osquery-osa repo
cd /opt cd /opt
git clone https://github.com/openstack/openstack-ansible-ops git clone https://github.com/openstack/openstack-ansible-ops
Copy the env.d file into place Copy the env.d file into place
.. code-block:: bash .. code-block:: bash
@ -51,6 +52,7 @@ Copy the env.d file into place
cd /opt/openstack-ansible-ops/osquery cd /opt/openstack-ansible-ops/osquery
cp env.d/fleet.yml /etc/openstack_deploy/env.d/ cp env.d/fleet.yml /etc/openstack_deploy/env.d/
Copy the conf.d file into place Copy the conf.d file into place
.. code-block:: bash .. code-block:: bash
@ -65,6 +67,7 @@ the kolide fleet cluster in multiple containers and one logging host under
vi /etc/openstack_deploy/conf.d/fleet.yml vi /etc/openstack_deploy/conf.d/fleet.yml
Create the containers Create the containers
.. code-block:: bash .. code-block:: bash
@ -165,7 +168,6 @@ Create some basic passwords keys that are needed by fleet
Install master/data Fleet nodes on the elastic-logstash containers, Install master/data Fleet nodes on the elastic-logstash containers,
deploy logstash, deploy Kibana, and then deploy all of the service beats. deploy logstash, deploy Kibana, and then deploy all of the service beats.
.. code-block:: bash .. code-block:: bash
cd /opt/openstack-ansible-ops/osquery cd /opt/openstack-ansible-ops/osquery
@ -190,15 +192,11 @@ certificates.
* If required add ``-e@/opt/openstack-ansible/inventory/group_vars/all/all.yml`` * If required add ``-e@/opt/openstack-ansible/inventory/group_vars/all/all.yml``
to import sufficient OSA group variables to define the OpenStack release. to import sufficient OSA group variables to define the OpenStack release.
Journalbeat will then deploy onto all hosts/containers for releases prior to
Rocky, and hosts only for Rocky onwards. If the variable ``openstack_release``
is undefined the default behaviour is to deploy Journalbeat to hosts only.
* Alternatively if using the embedded ansible, create a symlink to include all * Alternatively if using the embedded ansible, create a symlink to include all
of the OSA group_vars. These are not available by default with the embedded of the OSA group_vars. These are not available by default with the embedded
ansible and can be symlinked into the ops repo. ansible and can be symlinked into the ops repo.
.. code-block:: bash .. code-block:: bash
ln -s /opt/openstack-ansible/inventory/group_vars /opt/openstack-ansible-ops/osquery/group_vars ln -s /opt/openstack-ansible/inventory/group_vars /opt/openstack-ansible-ops/osquery/group_vars
@ -216,7 +214,7 @@ with at leasts 8GiB of RAM and 40GiB of storage on root. Running an `m1.medium`
(openstack) flavor size is generally enough to get an environment online. (openstack) flavor size is generally enough to get an environment online.
To run the local functional tests execute the `run-tests.sh` script out of the To run the local functional tests execute the `run-tests.sh` script out of the
tests directory. This will create a 1 node kolide-fleet cluster and install tests directory. This will create a single node kolide-fleet cluster and install
osquery on the local host. osquery on the local host.
.. code-block:: bash .. code-block:: bash
@ -224,10 +222,6 @@ osquery on the local host.
CLUSTERED=yes tests/run-tests.sh CLUSTERED=yes tests/run-tests.sh
After the test build is completed the cluster will test it's layout and ensure
processes are functioning normally. Logs for the cluster can be found at
`/tmp/osquery-logs`.
To rerun the playbooks after a test build, source the `tests/manual-test.rc` To rerun the playbooks after a test build, source the `tests/manual-test.rc`
file and follow the onscreen instructions. file and follow the onscreen instructions.