Skip to content

Commit b6975c2

Browse files
hidekazunapierreprinetti
authored andcommitted
Fix README.md (openshift#105)
* Fix README.md Required option --provider-os was added to generate-yaml.sh in openshift#90. This patch fixes Cluster Creation section in README.md. * Apply suggestions from code review Co-Authored-By: hidekazuna <[email protected]>
1 parent 972e7e1 commit b6975c2

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,13 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
3737

3838
```bash
3939
cd examples/openstack
40-
./generate-yaml.sh
40+
./generate-yaml.sh --provider-os [os name]
4141
cd ../..
4242
```
43+
[os name] is the operating system of your provider environment.
44+
Supported Operating Systems:
45+
- `ubuntu`
46+
- `centos`
4347

4448
#### Interactively submit provider information
4549
By default, the generater script will give you a series of command line prompts, asking the following information about your cloud provider:
@@ -78,22 +82,22 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
7882
To pass a clouds.yaml file to generate-yaml, set the **-c** or **--clouds** options, followed by the path to a clouds.yaml file. Here are some examples of this syntax:
7983

8084
```bash
81-
./generate-yaml.sh -c clouds.yaml
82-
./generate-yaml.sh --clouds clouds.yaml
85+
./generate-yaml.sh --provider-os [os name] -c clouds.yaml
86+
./generate-yaml.sh --provider-os [os name] --clouds clouds.yaml
8387
```
8488

8589
2. Create a cluster:
8690

8791
```bash
88-
clusterctl create cluster --minikube kubernetes-version=v1.12.1 --provider openstack -c examples/openstack/out/cluster.yaml -m examples/openstack/out/machines.yaml -p examples/openstack/out/provider-components.yaml
92+
./clusterctl create cluster --minikube kubernetes-version=v1.12.1 --provider openstack -c examples/openstack/[os name]/out/cluster.yaml -m examples/openstack/[os name]/out/machines.yaml -p examples/openstack/[os name]/out/provider-components.yaml
8993
```
9094

9195
To choose a specific minikube driver, please use the `--vm-driver` command line parameter. For example to use the kvm2 driver with clusterctl you woud add `--vm-driver kvm2`, for linux, if you haven't installed any driver, you can add `--vm-driver none`.
9296

9397
Additional advanced flags can be found via help.
9498

9599
```bash
96-
clusterctl create cluster --help
100+
./clusterctl create cluster --help
97101
```
98102

99103
### Interacting with your cluster

cmd/clusterctl/examples/openstack/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,17 @@ configuration is provided.
99

1010
1. Run the generation script.
1111
```
12-
./generate-yaml.sh
12+
./generate-yaml.sh --provider-os [os name]
1313
```
1414

15+
[os name] is the operating system of your provider environment.
16+
Supported Operating Systems:
17+
- `ubuntu`
18+
- `centos`
1519
If yaml file already exists, you will see an error like the one below:
1620

1721
```
18-
$ ./generate-yaml.sh
22+
$ ./generate-yaml.sh --provider-os [os name]
1923
File provider-components.yaml already exists. Delete it manually before running this script.
2024
```
2125

0 commit comments

Comments
 (0)