Skip to content

Commit 6610073

Browse files
authored
Merge pull request #16 from elmiko/update-readme-v0.2.3
update README for 0.2.3 release
2 parents 4286654 + cc95959 commit 6610073

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
Cluster API Provider Kubemark (CAPK) is a provider for [Cluster
2525
API][cluster_api] (CAPI) that allows users to deploy fake, [Kubemark][kubemark_docs]-backed machines to their
2626
clusters. This is useful in a variety of scenarios, such load-testing and
27-
simulation testing.
27+
simulation testing.
2828

2929
It is slightly similar to [CAPD][capd], the Docker
3030
provider, in that it does not deploy actual infrastructure resources (VMs or
@@ -40,10 +40,12 @@ default located at `~/.cluster-api/clusterctl.yaml`.
4040
```yaml
4141
providers:
4242
- name: "kubemark"
43-
url: "https://github.com/kubernetes-sigs/cluster-api-provider-kubemark/releases/v0.2.2/infrastructure-components.yaml"
43+
url: "https://github.com/kubernetes-sigs/cluster-api-provider-kubemark/releases/v0.2.3/infrastructure-components.yaml"
4444
type: "InfrastructureProvider"
4545
```
4646
47+
*Note: the `v0.2.3` release of the kubemark provider has been tested with the `v0.4.\*` versions of Cluster API*
48+
4749
For demonstration purposes, we'll use the [CAPD][capd] provider. Other
4850
providers will also work, but CAPD is supported with a custom
4951
[template](templates/cluster-template-capd.yaml) that makes deployment super
@@ -59,16 +61,16 @@ Once initialized, you'll need to deploy your workload cluster using the `capd`
5961
flavor to get a hybrid CAPD/CAPK cluster:
6062

6163
```bash
62-
clusterctl config cluster wow --infrastructure kubemark --flavor capd --kubernetes-version 1.19.1 --control-plane-machine-count=1 --worker-machine-count=4 | kubectl apply -f-
64+
clusterctl config cluster wow --infrastructure kubemark --flavor capd --kubernetes-version 1.21.1 --control-plane-machine-count=1 --worker-machine-count=4 | kubectl apply -f-
6365
```
6466

6567
You should see your cluster come up and quickly become available with 4 Kubemark machines connected to your CAPD control plane.
6668

6769
For other providers, you can either create a custom hybrid cluster template, or deploy the control plane and worker machines separately, specifiying the same cluster name:
6870

6971
```bash
70-
clusterctl config cluster wow --infrastructure aws --kubernetes-version 1.19.1 --control-plane-machine-count=1 | kubectl apply -f-
71-
clusterctl config cluster wow --infrastructure kubemark --kubernetes-version 1.19.1 --worker-machine-count=4 | kubectl apply -f-
72+
clusterctl config cluster wow --infrastructure aws --kubernetes-version 1.21.1 --control-plane-machine-count=1 | kubectl apply -f-
73+
clusterctl config cluster wow --infrastructure kubemark --kubernetes-version 1.21.1 --worker-machine-count=4 | kubectl apply -f-
7274
```
7375

7476
## Using tilt

0 commit comments

Comments
 (0)