Updated docs
diff --git a/README.md b/README.md
index 910cf93..9af4710 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,25 @@
-Role Name
+Apigee OPDK Start Components
=========
-A brief description of the role goes here.
+This repository contains an Ansible role that starts either all components or the indicated one.
Requirements
------------
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+None
Role Variables
--------------
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+| Variable Name | Description |
+| --- | --- |
+| component_name | Name of the component to start; if set to all then apigee-all is used. |
+| http_proxy | http proxy endpoint |
+| https_proxy | https proxy endpoint |
+| no_proxy | no proxy to be set when working with a proxy |
+| PORT_TIMEOUT | Update the port timeout setting in the Apigee update script |
+| UP_TIMEOUT | Update the setting in the Apigee update script waiting for the component to come up |
+| opdk_debug_mode | If set to `on` then the bash script will be run with the `-x` parameter |
Dependencies
------------
@@ -25,17 +33,18 @@
- hosts: servers
roles:
- - { role: username.rolename, x: 42 }
+ - { role: apigee-opdk-start-components }
License
-------
-BSD
+Apache 2.0
Author Information
------------------
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+Carlos Frias
+
<!-- BEGIN Google Required Disclaimer -->
# Not Google Product Clause
diff --git a/tasks/main.yml b/tasks/main.yml
index 79a6650..9d48da7 100644
--- a/tasks/main.yml
+++ b/tasks/main.yml
@@ -24,7 +24,7 @@
# when: wait_for_ready | default(false) and opdk_debug_mode is not defined or opdk_debug_mode | trim | lower == 'off'
- name: DEBUG_MODE - Start a specific Apigee component on the node
- shell: '/opt/apigee/apigee-service/bin/apigee-service {{ component_name }} start'
+ shell: 'bash -x /opt/apigee/apigee-service/bin/apigee-service {{ component_name }} start'
environment:
http_proxy: "{{ http_proxy }}"
https_proxy: "{{ https_proxy }}"
@@ -70,7 +70,7 @@
# when: wait_for_ready | default(false) and opdk_debug_mode is not defined or opdk_debug_mode | trim | lower == 'off'
- name: DEBUG_MODE - Start all Apigee components on the node
- shell: '/opt/apigee/apigee-service/bin/apigee-all start'
+ shell: 'bash -x /opt/apigee/apigee-service/bin/apigee-all start'
environment:
http_proxy: "{{ http_proxy }}"
https_proxy: "{{ https_proxy }}"
