README.md in vcloud-net-spinner-0.1.2 vs README.md in vcloud-net-spinner-0.1.4

- old
+ new

@@ -11,62 +11,36 @@ ## Usage Usage: vcloud-net-spinner [options] API_URL -u, --username=U Vcloud Username -p, --password=P Vcloud Password - -e, --env=E Environment: preview | staging | production - -U, --organization-edgegateway-uuid=U UID: This is required to configure edgegateway services. For more info refer to - docs/find_organisation_edgegateway_uuid - -c, --component=c Environment: lb|firewall|nat - -o, --organization=o Organization: optional. Will default to environment - -d, --rule-directory=d Rules Directory: From where to read the NAT/Firewal/LB rules + -U, --organization-edgegateway-uuid=U UID: This is required to configure edgegateway services. For more info refer to docs/find_organisation_edgegateway_uuid + -c, --component=c Component: lb|firewall|nat + -o, --organization=o Organization: Name of vcloud organization + -r, --rules-files file1,file2,file3 Rules Files: files which will contain the rules for the component provided + -i, --interfaces-files file1,file2,file3 Interfaces Files: files which will contain interfaces - Note: organization maps to the organization name in vcloud. Whereas, - environment maps to your internal environment reference (e.g. - preview, qa, staging, production, etc) - ### Example vcloud-net-spinner -u username -p password -e preview -U 1yenz127ynz1872eyz12yz817e -c firewall -o development -d . http://vcloud.vendor.com/api -### Rules Directory +### Rules Files & Interfaces Files -A particular rules directory structure could be as follows. +* You can pass multiple files containing component rules via + `--rules-files`. - . - ├── Gemfile - ├── Gemfile.lock - ├── common_firewall.rb - ├── common_lb.rb - ├── common_nat.rb - ├── env1 - │ ├── firewall.rb - │ ├── interfaces.yaml - │ ├── lb.rb - │ └── nat.rb - ├── env2 - ├── firewall.rb - ├── interfaces.yaml - ├── lb.rb - └── nat.rb +* You can specify various files containing network interfaces + rules via `--interfaces-files`. -* Here each environment represent a separate organisation with your vcloud - vendor (eg qa, staging, production). These could have specific rules for nat, - firewall. Also these can have common firewall rules which could be shared - across all environments. A common example of such a situation is internal - network firewall rules are usually shared across environments, whereas - external network firewall rules would be different for all environment. + A particular `interfaces.yaml` file looks as follows: - * Specific network rules => `env1/firewall.rb`, `env1/nat.rb`, `env1/lb.rb` - * Common network rules => `./common_firewall.rb`, `./common_lb.rb`, `./common_lb.rb` - -* interfaces.yaml file: - To find the urls for network, follow the document at - `docs/find_network_url` - interfaces: Network-1: "https://localhost:4567/api/admin/network/<vdc-network-uuid>" Network-2: "https://localhost:4567/api/admin/network/<vdc-network-uuid>" + + To find the urls for network, follow the document a + `docs/find_network_url` + ### DSL #### Firewall