Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tnewman committed Oct 1, 2017
1 parent 4e9e995 commit 336f0c4
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# kazoo-ansible
Ansible Playbooks to orchestrate the various components of [2600hz Kazoo](https://github.com/2600hz/kazoo).

## Pre-release Notice
kazoo-ansible is currently in a pre-release state and may introduce backward
incompatible changes until 1.0.0 is released and this notice is removed.
This is to provide an opportunity to greatly improve kazoo-ansible without
needing to wait for a major release. Once we are happy with kazoo-ansible,
it will be released as 1.0.0 and subject to backward compatibility
guarantees.

## Features
- Automatically clusters CouchDB, Freeswitch, Kamailio, and Kazoo
- Let's Encrypt TLS certificate generation for Monster UI, including
Expand All @@ -22,11 +30,27 @@ by default to prevent untested versions from making it into production
## License
MIT License

## Installation Instructions
- Install CentOS 7 on all of the hosts that will be managed by kazoo-ansible
- Enable password-less SSH for the user that will run kazoo-ansible on all of
the hosts that will be managed by kazoo-ansible
- Enable password-less sudo on all of the hosts that will be managed by
kazoo ansible
- Install all of the roles from [kazoo-ansible at Ansible Galaxy](https://galaxy.ansible.com/kazoo-ansible/)
- Clone this GitHub repository
- Edit `group_vars/all` and `site.yml` to your liking
- Add hosts for each role in `site.yml` in `/etc/ansible/hosts`
- Run `ansible-playbook site.yml`

## Using kazoo-ansible with Existing Playbooks
If you want to use kazoo-ansible with existing playbooks, simply

## Contributions
There are many ways to contribute:
- Suggestions
- Bug Reports
- Pull Requests
- Donations

## Versioning Strategy
This project uses [Semantic Versioning](http://semver.org). In
Expand Down
5 changes: 5 additions & 0 deletions group_vars/all
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
---
kazoo_domain: kazoo.lan

# Uncomment the line below and comment the kazoo_tls variables to enable
# Let's Encrypt
# kazoo_enable_lets_encrypt: yes

kazoo_tls_certificate: |
-----BEGIN CERTIFICATE-----
MIIDpzCCAo+gAwIBAgIJAPlntr4foo1sMA0GCSqGSIb3DQEBCwUAMGoxCzAJBgNV
Expand Down

0 comments on commit 336f0c4

Please sign in to comment.