Prepare APB for v0.1.0

* Update apb parameters
* Add parameters and walkthrough to README

Author: alessfg

Dockerfile

@@ -25,18 +25,18 @@ MDAKICAgIHBhcmFtZXRlcnM6CiAgICAgIC0gbmFtZTogbmdpbnhfcGx1c19pbWFnZQogICAgICAg\
 IGRlZmF1bHQ6IG9wZW5zaGlmdC1uZ2lueC1wbHVzCiAgICAgICAgdHlwZTogc3RyaW5nCiAgICAg\
 ICAgdGl0bGU6IE5hbWUgb2YgTkdJTlggUGx1cyBEb2NrZXIgaW1hZ2UKICAgICAgICByZXF1aXJl\
 ZDogdHJ1ZQogICAgICAtIG5hbWU6IGxiCiAgICAgICAgZGVmYXVsdDogZmFsc2UKICAgICAgICB0\
-eXBlOiBib29sZWFuCiAgICAgICAgdGl0bGU6IFByb3h5IFNlcnZlcnMKICAgICAgICByZXF1aXJl\
-ZDogdHJ1ZQogICAgICAtIG5hbWU6IHNlcnZlcgogICAgICAgIHR5cGU6IHN0cmluZwogICAgICAg\
-IHRpdGxlOiBQcm94eSBTZXJ2ZXJzIChJbnB1dCBhcyBhIENvbW1hIFNlcGFyYXRlZCBMaXN0KQog\
-ICAgICAtIG5hbWU6IGxiX21ldGhvZAogICAgICAgIHR5cGU6IGVudW0KICAgICAgICBlbnVtOiBb\
-J3JvdW5kX3JvYmluJywgJ2xlYXN0X2Nvbm4nLCAnaXBfaGFzaCddCiAgICAgICAgZGVmYXVsdDog\
-J3JvdW5kX3JvYmluJwogICAgICAgIHRpdGxlOiBMb2FkIEJhbGFuY2luZyBBbGdvcml0aG0KICAg\
-ICAgLSBuYW1lOiBzZXNzaW9uX3BlcnNpc3RlbmNlCiAgICAgICAgZGVmYXVsdDogZmFsc2UKICAg\
-ICAgICB0eXBlOiBib29sZWFuCiAgICAgICAgdGl0bGU6IFNlc3Npb24gUGVyc2lzdGVuY2UKICAg\
-ICAgLSBuYW1lOiBzdGlja3lfY29va2llCiAgICAgICAgdHlwZTogc3RyaW5nCiAgICAgICAgdGl0\
-bGU6IE5hbWUgb2YgU3RpY2t5IENvb2tpZQogICAgICAtIG5hbWU6IHN0YXR1cwogICAgICAgIGRl\
-ZmF1bHQ6IGZhbHNlCiAgICAgICAgdHlwZTogYm9vbGVhbgogICAgICAgIHRpdGxlOiBTdGF0dXMg\
-RGFzaGJvYXJkCg=="
+eXBlOiBib29sZWFuCiAgICAgICAgdGl0bGU6IFByb3h5IFNlcnZlcnMKICAgICAgLSBuYW1lOiBz\
+ZXJ2ZXIKICAgICAgICBkZWZhdWx0OgogICAgICAgIHR5cGU6IHN0cmluZwogICAgICAgIHRpdGxl\
+OiBQcm94eSBTZXJ2ZXJzIChJbnB1dCBhcyBhIENvbW1hIFNlcGFyYXRlZCBMaXN0KQogICAgICAt\
+IG5hbWU6IGxiX21ldGhvZAogICAgICAgIGRlZmF1bHQ6ICdyb3VuZF9yb2JpbicKICAgICAgICB0\
+eXBlOiBlbnVtCiAgICAgICAgZW51bTogWydyb3VuZF9yb2JpbicsICdsZWFzdF9jb25uJywgJ2lw\
+X2hhc2gnXQogICAgICAgIHRpdGxlOiBMb2FkIEJhbGFuY2luZyBBbGdvcml0aG0KICAgICAgLSBu\
+YW1lOiBzZXNzaW9uX3BlcnNpc3RlbmNlCiAgICAgICAgZGVmYXVsdDogZmFsc2UKICAgICAgICB0\
+eXBlOiBib29sZWFuCiAgICAgICAgdGl0bGU6IEVuYWJsZSBTZXNzaW9uIFBlcnNpc3RlbmNlCiAg\
+ICAgIC0gbmFtZTogc3RpY2t5X2Nvb2tpZQogICAgICAgIGRlZmF1bHQ6CiAgICAgICAgdHlwZTog\
+c3RyaW5nCiAgICAgICAgdGl0bGU6IE5hbWUgb2YgU3RpY2t5IENvb2tpZQogICAgICAtIG5hbWU6\
+IHN0YXR1cwogICAgICAgIGRlZmF1bHQ6IGZhbHNlCiAgICAgICAgdHlwZTogYm9vbGVhbgogICAg\
+ICAgIHRpdGxlOiBFbmFibGUgU3RhdHVzIERhc2hib2FyZAo="
 
 COPY playbooks /opt/apb/actions
 COPY roles /opt/ansible/roles

README.md

@@ -12,7 +12,7 @@ You will also need to install the [APB application](https://github.com/fusor/ans
 
 Finally, you will need to build an OpenShift NGINX Plus image. A Dockerfile to build the image can be found in the `dev` folder. You will need to copy your certs into the `certs` folder for the Docker image to work.
 
-## How to Use
+## How to Install the NGINX Plus Service
 
 1. Login to your `oc` cluster via the command that [catasb](https://github.com/fusor/catasb) will output at the end of the installation process.
 2. Clone this repository.
@@ -22,11 +22,34 @@ Finally, you will need to build an OpenShift NGINX Plus image. A Dockerfile to b
 6. Select the NGINX service, add it to `My Project`, select `Create` and click `View Project`.
 7. After waiting for a few seconds you should see a URL pop in the top-right corner of the console. That URL will take you to the default NGINX landing page. Alternatively you can select `Applications/Pods` via the left-side navbar and select the NGINX pod. From here you'll be able to use a terminal to manipulate NGINX.
 
+## Sample Tutorial Walkthrough
+
+### Option 1
+
+1. Follow steps 1-5 listed in the **How to Install the NGINX Plus Service**.
+2. Deploy Python and PHP web servers by clicking each of the respective icons in the service catalog. For each service, select the `try sample repository` option, click `create` and finally `view project`. Wait for a few minutes until the deployment has completed.
+3. Once the deployment has finished, for each service select the drop-down arrow and click the link under the service header. You will be able to see the internal IP of the pod from here. Store the internal IP of both pods (note: while not explicitly specified all default pods are open at port 8080 instead of the normal default port 80 due to security reasons).
+4. Select the NGINX service. You will be able to edit a few NGINX configuration options. Select `Enable Proxy Servers` and input the internal IPs of the Python and PHP services as a comma separated list in the `Proxy Servers` textfield. You can also select `Enable Status Dashboard` if you want to see the NGINX Plus live status dashboard. Once you are done add the service to `My Project`, select `Create` and click `View Project`.
+4. Click the drop-down arrow for the NGINX Plus service. You will see two routes have been created. Cliking the route with `web` will take you to the NGINX Load Balancer. Clicking the route with `status` will take you to the NGINX live status dashboard.
+
+### Option 2
+
+1. Follow the steps listed in the **How to Install the NGINX Plus Service** section.
+2. Deploy Python and PHP web servers by clicking each of the respective icons in the service catalog. For each service, select the ‘try sample repository’ option, click `create` and finally `view project`. Wait for a few minutes until the deployment has completed.
+3. Once the deployment has finished, for each service select the drop-down arrow and click the link under the service header. You will be able to see the internal IP of the pod from here. Store the internal IP of both pods (note: while not explicitly specified all default pods are open at port 8080 instead of the normal default port 80 due to security reasons).
+4. Navigate to the terminal of your NGINX instance and edit your default.conf file. Add a proxy_pass directive and an upstream group with two server directives pointing to the internal IPs you previously wrote down (remember to add :8080). Save your changes and type `nginx -s reload`. Click the same URL as in step 7 of the `How to Install the NGINX Plus Service` section. Voila! You have a functional NGINX Load Balancer!
+
 ## Parameters
 
 Name | Default Value | Required | Description
 ---|---|---|---
 nginx_plus_image | openshift-nginx-plus | Yes | Name of NGINX Plus Docker image
+lb | false | No | Enable Proxy Servers
+server |  | No | Proxy Servers (Input as a Comma Separated List)
+lb_method | round_robin | No | Load Balancing Algorithm
+session_persistence | false | No | Enable Session Persistence
+sticky_cookie |   | No | Name of Sticky Cookie
+status | false | No | Enable Status Dashboard
 
 ## License
 

apb.yml

@@ -27,23 +27,24 @@ plans:
         default: false
         type: boolean
         title: Proxy Servers
-        required: true
       - name: server
+        default:
         type: string
         title: Proxy Servers (Input as a Comma Separated List)
       - name: lb_method
+        default: 'round_robin'
         type: enum
         enum: ['round_robin', 'least_conn', 'ip_hash']
-        default: 'round_robin'
         title: Load Balancing Algorithm
       - name: session_persistence
         default: false
         type: boolean
-        title: Session Persistence
+        title: Enable Session Persistence
       - name: sticky_cookie
+        default:
         type: string
         title: Name of Sticky Cookie
       - name: status
         default: false
         type: boolean
-        title: Status Dashboard
+        title: Enable Status Dashboard