Skip to content
This repository has been archived by the owner on Sep 24, 2021. It is now read-only.

Commit

Permalink
Merge pull request #255 from ashish-amarnath/update-readme
Browse files Browse the repository at this point in the history
✨ Describe capd and add goals in readme
  • Loading branch information
k8s-ci-robot authored Oct 10, 2019
2 parents 76b1136 + 045310e commit c22f165
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Cluster API Provider Docker (CAPD)

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

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

To get a complete overview, look at the documentation in the bootstrap provider that uses CAPD as an example infrastructure provider.
For a complete overview, please refer to the documentation available [here](https://github.com/kubernetes-sigs/cluster-api-bootstrap-provider-kubeadm#cluster-api-bootstrap-provider-kubeadm) which uses CAPD as an example infrastructure provider.

https://github.com/kubernetes-sigs/cluster-api-bootstrap-provider-kubeadm#cluster-api-bootstrap-provider-kubeadm
## CAPD Goals

* To be a the reference implementation of an infrastructure provider.
* 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.

0 comments on commit c22f165

Please sign in to comment.