README.md in vcloud-edge_gateway-0.5.0 vs README.md in vcloud-edge_gateway-1.0.0

- old
+ new

@@ -21,16 +21,16 @@ ## Usage To configure an Edge Gateway: - $ vcloud-configure-edge input.yaml + $ vcloud-edge-configure input.yaml To use [mustache](http://mustache.github.io) templates so that rulesets can be re-used between environments: - $ vcloud-configure-edge --template-vars vars.yaml input.yaml.mustache + $ vcloud-edge-configure --template-vars vars.yaml input.yaml.mustache ## Credentials vCloud Edge Gateway is based around [fog](http://fog.io/). To use it you'll need to give it credentials that allow it to talk to a vCloud Director environment. @@ -58,31 +58,31 @@ 3. Specify your credentials and session token at the beginning of the command. For example: FOG_CREDENTIAL=test_credentials \ FOG_VCLOUD_TOKEN=AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF= \ - vcloud-configure-edge input.yaml + vcloud-edge-configure input.yaml You may find it easier to export one or both of the values as environment variables. **NB** It is also possible to sidestep the need for the session token by saving your password in the fog file. This is **not recommended**. ### Configure edge gateway services You can configure the following services on an existing edgegateway using -`vcloud-configure-edge`. +`vcloud-edge-configure`. - firewall_service - nat_service - load_balancer_service NB: DHCP and VPN Services are not yet supported by the Fog platform underneath. Support for these is being considered. -The `vcloud-configure-edge` tool takes an input YAML file describing one +The `vcloud-edge-configure` tool takes an input YAML file describing one or more of these services and updates the edge gateway configuration to match, obeying the following rules: * A given service will not be reconfigured if its input configuration matches the live configuration - to prevent unneccessary service reloads. @@ -235,11 +235,11 @@ * URI-based healthchecks of backend nodes * Several balancing algorithms, such as 'round robin', and 'least connections' * Ability to persist sessions to the same backend member node, via a variety of means (eg HTTP cookie value, SSL session ID, source IP hash). -`vcloud-configure-edge` supports all of the above features. +`vcloud-edge-configure` supports all of the above features. It is also worth noting that the vCloud Director load balancer *does not support*: * In vCD 5.1, TCP and HTTPS layer-4 balancing are based on TCP port forwarding. There is no NAT in the mix, so the backend pools see the IP address/port of @@ -421,14 +421,19 @@ | select(.InterfaceType == "uplink") | ( .Network.href, .SubnetParticipation ) ' ``` -### Full configuration examples +### Full configuration examples and schemas -You can find full configuration examples in the `examples` folder. +Full configuration examples are in the [`examples/`][examples] folder. +Configuration schemas are in [`lib/vcloud/edge_gateway/schema/`][schema]. + +[examples]: /examples +[schema]: /lib/vcloud/edge_gateway/schema + ## The vCloud API vCloud Tools currently use version 5.1 of the [vCloud API](http://pubs.vmware.com/vcd-51/index.jsp?topic=%2Fcom.vmware.vcloud.api.doc_51%2FGUID-F4BF9D5D-EF66-4D36-A6EB-2086703F6E37.html). Version 5.5 may work but is not currently supported. You should be able to access the 5.1 API in a 5.5 environment, and this *is* currently supported. The default version is defined in [Fog](https://github.com/fog/fog/blob/244a049918604eadbcebd3a8eaaf433424fe4617/lib/fog/vcloud_director/compute.rb#L32). @@ -450,9 +455,12 @@ bundle exec rake Run the integration tests (slower and requires a real environment): bundle exec rake integration + +You need access to a suitable vCloud Director organization to run the integration tests. See the [integration tests +README](/spec/integration/README.md) for further details. ### References * [vCloud Director Edge Gateway documentation](http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.admin.doc_51/GUID-ADE1DCAB-874F-45A9-9337-1E971DAC0F7D.html)