Skip to content

Commit 8579e45

Browse files
committed
Add more infomation to run e2e test in locally
1 parent 505b5d2 commit 8579e45

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

docs/book/src/development/development.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,16 +106,57 @@ $ openstack network list --external
106106

107107
The file [`test/e2e/data/e2e_conf.yaml`](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/test/e2e/data/e2e_conf.yaml) and the test templates under [`test/e2e/data/infrastructure-openstack`](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/tree/main/test/e2e/data/infrastructure-openstack) reference several OpenStack resources which must exist before running the test:
108108

109+
* System requirements
110+
* Multiple nodes
111+
* `controller`: 16 CPUs / 64 GB RAM
112+
* `worker`: 8 CPUs / 32 GB RAM
113+
* Availability zones (for multi-AZ tests)
114+
* `testaz1`: used by all test cases
115+
* `testaz2`: used by multi-az test case
116+
* Services (Additional services to be enabled)
117+
* Octavia
118+
* Network trunking (neutron-trunk)
119+
* see [Configration](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/docs/book/src/development/ci.md#configuration) for more details.
109120
* Glance images
110121
* `cirros-0.5.1-x86_64-disk`
111122
* Download from https://docs.openstack.org/image-guide/obtain-images.html
112123
* `ubuntu-2004-kube-v1.18.15`
113124
* Download from https://storage.googleapis.com/artifacts.k8s-staging-capi-openstack.appspot.com/test/ubuntu/2021-03-27/ubuntu-2004-kube-v1.18.15.qcow2
114125
* Or generate using the `images/capi` directory from https://github.com/kubernetes-sigs/image-builder
126+
* Boot volume size must be less than 15GB
115127
* Flavors
116128
* `m1.medium`: used by control plane
117129
* `m1.small`: used by workers
118130
* `m1.tiny`: used by bastion
131+
* clouds.yaml
132+
* `capo-e2e`: for general user authorization
133+
* `capo-e2e-admin`: for administrator user authorization
134+
* i.e.:
135+
``` yaml
136+
clouds:
137+
capo-e2e:
138+
auth:
139+
auth_url: http://Node-Address/identity
140+
project_name: demo
141+
project_domain_name: Default
142+
user_domain_name: Default
143+
username: demo
144+
password: secret
145+
region_name: RegionOne
146+
147+
capo-e2e-admin:
148+
auth:
149+
auth_url: http://Node-Address/identity
150+
project_name: demo
151+
project_domain_name: Default
152+
user_domain_name: Default
153+
username: admin
154+
password: secret
155+
region_name: RegionOne
156+
```
157+
158+
You can also use [Hacking CI scripts](https://cluster-api-openstack.sigs.k8s.io/development/ci.html#devstack) to automatically create OpenStack environment.
159+
119160
120161
## Running E2E tests using rootless podman
121162

0 commit comments

Comments
 (0)