update README to add coreos support and kustomize required (openshift…

…#314)

README.md

@@ -93,7 +93,7 @@ policy may be made to more closely align with other providers in the Cluster API
 
    ```bash
    cd examples/openstack
-   ./generate-yaml.sh [options] <path/to/clouds.yaml> <openstack cloud> <provider os>
+   ./generate-yaml.sh [options] <path/to/clouds.yaml> <openstack cloud> <provider os: [centos,ubuntu,coreos]>
    cd ../..
    ```
 
@@ -117,8 +117,8 @@ policy may be made to more closely align with other providers in the Cluster API
 
    `<provider os>` specifies the operating system of the virtual machines Kubernetes will run on.
    Supported Operating Systems:
-   - `ubuntu`
    - `centos`
+   - `ubuntu`
    - `coreos`
 
    #### Quick notes on clouds.yaml

cmd/clusterctl/examples/openstack/README.md

@@ -18,31 +18,52 @@
 ## Prerequisites
 
 1. Install `yq` (see [here](https://github.com/mikefarah/yq)).
+2. Install `kustomize` v1.0.11 which can be found [here](https://github.com/kubernetes-sigs/kustomize/releases/tag/v1.0.11).
 
 ## Generation
 For convenience, a generation script which populates templates based on openstack cloud provider
 configuration is provided.
 
 1. Run the generation script.
 ```
-./generate-yaml.sh --provider-os [os name]
+./generate-yaml.sh [options] <path/to/clouds.yaml> <openstack cloud> <provider os: [centos,ubuntu,coreos]>
 ```
 
-   [os name] is the operating system of your provider environment. 
+   `<clouds.yaml>` is a yaml file to record how to interact with Openstack Cloud, refer [clouds.yaml](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/master/pkg/cloud/openstack/clients/clouds.yaml), and [openclient configuration files](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files) has additional information.
 
-   Supported Operating Systems: 
-   - `ubuntu` 
-   - `centos`
+   `<openstack cloud>` is the cloud you are going to use, e.g. multiple cloud might be defined in `clouds.yaml`
+   and this will be cloud to be used for the new kubernetes to interact with.
+   for example, assume you have 2 clouds defined below as `clouds.yaml` and specify `openstack1` will use all definition in it.
+
+   ```
+   clouds:
+     openstack1:
+       auth:
+         auth_url: http://192.168.122.10:35357/
+       region_name: RegionOne
+     ds-admin:
+       auth:
+         auth_url: http://192.168.122.10:35357/
+       region_name: RegionOne
+   ```
+
+   `<provider os>` is the operating system of your provider environment.
+
+   Supported Operating Systems:
+   - `centos` 
+   - `ubuntu`
+   - `coreos`
 
 If yaml file already exists, you will see an error like the one below:
 
 ```
-$ ./generate-yaml.sh --provider-os [os name]
+$ ./generate-yaml.sh [options] <path/to/clouds.yaml> openstack <provider os: [centos,ubuntu,coreos]>
+
 File provider-components.yaml already exists. Delete it manually before running this script.
 ```
 
 ## Manual Modification
 You may always manually curate files based on the examples provided.
 
 Note that to set the desired security groups the UUIDs must be used.
-Using security groups names is not supported.
+Using security groups names is not supported.