Skip to content

Commit

Permalink
Fix README.md (openshift#105)
Browse files Browse the repository at this point in the history
* 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 <hidekazuna@gmail.com>
  • Loading branch information
hidekazuna authored and pierreprinetti committed Apr 22, 2024
1 parent 972e7e1 commit b6975c2
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,13 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of

```bash
cd examples/openstack
./generate-yaml.sh
./generate-yaml.sh --provider-os [os name]
cd ../..
```
[os name] is the operating system of your provider environment.
Supported Operating Systems:
- `ubuntu`
- `centos`

#### Interactively submit provider information
By default, the generater script will give you a series of command line prompts, asking the following information about your cloud provider:
Expand Down Expand Up @@ -78,22 +82,22 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
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:

```bash
./generate-yaml.sh -c clouds.yaml
./generate-yaml.sh --clouds clouds.yaml
./generate-yaml.sh --provider-os [os name] -c clouds.yaml
./generate-yaml.sh --provider-os [os name] --clouds clouds.yaml
```

2. Create a cluster:

```bash
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
./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
```

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`.
Additional advanced flags can be found via help.
```bash
clusterctl create cluster --help
./clusterctl create cluster --help
```
### Interacting with your cluster
Expand Down
8 changes: 6 additions & 2 deletions cmd/clusterctl/examples/openstack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,17 @@ configuration is provided.

1. Run the generation script.
```
./generate-yaml.sh
./generate-yaml.sh --provider-os [os name]
```

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

```
$ ./generate-yaml.sh
$ ./generate-yaml.sh --provider-os [os name]
File provider-components.yaml already exists. Delete it manually before running this script.
```

Expand Down

0 comments on commit b6975c2

Please sign in to comment.