chef-confluence

Description

Installs/Configures Atlassian Confluence server. Please see [COMPATIBILITY.md](COMPATIBILITY.md) for more information about Confluence releases that are tested and supported by this cookbook and its versions.

Requirements

Platforms

• CentOS 6
• RedHat 6
• Ubuntu 12.04

Databases

• MySQL
• Postgres

Cookbooks

Required Opscode Cookbooks

• apache2 (if using Apache 2 proxy)
• database
• mysql (if using MySQL database)
• postgresql (if using Postgres database)

Required Third-Party Cookbooks

• mysql_connector (if using MySQL database)

Suggested Opscode Cookbooks

• java

JDK/JRE

The Atlassian Confluence Linux installer will automatically configure a bundled JRE. If you wish to use your own JDK/JRE, with say the java cookbook, then as of this writing it must be Oracle JDK 7 (Supported Platforms)

Necessary configuration with java cookbook:
* node['java']['install_flavor'] = "oracle"
* node['java']['jdk_version'] = "7"
* node['java']['oracle']['accept_oracle_download_terms'] = true
* recipe[java]

Attributes

These attributes are under the node['confluence'] namespace.

Confluence Database Attributes

All of these node['confluence']['database'] attributes are overridden by confluence/confluence encrypted data bag (Hosted Chef) or data bag (Chef Solo), if it exists

Confluence JVM Attributes

These attributes are under the node['confluence']['jvm'] namespace.

Confluence Tomcat Attributes

These attributes are under the node['confluence']['tomcat'] namespace.

Any node['confluence']['tomcat']['key*'] attributes are overridden by confluence/confluence encrypted data bag (Hosted Chef) or data bag (Chef Solo), if it exists

Recipes

• recipe[confluence] Installs/configures Atlassian Confluence
• recipe[confluence::apache2] Installs/configures Apache 2 as proxy (ports 80/443)
• recipe[confluence::database] Installs/configures MySQL/Postgres server, database, and user for Confluence
• recipe[confluence::linux_cluster-standalone] Installs/configures Confluence Cluster via Linux standalone archive"
• recipe[confluence::linux_cluster-war] Deploys Confluence Cluster WAR on Linux"
• recipe[confluence::linux_installer] Installs/configures Confluence via Linux installer"
• recipe[confluence::linux_standalone] Installs/configures Confluence via Linux standalone archive"
• recipe[confluence::linux_war] Deploys Confluence WAR on Linux"
• recipe[confluence::tomcat_configuration] Configures Confluence's built-in Tomcat
• recipe[confluence::windows_cluster-standalone] Installs/configures Confluence Cluster via Windows standalone archive"
• recipe[confluence::windows_cluster-war] Deploys Confluence Cluster WAR on Windows"
• recipe[confluence::windows_installer] Installs/configures Confluence via Windows installer"
• recipe[confluence::windows_standalone] Installs/configures Confluence via Windows standalone archive"
• recipe[confluence::windows_war] Deploys Confluence WAR on Windows"

Usage

Confluence Server Data Bag

For securely overriding attributes on Hosted Chef, create a confluence/confluence encrypted data bag with the model below. Chef Solo can override the same attributes with a confluence/confluence unencrypted data bag of the same information.

required:
* ['database']['type'] "mysql" or "postgresql"
* ['database']['host'] FQDN or "localhost" (localhost automatically
installs ['database']['type'] server)
* ['database']['name'] Name of Confluence database
* ['database']['user'] Confluence database username
* ['database']['password'] Confluence database username password

optional:
* ['database']['port'] Database port, standard database port for
['database']['type']
* ['tomcat']['keyAlias'] Tomcat HTTPS Java Keystore keyAlias, defaults to self-signed certifcate
* ['tomcat']['keystoreFile'] Tomcat HTTPS Java Keystore keystoreFile, self-signed certificate
* ['tomcat']['keystorePass'] Tomcat HTTPS Java Keystore keystorePass, self-signed certificate

Repeat for other Chef environments as necessary. Example:

{
  "id": "confluence"
  "development": {
    "database": {
      "type": "postgresql",
      "host": "localhost",
      "name": "confluence",
      "user": "confluence",
      "password": "confluence_db_password",
    },
    "tomcat": {
      "keyAlias": "not_tomcat",
      "keystoreFile": "/etc/pki/java/wildcard_cert.jks",
      "keystorePass": "not_changeit"
    }
  }
}

Confluence Server Installation

The simplest method is via the default recipe, which uses node['confluence']['install_type'] to determine best method.

• Optionally (un)encrypted data bag or set attributes
  • knife data bag create confluence
  • knife data bag edit confluence confluence --secret-file=path/to/secret
• Add recipe[confluence] to your node's run list.

Custom Confluence Configurations

Using individual recipes, you can use this cookbook to configure Confluence to fit your environment.

• Optionally (un)encrypted data bag or set attributes
  • knife data bag create confluence
  • knife data bag edit confluence confluence --secret-file=path/to/secret
• Add individual recipes to your node's run list.

Testing and Development

Here's how you can quickly get testing or developing against the cookbook thanks to Vagrant and Berkshelf.

gem install bundler --no-ri --no-rdoc
git clone git://github.com/bflad/chef-confluence.git
cd chef-confluence
bundle install
bundle exec vagrant up BOX # BOX being centos6 or ubuntu1204

You may need to add the following hosts entries:

• 33.33.33.10 confluence-centos-6
• 33.33.33.11 confluence-ubuntu-1204

The running Confluence server is accessible from the host machine:

CentOS 6 Box:
* Web UI: https://33.33.33.10/

Ubuntu 12.04 Box:
* Web UI: https://33.33.33.11/

You can then SSH into the running VM using the vagrant ssh command.
The VM can easily be stopped and deleted with the vagrant destroy
command. Please see the official Vagrant documentation
for a more in depth explanation of available commands.

Contributing

Please use standard Github issues/pull requests and if possible, in combination with testing on the Vagrant boxes.

License and Author

Author:: Brian Flad (bflad@wharton.upenn.edu)

Copyright:: 2013

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.