Usage

Usage

Prerequisites

Required

1. AEM Quickstart jar file
2. AEM Dispatcher module for your web server
3. AEM License Key for your client

Optional

1. Java JDK RPM file. Java or OpenJDK
2. Custom dispatcher.any file

Setup

There are two options for preparing the vagrant configuration: Answering questions during setup or creating a parameter file.

Setup with Prompts

There is a setup script which will prompt for necessary configuration needs. This script will prepare the templated files so Vagrant will provision the system correct. Usage from root folder:

> setup/setup.rb

This will create a file ./setup/parameters.json containing the responses. This allows for other teams to quickly reuse an existing configuration.

Setup with Parameter File

The setup script will output all answers to the prompted questions to a file for future use. This file can also be manually created and specified as a parameter to the setup script:

> setup/setup.rb setup/parameters.json

Doing so will read the file, and configure the setup accordingly. If any required parameter is missing, that item will be requested via a prompt.

Keep in mind that the setup process will replace all contents of the parameter file with the new information.

This is an example of a file which shows format and parameters:

{
  "client" : "test",
  "jdk_pkg" : "",
  "aem_jar" : "/path/to/aem-quickstart-6.1.jar",
  "dispatcher_mod" : "/path/to/dispatcher-apache2.4-4.1.10.so",
  "dispatcher_any" : ""
}

Setup Parameters

The following are the parameters which are needed in order to setup the Vagrant and puppet configuration files. They are propmpted for in the script and used in the JSON parameter file:

client

Required. This is the name of the client for which the VM is intended. This is used as way to distinguish this system from others on the host. It affects:

• VM name in VirtualBox
• Host name for accessing dispatcher content (See Access Points).
• Docroot in the HTTP Server configurations.

Format: Any valid string.

jdk_pkg

Optional. This specifies the package to use when installing the JDK. If not provided, the default JDK for the system will be used. Format: fully qualified path to file.

aem_jar

Required. This specifies the location of the AEM installation jar. This file is not provided as part of this project, and must be provided by the consumer. Format: fully qualified path to file.

aem_license

Required. This is the license key for running the AEM system. Format: String.

dispatcher_mod

Required. This specifies the location of the AEM dispatcher module. This file is not provided as part of this project, and must be provided by the consumer. Format: fully qualified path to file.

dispatcher_any

Optional. This is a dispatcher.any file which can be specified for use, instead of the default template Format: fully qualified path to file.

Vagrant

VM Initialization

Once the setup has been accomplished, the vagrant system can be started:

> vagrant up

This step will take time to run, as it is configuring and setting up all of the software on the guest.

VM Re-provisioning

If there is an update to the setup defintions, then a system reprovision may be required. This is as simple as executing this command while the VM is running:

> vagrant provision