Confluence Cookbook

Description

Installs/Configures an instance of Atlassian Confluence.

Requirements

Platforms

• RHEL/CentOS 6, 7
• Ubuntu 14.04, 16.04

Cookbooks

• apache2
• ark
• database
• java
• mysql
• mysql_connector
• mysql2_chef_gem
• postgresql

JDK/JRE

The Atlassian Confluence Linux installer will automatically configure a bundled JRE.

If you prefer Confluence standalone installation, then you have to manage JDK/JRE 8
(Supported Platforms)
on this node. It can be done with java cookbook and appropricate attributes:

node.set['java']['jdk_version'] = "8"
include_recipe 'java'

Attributes

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

Notice: If ['confluence']['install_type'] is set to installer, then the installer will try to upgrade your Confluence instance located in ['confluence']['install_path'] (if it exists) to the ['confluence']['version'].

If you want to avoid an unexpected upgrade, just set or override ['confluence']['version'] attribute value to that of your current confluence version.

Confluence Database Attributes

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

Confluence JVM Attributes

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

Confluence Tomcat Attributes

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

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_installer] Installs/configures Confluence via Linux installer"
• recipe[confluence::linux_standalone] Installs/configures Confluence via Linux standalone archive"
• recipe[confluence::tomcat_configuration] Configures Confluence's built-in Tomcat
• recipe[confluence::crowd_sso] Configures user authentication with Crowd single sign-on

Usage

Confluence Data Bag

For security purposes it is recommended to use data bag for storing secrets
like passwords and database credentials.

You can override any attributes from the ['confluence'] namespace using the
confluence/confluence data bag. It could be either encrypted or not
encrypted by your choice.

Example:
json
{
"id": "confluence",
"confluence": {
"database": {
"type": "postgresql",
"name": "confluence_db",
"user": "confluence_user",
"password": "confluence_db_password",
}
}
}

(Note - "confluence" nesting level is required!)

These credentials will be used for your Confluence installation instead of
appropriate attribute values.

Data bag's and item's names are optional and can be changed by overriding
attributes ['confluence']['data_bag_name'] and ['confluence']['data_bag_item']

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.

Sponsors

Development of this cookbook has been generously supported in part by
the code contributions of the following organizations:

• University of Pennsylvania
• Parallels Inc.
• Blended Perspectives Inc.

License and Author

• Author:: Mikhail Zholobov (legal90@gmail.com, @legal90)
• Author:: Brian Flad (bflad417@gmail.com, @bflad)
• Author:: Denny Schäfer (trash4you@online.de, @tuxinaut)
• Copyright:: 2013, Brian Flad
• Copyright:: 2013, University of Pennsylvania
• Copyright:: 2013, Denny Schäfer

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.