Ansible Gluu: Customization Role

gluu-customization is an Ansible role that helps you customize files on a Gluu Server. You can copy XHTML pages, images, and style resources, or edit WAR files to update translations, for example.

Table of Contents

• Requirements
• Installation
• Update
• Role Variables
• Deploying
• Example Playbook
• Sample Projects

History

Gluu is an open-source server for authentication and API access management. It allows organizations to provide single sign-on, strong authentication, and centralized management.

Requirements

To deploy, you need:

• Ansible installed on your deployment machine.

Installation

gluu-customization is available on Ansible Galaxy. To install it, use the following command:

$ ansible-galaxy install GuillaumeSmaha.gluu-customization

Update

To update the role, use the --force parameter when installing. Here’s the command:

$ ansible-galaxy install --force GuillaumeSmaha.gluu-customization

Role Variables

vars:

  # Specify a custom version of the package to install.
  gluu_version: 3.1.4

  # Files to copy into /etc/gluu/conf in the Gluu container.
  gluu_copy_configuration_files:

  # XHTML pages to copy into /etc/gluu/jetty/{{ module }}/custom/pages.
  gluu_copy_pages:

  # Resources to copy into /etc/gluu/jetty/{{ module }}/custom/static.
  gluu_copy_resources:

  # Files to copy into the WAR file.
  gluu_customize_wars:

Deploying

To deploy, follow these steps:

1. Create a hosts file. Refer to the Ansible inventory documentation for help.
2. Create a playbook for deployment, like deploy.yml.
3. Set up role variables (see Role Variables).
4. Include the GuillaumeSmaha.gluu-customization role in your play.
5. Run the deployment playbook:

$ ansible-playbook -i hosts deploy.yml

If set up correctly, this will install the Gluu Cluster Manager on the host.

Example Playbook

In the example folder, you can find a sample project demonstrating deployment.

To run it, you need Vagrant and the role installed. Visit https://www.vagrantup.com for more details on Vagrant and our Installation section.

$ cd example
$ vagrant plugin install vagrant-lxc
$ vagrant plugin install vagrant-hostmanager
$ vagrant up --provider=lxc
$ ansible-galaxy install GuillaumeSmaha.gluu-setup GuillaumeSmaha.gluu-customization
$ ansible-playbook -i env/ubuntu deploy.yml
$ ansible-playbook -i env/centos deploy.yml

Access Gluu by visiting:

• https://gluu-customization-ubuntu/

or

• https://gluu-customization-centos/

Sample Projects

You can find a complete example of a playbook here:

• Gluu Playbook Example