Endeca Tools and Frameworks

Summary

This role is used to install Oracle Endeca Tools and Frameworks on Linux systems. It helps to present content dynamically across various platforms.

Requirements

• Minimum Ansible version for installation: 2.5
• Supported Tools and Frameworks versions:
  • 3.x.x
  • 11.x.x
  • Higher versions need to be retested
• Supported Operating Systems:
  • CentOS
    • 6
    • 7

For more details on supported versions, please visit https://support.oracle.com

Make sure that MDEX Engine and PlatformServices are installed first:

• lean_delivery.endeca_mdex
• lean_delivery.endeca_platformservices

For testing, use endeca_toolsandframeworks/requirements.yml  
If other roles/versions are needed, place requirements.yml in molecule/<scenario_name> and remove the following lines in molecule.yml:  
  options:  
    role-file: requirements.yml

Role Variables

• transport - Source for artifacts
  Available:

  • web - Download from a web link
  • local - Use a local file

• transport_web - Web link for HTTP/HTTPS artifacts (e.g. "http://my-storage.example.com/V861200-01.zip")

• transport_local - Local file path for artifacts (e.g. "/tmp/V861200-01.zip")

• download_path - Folder on the local machine for downloaded files
  Default: /tmp

• tf_version - Version of Endeca Tools and Frameworks

• tf_hostname - Hostname for Endeca Tools and Frameworks
  Default: "{{ ansible_fqdn }}"

Specify Tools and Frameworks version as per official Oracle Documentation

• base_root - Installation directory for PlatformServices
  Default: /opt

• tf_service - Service name
  Default: endeca-toolsandframeworks

• install_type - Type of installation
  Available:

  • Complete Installation
  • Minimal Installation

• nfs_exports - List of NFS shared directories (for use with ATG Oracle Commerce store application)
  Example:

      nfs_exports:  
        - "/home/public *(rw,sync,no_root_squash)"

Parameters for Tools and Frameworks versions from 11.0 onward

• install_group - User install group
  Default: oinstall

• inventory_directory - Path to the Oracle inventory directory
  Default: {{ base_root }}/oraInventory

• ora_inst - Path to the oraInst.loc file
  Default: /etc/oraInst.loc

Swap Configuration

• swapfile_path - Path to the swap file
  Default: /swapfile

• swapfile_bs_size_mb
  Default: 1

• swapfile_count - Size of the swap
  Default: 512

• workbench_password - Set a new password for the default admin user (e.g. Admin123)

• workbench_port - Port for the workbench
  Default: 8006

Example Playbook

Install Endeca Tools and Frameworks 11.3.0 from a local file:

- name: "Install Tools and Frameworks 11.3.0 from local"
  hosts: all

  roles:
    - role: lean_delivery.endeca_mdex
      transport: "local"
      transport_local: "/tmp/V861206-01.zip"
    - role: lean_delivery.endeca_platformservices
      transport: "local"
      transport_local: "/tmp/V861203-01.zip"
    - role: lean_delivery.endeca_toolsandframeworks
      tf_version: "11.3.0"
      transport: "local"
      transport_local: "/tmp/V861200-01.zip"
      workbench_password: "Admin123"
  vars:
    base_root: "/opt"
    mdex_version: "11.3.0"
    ps_version: "11.3.0"

Install Endeca Tools and Frameworks 11.3.0 from a web link with NFS shared folders:

- name: "Install Tools and Frameworks 11.3.0 from web with NFS shared folders"
  hosts: all

  roles:
    - role: lean_delivery.endeca_mdex
      transport: "web"
      transport_web: "http://my-storage.example.com/V861206-01.zip"
    - role: lean_delivery.endeca_platformservices
      ps_version: "11.3.0"
      transport: "web"
      transport_web: "http://my-storage.example.com/V861203-01.zip"
    - role: lean_delivery.endeca_toolsandframeworks
      tf_version: "11.3.0"
      transport: "web"
      transport_web: "http://my-storage.example.com/V861200-01.zip"
      workbench_password: "Admin123"
      nfs_exports:
        - "/home/public *(rw,sync,no_root_squash)"
  vars:
    base_root: "/opt"
    mdex_version: "11.3.0"
    ps_version: "11.3.0"

- hosts: servers
  roles:
    - { role: ansible-role-endeca-toolsandframeworks, x: 42 }

License

Apache License

Author Information

Authors:

• Lean Delivery Team team@lean-delivery.com