diff --git a/jboss-standalone/README.md b/jboss-standalone/README.md index 8f2f66f51..0b784975c 100644 --- a/jboss-standalone/README.md +++ b/jboss-standalone/README.md @@ -4,7 +4,7 @@ - Expects CentOS/RHEL 6 or 7 hosts These playbooks deploy a very basic implementation of JBoss Application Server, -version 7. To use them, first edit the "hosts" inventory file to contain the +version 7. To use them, first edit the `hosts` inventory file to contain the hostnames of the machines on which you want JBoss deployed, and edit the group_vars/all file to set any JBoss configuration parameters you need. diff --git a/lamp_haproxy/README.md b/lamp_haproxy/README.md index aeca17d38..2929394c0 100644 --- a/lamp_haproxy/README.md +++ b/lamp_haproxy/README.md @@ -11,7 +11,7 @@ capability to dynamically add and remove web server nodes from the deployment. It also includes examples to do a rolling update of a stack without affecting the service. -(To use this demonstration with Amazon Web Services, please use the "aws" sub-directory.) +(To use this demonstration with Amazon Web Services, please use the `aws` sub-directory.) You can also optionally configure a Nagios monitoring node. @@ -43,7 +43,7 @@ should have you hit different webservers. The Nagios web interface can be reached at http:///nagios/ -The default username and password are "nagiosadmin" / "nagiosadmin". +The default username and password are `nagiosadmin` / `nagiosadmin`. ### Removing and Adding a Node @@ -61,8 +61,8 @@ running on other servers so that the users are not interrupted. In this example the hosts are updated in serial fashion, which means that only one server will be updated at one time. If you have a lot of web server -hosts, this behaviour can be changed by setting the 'serial' keyword in -webservers.yml file. +hosts, this behaviour can be changed by setting the `serial` keyword in +`webservers.yml` file. Once the code has been updated in the source repository for your application which can be defined in the group_vars/all file, execute the following @@ -70,5 +70,5 @@ command: ansible-playbook -i hosts rolling_update.yml -You can optionally pass: -e webapp_version=xxx to the rolling_update +You can optionally pass: `-e webapp_version=xxx` to the `rolling_update` playbook to specify a specific version of the example webapp to deploy. diff --git a/lamp_simple/README.md b/lamp_simple/README.md index d800ff8d8..901772c8b 100644 --- a/lamp_simple/README.md +++ b/lamp_simple/README.md @@ -17,7 +17,7 @@ This LAMP stack can be on a single node or multiple nodes. The inventory file bensible Here the webserver would be configured on the local host and the dbserver on a -server called "bensible". The stack can be deployed using the following +server called `bensible`. The stack can be deployed using the following command: ansible-playbook -i hosts site.yml diff --git a/lamp_simple_rhel7/README.md b/lamp_simple_rhel7/README.md index ae0ba9a07..a46c93c46 100644 --- a/lamp_simple_rhel7/README.md +++ b/lamp_simple_rhel7/README.md @@ -22,7 +22,7 @@ This LAMP stack can be on a single node or multiple nodes. The inventory file bensible Here the webserver would be configured on the local host and the dbserver on a -server called "bensible". The stack can be deployed using the following +server called `bensible`. The stack can be deployed using the following command: ansible-playbook -i hosts site.yml diff --git a/mongodb/README.md b/mongodb/README.md index 24ee8d907..573d8a3d8 100644 --- a/mongodb/README.md +++ b/mongodb/README.md @@ -84,12 +84,12 @@ all the processes are secured using keyfiles. Edit the group_vars/all file to reflect the below variables. -1) iface: 'eth1' # the interface to be used for all communication. +1) `iface: 'eth1' # the interface to be used for all communication`. -2) Set a unique mongod_port variable in the inventory file for each MongoDB +2) Set a unique `mongod_port` variable in the inventory file for each MongoDB server. -3) The default directory for storing data is /data, please do change it if +3) The default directory for storing data is `/data`, please do change it if required. Make sure it has sufficient space: 10G is recommended. ### Deployment Example @@ -168,7 +168,7 @@ replication set, we should get a similar output. We can check the status of the shards as follows: connect to the mongos service -'mongo localhost:8888/admin -u admin -p 123456' and issue the following command to get +`mongo localhost:8888/admin -u admin -p 123456` and issue the following command to get the status of the Shards: diff --git a/phillips_hue/README.md b/phillips_hue/README.md index d25fbe11b..42f295c00 100644 --- a/phillips_hue/README.md +++ b/phillips_hue/README.md @@ -17,7 +17,7 @@ Also make sure that you can control the lights normally from the free iPhone or ### Step 1 -Open up the username_info.yml file and change the IP Address to the IP address of your Hue bridge. +Open up the [username_info.yml](username_info.yml) file and change the IP Address to the IP address of your Hue bridge. ```nano username_info.yml``` @@ -33,11 +33,12 @@ Ignore the `username` and `body_info` fields. The `username` is automatically g ### Step 2 -For the Playbooks to work correctly you must run the `register.yml` playbook first-> +For the Playbooks to work correctly you must run the `register.yml` playbook first: ```ansible-playbook register.yml``` -The playbook will run and then prompt you on the terminal window-> +The playbook will run and then prompt you on the terminal window: + ``` [PROMPT USER TO PRESS PHYSICAL BUTTON HUE HUB] Press the button on the hub now...: diff --git a/tomcat-memcached-failover/README.md b/tomcat-memcached-failover/README.md index 0c64d5c64..98a1d1ec0 100644 --- a/tomcat-memcached-failover/README.md +++ b/tomcat-memcached-failover/README.md @@ -11,7 +11,7 @@ This playbook deploys a failover solution for clustered Tomcat using Nginx as lo For more detail about session management, see https://github.com/magro/memcached-session-manager -This playbook also deploys a demo web app (https://github.com/magro/msm-sample-webapp) to test the session management. +This playbook also deploys a [demo web app](https://github.com/magro/msm-sample-webapp) to test the session management. ## Initial setup of inventory file diff --git a/tomcat-standalone/README.md b/tomcat-standalone/README.md index b125211d8..7b4262485 100644 --- a/tomcat-standalone/README.md +++ b/tomcat-standalone/README.md @@ -4,7 +4,7 @@ - Expects CentOS/RHEL 6.x hosts These playbooks deploy a very basic implementation of Tomcat Application Server, -version 7. To use them, first edit the "hosts" inventory file to contain the +version 7. To use them, first edit the `hosts` inventory file to contain the hostnames of the machines on which you want Tomcat deployed, and edit the group_vars/tomcat-servers file to set any Tomcat configuration parameters you need.