idealista/opengrok_role

Ansible role to deploy Opengrok to a Tomcat server

OpenGrok Ansible role

This Ansible role installs {OpenGrok in a Debian environment. The app is deployed to a Tomcat server and will expose the endpoint yourtomcatip:8080/source/.

• Getting Started
  • Prerequisities
  • Installing
• Usage
• Testing
• Built With
• Versioning
• Authors
• License
• Contributing

Getting Started

These instructions will get you a copy of the role for your Ansible playbook. Once launched, it will deploy OpenGrok to a Tomcat server in a Debian system.

Prerequisities

Ansible 5.2.0 version installed. Inventory destination should be a Debian environment. A Tomcat server needs to be installed in your host machine (you can install it using our Tomcat role).

For testing purposes, Molecule with Docker as driver.

Installing

Create or add to your roles dependency file (e.g requirements.yml):

- src: idealista.opengrok_role
  version: 1.0.0
  name: opengrok

Install the role with ansible-galaxy command:

ansible-galaxy install -p roles -r requirements.yml -f

Use in a playbook:

---
- hosts: someserver
  roles:
    - role: opengrok

Usage

Look to the defaults properties file to see the possible configuration properties.

Testing

pipenv install -r test-requirements.txt
pipenv run molecule test

Built With

Versioning

For the versions available, see the tags on this repository.

Additionaly you can see what changed in each version in the CHANGELOG.md file.

Authors

• Idealista - Work with - idealista

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache 2.0 license - see the LICENSE file for details.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

opengrok_role's Issues

Make role compatible with OpenGrok last version

Prerequisites

• Put an X between the brackets on this line if you have done all of the following:
  • Checked that your issue isn't already filled: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aidealista
  • Checked that there is not already provided the described functionality

Description

Oracle has changed the way OpenGrok is deployd, so this role is not compatible anymore with last version

Instance base and sources root not differentiated

Prerequisites

• Put an X between the brackets on this line if you have done all of the following:
  • Checked that your issue isn't already filled: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aidealista
  • Checked that there is not already provided the described functionality

Description

With the current variables set, it could be a bit tricky to index properly. Separating Opengrok's instance base and sources root would make it easier.

Versions

1.0.0

[REFACTOR] Update configuration to fix tests execution

Description

To run the tests is necessary to update some deprecated configuration. Furthermore, is a good practice adding pip environment files to the project.

Link/s to the specific code that needs a refactor (if applicable)

• Update docker image version in molecule.yml
• Update tomcat role using underscore in requirements.yml
• Update ansible version in test-requirements.txt

[REFACTOR] Rename role using underscore

Description

Rename the role using underscore. This is a mayor change.

More information: https://galaxy.ansible.com/docs/contributing/creating_role.html#:~:text=Role%20names%20are%20limited%20to,'-'%2C%20and%20space.

Upgrade Molecule version (and Ansible minimum version)

Prerequisites

• Put an X between the brackets on this line if you have done all of the following:
  • Checked that your issue isn't already filled: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aidealista
  • Checked that there is not already provided the described functionality

Description

It has become a bit difficult to test the role with Molecule 1.25, so upgrade the Molecule version (and therefore, Ansible minimum version).

[FEATURE] General role update

Description

This role has fall behind our other roles regarding versions, tests and such stuff we've been added over the time:

• Upgrade Pipfile versions
• Upgrade goss version
• Add .gitattributes file
• Debian 11 support
• There is no travis email notification config: https://github.com/idealista/jira_role/blob/master/.travis.yml#L20-L25

Why is this needed?

So we keep the role up to date.

Additional Information

See related issues in other roles:

idealista/prometheus_mysqld_exporter_role#25
idealista/mysql_role#70
idealista/goreplay-role#27