Skip to content

Commit

Permalink
Merge pull request #3719 from Emc1992/readme-docker-1
Browse files Browse the repository at this point in the history
Reword docker readme
  • Loading branch information
k8s-ci-robot authored Oct 19, 2020
2 parents 0008b5b + 6a39a22 commit f1d05fa
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions test/infrastructure/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

CAPD is a reference implementation of an infrastructure provider for the Cluster API project using Docker.

**NOTE:** The Docker provider is **not** designed for production use and is intended for development environments only.

This is one out of three components needed to run a Cluster API management cluster.

For a complete overview, please refer to the documentation available [here](https://github.com/kubernetes-sigs/cluster-api/tree/master/bootstrap/kubeadm#cluster-api-bootstrap-provider-kubeadm) which uses CAPD as an example infrastructure provider.
Expand All @@ -12,9 +14,11 @@ For a complete overview, please refer to the documentation available [here](http
* The code is highly trusted and used in testing of ClusterAPI.
* This provider can be used as a guide for developers looking to implement their own infrastructure provider.

## End-to-end testing
## Testing

In order to test your local changes, go to the top level directory of this project, `cluster-api/` and run
`make -C test/infrastructure/docker test-e2e` to run the test suite.
`make -C test/infrastructure/docker test` to run the unit tests.

**Note:** `make test-e2e` runs the CAPI E2E tests that are based on CAPD (CAPD does not have a separated e2e suite).

This make target will build an image based on the local source code and use that image during testing.
This make target will build an image based on the local source code and use that image during testing.

0 comments on commit f1d05fa

Please sign in to comment.