Commit 43afd6014e683c10b309de803d5bb560f7f7fb56
1 parent
eeeaa56d96
Exists in
master
and in
1 other branch
update readme file according to latest changes
Showing
1 changed file
with
3 additions
and
2 deletions
Show diff stats
README.md
1 | # Alfresco benchmark playbook | 1 | # Alfresco benchmark playbook |
2 | 2 | ||
3 | This ansible playbook allows one to easily deploy an Alfresco benchmark infrastructure on multiple servers. | 3 | This ansible playbook allows one to easily deploy an Alfresco benchmark infrastructure on multiple servers. |
4 | 4 | ||
5 | ## Requirements | 5 | ## Requirements |
6 | 6 | ||
7 | ### Software requirement | 7 | ### Software requirement |
8 | 8 | ||
9 | The playbook has been written and tested with Ansible 2.2. Some additionnal modules have been added to the playbook: | 9 | The playbook has been written and tested with Ansible 2.2. Some additionnal modules have been added to the playbook: |
10 | 10 | ||
11 | * ansible-xml by cmprescott (requires python-lxml on remote end) | 11 | * ansible-xml by cmprescott (requires python-lxml on remote end) |
12 | * selenium | 12 | * selenium |
13 | 13 | ||
14 | ### Architectural requirement | 14 | ### Architectural requirement |
15 | 15 | ||
16 | This playbook doesn't deploy SSH keys so please make sure you're using it on nodes that already have the needed SSH keys. | 16 | This playbook doesn't deploy SSH keys so please make sure you're using it on nodes that already have the needed SSH keys. |
17 | At the moment the target hosts need to have direct acces to internet as we are using public repos. | 17 | At the moment the target hosts need to have direct acces to internet as we are using public repos. |
18 | 18 | ||
19 | Also all names used in the inventory file need to be fully qualified DNS names resolvable by all hosts. | 19 | Also all names used in the inventory file need to be fully qualified DNS names resolvable by all hosts. |
20 | 20 | ||
21 | ## How to use: | 21 | ## How to use: |
22 | 22 | ||
23 | Edit the _inventory_ file and add your (FQDN) hostnames to the appropriate section. If you don't understand the roles of each server, you should probably start reading [Derek Huley's documentation](https://github.com/AlfrescoBenchmark/alfresco-benchmark/tree/master/docs) about the [Alfresco benchmark framework](https://github.com/AlfrescoBenchmark). | 23 | Edit the _inventory_ file and add your (FQDN) hostnames to the appropriate section. If you don't understand the roles of each server, you should probably start reading [Derek Huley's documentation](https://github.com/AlfrescoBenchmark/alfresco-benchmark/tree/master/docs) about the [Alfresco benchmark framework](https://github.com/AlfrescoBenchmark). |
24 | 24 | ||
25 | To start using the playbook simply start it with: | 25 | To start using the playbook simply start it with: |
26 | 26 | ||
27 | ``` | 27 | ``` |
28 | $ ansible-playbook -i inventory alfbm.yml | 28 | $ ansible-playbook -i inventory alfbm.yml |
29 | ``` | 29 | ``` |
30 | 30 | ||
31 | If you're loging in as a normal user and need to "sudo", use the command bellow: | 31 | If you're loging in as a normal user and need to "sudo", use the command bellow: |
32 | 32 | ||
33 | ``` | 33 | ``` |
34 | $ ansible-playbook -i inventory alfbm.yml -b -K | 34 | $ ansible-playbook -i inventory alfbm.yml -b -K |
35 | ``` | 35 | ``` |
36 | If some options need to be changed (e.g. java or tomcat version, etc...), edit the group_vars/all file or the host_vars/<HOSTNAME> if the variable is host specific. | ||
37 | |||
36 | ## TODO | 38 | ## TODO |
37 | 39 | ||
38 | * Make it possible to download software from the Ansible machine instead of target machine (in case target cannot access internet). | 40 | * Make it possible to download software from the Ansible machine instead of target machine (in case target cannot access internet). |
39 | * Allow Oracle JDK usage | 41 | * Allow Oracle JDK usage |
40 | * RedHat like environments | ||
41 | * Selenium install tasks for systemd enabled OS | ||
42 | * Allow non-key based play of the book | 42 | * Allow non-key based play of the book |
43 | * Attach real VNC server to be able to see what selenium actually doing headless | 43 | * Attach real VNC server to be able to see what selenium actually doing headless |
44 | * move all artifacts URL in a dict, which contains Alfresco version as keys |