lean-delivery / ansible-role-endeca-toolsandframeworks

Ansible Role - Endeca ToolsAndFrameworks

endeca_toolsandframeworks

Summary

---

This role installs Oracle Endeca Tools and Frameworks on Linux platforms which enables the dynamic presentation of content across all channels.

Requirements

• Minimal Version of the ansible for installation: 2.5
• Supported ToolsAndFrameworks versions:
  • 3.x.x
  • 11.x.x
  • higher versions should be retested
• Supported OS:
  • CentOS
    • 6
    • 7

For more information regarding support matrix please visit https://support.oracle.com

MDEX Engine and PlatformServices should be installed preliminarily:

• lean_delivery.endeca_mdex
• lean_delivery.endeca_platformservices

For test scenarios endeca_toolsandframeworks/requirements.yml is used  
If another roles/versions are required, put requirements.yml to molecule/<scenario_name> and remove in molecule.yml lines  
  options:  
    role-file: requirements.yml

Role Variables

• transport - artifact source transport
  Available:

  • web - fetch artifact from custom web uri
  • local - local artifact

• transport_web - URI for http/https artifact e.g. "http://my-storage.example.com/V861200-01.zip"

• transport_local - path for local artifact e.g. "/tmp/V861200-01.zip"

• download_path - local folder for downloading artifacts
  default: /tmp

• tf_version - Endeca ToolsAndFrameworks version

• tf_hostname - Endeca ToolsAndFrameworks hostname
  default: "{{ ansible_fqdn }}"

Set ToolsAndFrameworks version as it's defined in official Oracle Documentation

• base_root - where PlatformServices should be installed
  default: /opt

• tf_service - name of the service
  default: endeca-toolsandframeworks

• install_type - type of installation
  Available:

  • Complete Installation
  • Minimal Installation

• nfs_exports - list of NFS shared folders (to share with ATG Oracle Commerce store application)
  Example:

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

Parameters for ToolsAndFrameworks versions starting from 11.0

• install_group - install group for user
  default: oinstall

• inventory_directory - path to oracle inventory directory
  default: {{ base_root }}/oraInventory

• ora_inst - path to oraInst.loc file
  default: /etc/oraInst.loc

Swap configuration

• swapfile_path - path to swap file
  default: /swapfile

• swapfile_bs_size_mb
  default: 1

• swapfile_count - swap size
  default: 512

• workbench_password - update default workbench admin password (e.g. Admin123)

• workbench_port - workbench port
  default: 8006

Example Playbook

Installing Endeca ToolsAndFrameworks 11.3.0 from local:

- name: "Install ToolsAndFrameworks 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"

Installing Endeca ToolsAndFrameworks 11.3.0 from web with NFS shared folders:

- name: "Install ToolsAndFrameworks 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

Author Information

authors:

• Lean Delivery Team [email protected]

ansible-role-endeca-toolsandframeworks's Issues

Can't check ToolsAndFrameworks host availability

We face an issue with the role:
TASK [lean_delivery.endeca_toolsandframeworks : Check ToolsAndFrameworks host availability] ***
FAILED - RETRYING: Check ToolsAndFrameworks host availability (20 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (19 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (18 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (17 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (16 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (15 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (14 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (13 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (12 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (11 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (10 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (9 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (8 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (7 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (6 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (5 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (4 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (3 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (2 retries left).
FAILED - RETRYING: Check ToolsAndFrameworks host availability (1 retries left).
fatal: [sfe-01-cas.aws.sche-digi.projects.epam.com]: FAILED! => {"attempts": 20, "changed": false, "content": "", "msg": "Status code was -1 and not [200]: Request failed: <urlopen error [Errno -2] Name or service not known>", "redirected": false, "status": -1, "url": "http://sfe-01-cas:8006/ifcr/login"}

It seems as if ansible_hostname returns sfe-01-ca while it's supposed to return sfe-01-cas.projects.com.

Workbench port should be set as variable

SUMMARY

Workbench port (8006) should be set as variable because it can be used by other roles in playbooks

ISSUE TYPE

• Bug Report

COMPONENT NAME

tasks/update-workbench-password.yml

ANSIBLE VERSION

2.5.8

EXPECTED RESULTS

    - name: "Change default workbench admin password"
      uri:
        url: "http://{{ ansible_hostname }}:8006\
        /ifcr/system/userManager/user/admin.changePassword.json"
        user: "{{ workbench_user }}"
        password: "{{ workbench_password_default }}"
        method: "POST"
        body: "oldPwd={{ workbench_password_default }}&newPwd={{ workbench_password }}\
        &newPwdConfirm={{ workbench_password }}"
        return_content: True
        headers:
          Content-Type: "application/x-www-form-urlencoded"
        status_code: "200"
        timeout: "300"

ACTUAL RESULTS

"8006" port should be set in defaults/main.yml

Fail to install with another oracle products

SUMMARY

When another oracle product is already installed on host installation of endeca_toolsandframeworks fails.

Cause:
orainstRoot.sh generates oracle inventory artifacts (/etc/oraInst.loc and inventory directory). Therefore this shell script is not generated (and doesn't need to be executed) if another oracle product created inventory artifacts.

ISSUE TYPE

• Bug Report

COMPONENT NAME

task "Run orainstRoot.sh"

ANSIBLE VERSION

2.5.8

OS / ENVIRONMENT

Centos 6
ToolsAndFrameworks version 11.3

EXPECTED RESULTS

ToolsAndFrameworks role passed successfully

ACTUAL RESULTS

FAILED! => {
    "changed": false,
    "cmd": "/home/endeca/oraInventory/orainstRoot.sh",
    "invocation": {
        "module_args": {
            "_raw_params": "/home/endeca/oraInventory/orainstRoot.sh",
            "_uses_shell": false,
            "argv": null,
            "chdir": null,
            "creates": null,
            "executable": null,
            "removes": null,
            "stdin": null,
            "warn": true
        }
    },
    "msg": "[Errno 2] No such file or directory",
    "rc": 2

Incorrect variables in "Example Playbook" section in README.MD

SUMMARY

Incorrect variables in "Example Playbook" section in README.MD

ISSUE TYPE

• Documentation Report

EXPECTED RESULTS

• 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)"

ACTUAL RESULTS

• role: lean_delivery.endeca_toolsandframeworks
  tf_version: "11.3.0"
  transport: "local"
  transport_local: "http://my-storage.example.com/V861200-01.zip"
  workbench_password: "Admin123"
  nfs_exports:
  - "/home/public *(rw,sync,no_root_squash)"