Skip to main content

Set of Ansible modules for AlgoSec services management

Project description

AlgoSec Ansible Role
====================

|docs| |travis| |coverage|

.. |docs| image:: https://readthedocs.org/projects/algosec-ansible-role/badge/
:target: http://algosec-ansible-role.readthedocs.io/en/latest/
:alt: Documentation Status

.. |coverage| image:: https://img.shields.io/codecov/c/github/algosec/algosec-ansible-role.svg
:target: https://codecov.io/gh/algosec/algosec-ansible-role

.. |travis| image:: https://travis-ci.com/algosec/algosec-ansible-role.svg?branch=master
:target: https://travis-ci.com/algosec/algosec-ansible-role

Ansible role to DevOps-ify network security management, leveraging AlgoSec's business-driven security policy management solution

Documentation available online at: http://algosec-ansible-role.readthedocs.io/en/latest/

Requirements
------------

* This module is supported and fully tested under ``python2.7`` and ``python3.6``.

* All modules of this role require environment::

pip install algosec --upgrade
pip install ansible marshmallow urllib3

Installation
------------
The Ansible role can be installed directly from Ansible Galaxy by running::

ansible-galaxy install algosec.algosec

If the ``ansible-galaxy`` command-line tool is not available (usually shipped with Ansible), or you prefer to download the role package directly,
navigate to the Ansible Galaxy `role page <https://galaxy.ansible.com/algosec/algosec/>`_ and hit "Download".

Alternately, you can directly navigate to our `GitHub repository <https://github.com/algosec/algosec-ansible-role>`_.

Usage
--------------

Once installed, you can start using the modules included in this role in your ansible playbooks.

To quickly get up and running a simple example you can follow these steps:

1. Download and unzip locally the examples folder by clicking `here <https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/algosec/algosec-ansible-role/tree/master/examples>`_.
2. Update authentication credentials in ``vars/algosec-secrets.yml``.
3. Update your AlgoSec server IP in ``inventory.ini``.
4. Update the arguments of the relevant modules in one of the playbooks (files with the ``yml`` extension).
5. Run ``ansible-playbook -i inventory.ini <playbook-filename>.yml``.
6. You've made it!


Documentation
-------------

.. image:: https://readthedocs.org/projects/algosec-ansible-role/badge/
:target: https://algosec-ansible-role.readthedocs.io/en/latest/
:alt: Documentation Status

Documentation available online at: https://algosec-ansible-role.readthedocs.io/en/latest/

How to build doc's locally?
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Using Docker, running from one folder outside of the project::

$ docker run -it -v $PWD/ansible-role-algosec/:/documents/ ivanbojer/spinx-with-rtd
$ cd docs
$ make html

Using Spinx::

$ cd docs
$ make html

Then see the ``docs/_build`` folder created for the html files.

License
-------

MIT (see full license `here <http://algosec-ansible-role.readthedocs.io/en/latest/license.html>`_)

Author Information
------------------

AlgoSec Official Website
https://www.algosec.com/

Development
-----------

To kickoff local development, just use `pipenv`::

pipenv install

And to use the newly installed virtual environment just run::

pipenv shell



Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansible-role-algosec-0.6.0.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

ansible_role_algosec-0.6.0-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file ansible-role-algosec-0.6.0.tar.gz.

File metadata

  • Download URL: ansible-role-algosec-0.6.0.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.3

File hashes

Hashes for ansible-role-algosec-0.6.0.tar.gz
Algorithm Hash digest
SHA256 b322da97bf9a55d04d1a9ab5cd691023b73f0e9126b086022a645d4b59a789c1
MD5 32525a4038945a7849737ea92b3da035
BLAKE2b-256 573763f54e638533cbce19e429cf4eeb6053f585d02767779f9764da9f471f11

See more details on using hashes here.

File details

Details for the file ansible_role_algosec-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: ansible_role_algosec-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.3

File hashes

Hashes for ansible_role_algosec-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0e8825fe019542c2fa4eef21be4df6cc2c0c4558c050ad448d2f0dd9ec3be7be
MD5 d1279f6d5ae3aeca1bb9fedd68fa2459
BLAKE2b-256 56ae751c8883ccadd025b39ea4d8e7ba75ca6c011282c8e653bd731868ef660c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page