Skip to content
This repository has been archived by the owner on Nov 9, 2020. It is now read-only.

Latest commit

 

History

History
84 lines (65 loc) · 4.07 KB

README.md

File metadata and controls

84 lines (65 loc) · 4.07 KB
Raw

Column

Build Status codecov Latest Version Python Versions Format License

Overview

Column is a thin wrapper on top of the Ansible API to serve as an entry point for other code when Ansible is needed. Because Ansible internal API is not officially exposed and thus changes frequently, this wrapper can be used instead of touching Ansible directly so that any further Ansible API changes will only incur change in this module.

This module exposes two classes: column.APIRunner and column.SubprocessRunner

Both of these implement the API as described in column.Runner. Each runner exposes two public methods: run_playbook() and run_module().

Try it out

Prerequisites

  • python 2.7 (python 3 is not fully supported by ansible)
  • ansible 2.x
  • six library

Install & use

Install with pip:

pip install column

and in your python code do:

from column import APIRunner
api_runner = APIRunner()
api_runner.run_module('localhost', remote_user=None)

Running the API

python column/api/run.py

Running the API in uWSGI

pip install uwsgi
uwsgi --socket 0.0.0.0:48620 --protocol=http -w column.api.wsgi

Running in Docker

1. Update 127.0.0.1 to 0.0.0.0 in the etc/column/column.conf file
2. docker build -t column-image .
3. docker run -d -p 48620:48620 -v <playbook-dir>:<container-dir> column-image (the directory should contain the playbook file)

Documentation

TBD

Releases & Major Branches

Column is still in alpha state, currently at version 0.4.8.

Contributing

The Column project team welcomes contributions from the community. Before you start working with Column, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to CONTRIBUTING.md.

License

Column 0.4.8

Copyright © 2017 VMware, Inc. All rights reserved.

The BSD-2 license (the "License") set forth below applies to all parts of the VMware Column 0.4.8 project. You may not use this file except in compliance with the License.

BSD-2 License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.