Skip to content

Latest commit

 

History

History
119 lines (84 loc) · 4.84 KB

README.md

File metadata and controls

119 lines (84 loc) · 4.84 KB

Ansible Role: edu-sharing-init

The edu-sharing-init role automates the installation and initialization of the edu-sharing platform in a Docker environment. It also facilitates the installation of Alfresco plugins (alfviral,es-update-oersi) and sets up the basic configuration necessary to start using edu-sharing.

Implementation

edu-sharing-init role is included in to the playbook see: system.yml.

- hosts: edusharing
  roles:
    - role: edu-sharing-init
      tags: 
        - edu-sharing-init

or we just want to run only the edu-sharing-init then we run:

ansible-playbook -v -i <host> ansible/system.yml --tags "edu-sharing-init"

This will skip other roles and run only the edu-sharing-init role

Role Variables

edu-sharing-init role allows you to customize certain variables according to your requirements. Here are the default variables:

# Used ony if the tomcat is is still there, if we changed the default one then we can override
tomcat_stop_command: "{{base_dir}}/bin/tomcat.sh stop 2> /dev/null || true"

# Force docker container to use the specific timezone
edu_sharing_docker_timezone: '{{timezone | default("Europe/Berlin",true)}}'

# Basic configuration used for starting and running edu-sharing
edu_sharing_environment_variable:
  - key: COMPOSE_PROJECT_NAME
    value: '{{edu_sharing_docker_project_name}}'
  - key: REPOSITORY_DATABASE_NAME
    value: '{{alfresco_db.name}}'
  - key: REPOSITORY_DATABASE_USER
    value: '{{alfresco_db.user}}'
  - key: REPOSITORY_DATABASE_PASS
    value: '{{alfresco_db.password}}'
  - key: COMMON_BIND_HOST
    value: '{{common_bind_host | default("127.0.0.1",true)}}'
  - key: REPOSITORY_SERVICE_GUEST_USER
    value: '{{guest_user_name | default("esguest",true)}}'
  - key: REPOSITORY_SERVICE_GUEST_PASS
    value: '{{guest_user_password | default("esguest",true)}}'
  - key: REPOSITORY_SERVICE_ADMIN_PASS
    value: '{{alf_password}}'
  - key: SERVICES_RENDERING_DATABASE_NAME
    value: '{{esrender_db.name}}'
  - key: SERVICES_RENDERING_DATABASE_USER
    value: '{{esrender_db.user}}'
  - key: SERVICES_RENDERING_DATABASE_PASS
    value: '{{esrender_db.password}}'

Tasks

The tasks/ directory contains all the ansible tasks.

  1. main: The main task or entry task for ansible.
  2. model: This task is used to override existing images and build a custom container.
  3. config-env: This task is used to copy and override the .env file.
  4. clean-edu-sharing-volumes: This task deletes all volumes except the database and alfresco content data whenever the version changes.
  5. alfresco-model: This task is used to override the alfresco extension models.
  6. set_edu_docker_inst_dir: Used to refactor the folder name according to docker convention, for example edu-sharing-9.0.1-RC1 with become edu-sharing-9_0_1_rc1
  7. extract_image_from_repository_service: used to get the image of the repository-service, since it is different from RC and release version

Templates

The templates/ directory edu-sharing override docker files.

It contains:

  1. 3_repository-service-volume-override-common.yml Used to override the volumes,and add the custom image, work only for version 7.
  2. docker-compose.override.yml.j2 Used to override the volumes,and add the custom image, work only for version 8 and above.
  3. Dockerfile_repository-service.j2 Used to override the Image and create a custom image

Vars

The vars/ directory contains the edu-sharing versions, and the necessary commands.

in order to add another version of edu-sharing we create a file with that version, example: if we want to have version 8.5.0 then we create a file in vars/versions/8.5.0.yml

 edu_sharing_archive_url: https://artifacts.edu-sharing.com/repository/maven-remote/org/edu_sharing/edu_sharing-projects-community-deploy-docker-compose/8.1.0/edu_sharing-projects-community-deploy-docker-compose-8.1.0-bin.zip

 # In newer versions Edu-sharing may change the deploy commands, if so we can change them here
 # {service} is an variable tha ansible will replace, based on what service we want to execute the action
 edu_sharing_deploy_command: 'sg docker -c "./utils.sh start {service}"'
 edu_sharing_restart_command: 'sg docker -c "./utils.sh restart {service}"'
 # remove docker images from server
 edu_sharing_undeploy_command: 'sg docker -c "./utils.sh stop {service}"'
 edu_sharing_remove_containers_command: |
     yes | sg docker -c "./utils.sh remove {service}"

 # this will remove images,containers and volumes, so be carefully when we use it.
 edu_sharing_purge_all_command: |
     yes | sg docker -c "./utils.sh purge {service}"

 # Edu-sharing backup command
 edu_sharing_backup_command: 'sg docker -c "./utils.sh backup {options}"'
 # Edu-sharing restore command
 edu_sharing_restore_command: 'sg docker -c "./utils.sh restore {options}"'