Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam Stephens committed Jul 14, 2016
1 parent e7eef32 commit 3cba93d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,18 +104,23 @@ Class parameters:
* **ldap_* **: LDAP connection details used for creating local user accounts from AD users
* **memcached_host**: name or IP of memcached server (localhost)
* **memcached_port**: port to use for memcached (11211)
* **metrics_enable**: whether to enable the sentry metrics (false)
* **metrics_backend**: which metrics backend to enable (statsd)
* **organization**: default organization to create, and in which to create new users
* **path**: path into which to install Sentry, and create the virtualenv (/srv/sentry)
* **redis_host**: name or IP of Redis server (localhost)
* **redis_port**: port to use for Redis (6379)
* **secret_key**: string used to hash cookies (fqdn_rand_string(40))
* **smtp_host**: name or IP of SMTP server (localhost)
* **ssl_* **: Apache SSL controls. The `ssl_cert` and `ssl_key` parameters reference files on the Sentry server. Your Sentry profile class or other higher level class should manage the installation of these file resources.
* **statsd_host**: hostname of statsd server (localhost)
* **statsd_port**: port for statsd server (8125)
* **url**: source URL form which to install Sentry (false, use [PyPI](https://pypi.python.org/pypi/sentry/))
* **user**: UNIX user to own virtualenv, and run background workers (sentry)
* **version**: the Sentry version to install
* **vhost**: the URL at which users will access the Sentry GUI
* **wsgi_* **: mod_wsgi controls
* **worker_concurrency**: number of concurrent workers

### sentry::setup
This private class ensures that all of the Sentry prerequisites are installed. It will create the direcotry into which Sentry will be installed, create the Sentry user and group, create a Python virtual environment, and install the RPM and `pip` dependencies.
Expand Down
8 changes: 8 additions & 0 deletions manifests/init.pp
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@
#
# memcached_port: port to use for memcached (11211)
#
# metrics_enable: whether to enable the sentry metrics (false)
#
# metrics_backend: which metrics backend to enable (statsd)
#
# organization: default organization to create, and in which to create new users
#
# path: path into which to install Sentry, and create the virtualenv (/srv/sentry)
Expand All @@ -48,6 +52,10 @@
#
# ssl_*: Apache SSL controls
#
# statsd_host: hostname of statsd server (localhost)
#
# statsd_port: port for statsd server (8125)
#
# url: source URL from which to install Sentry. (false, use PyPI)
#
# user: UNIX user to own virtualenv, and run background workers (sentry)
Expand Down

0 comments on commit 3cba93d

Please sign in to comment.