src.dualinventive.com/devops/ansible/external-roles/confluence/README.md

71 lines
2.2 KiB
Markdown

# Role Name
Role tp help install or update the Atlassian Confluence.
## Requirements
For running Atlassian Confluence you need a little bit more
- java
- database
- init script
*java* is out of scope for this playbook. I can't force you to install
any version of java on your server. Use any existing java roles to do that.
I have my own role `hudecof.java` to do that.
You could preffer another *database* as me. So this is out of scope too.
The *tar.gz* version do not have startup script. I use `supervisord` to do this job.
I will generate template for `supervisord` , `init.d` and `systemd` and put it into *installation directory*.
If you are updating, shutdown you old instance manually. This role do not handle this!.
It will just setup your new instance with your customizations.
## Role Variables
`atlassian_confluence_version` is the verion you want to install. This is the only one variable you need to change, the others are optional.
`atlassian_confluence_baseurl` is the URL where you can find the *tar.gz* files. If you have your own mirror, change it.
`atlassian_confluence_basedir` is path where to download nad extract the *tar.gz* file, defaults to `/opt/atlassian`.
`atlassian_confluence_home` is the `confluence.home`, aka you data directory.
`atlassian_confluence_user`, `atlassian_confluence_uid`, `atlassian_confluence_group`, `atlassian_confluence_gid` are variables to setup dedicated user to run the instance
`atlassian_confluence_server_xml` is list of changes to `server.xml` It uses XPath to edit/add/remove exiting properties.
atlassian_confluence_server_xml:
- xpath: /Server/Service/Connector
ensure: present
attribute: proxyPort
value: 443
- xpath: /Server/Service/Connector
ensure: present
attribute: scheme
value: https
`atlassian_confluence_catalina_opts` is the list of custom **CATALINA_OPTS** properties. At this moment you can't change the existing one ;(
For *CrowdSSO* see `CrowdSSO.md`
## Dependencies
This role depends on the `cmprescott.xml` role/library.
## Example Playbook
- hosts: atlassian
roles:
- cmprescott.xml
- hudecof.atlassian-confluence
## License
BSD
## Author Information
Peter Hudec