docker

command
v1.7.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 31, 2024 License: Apache-2.0 Imports: 41 Imported by: 0

README

Cluster API Provider Docker (CAPD)

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 which uses CAPD as an example infrastructure provider.

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.

Testing

In order to test your local changes, go to the top level directory of this project, cluster-api/ and run make test-docker-infrastructure 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.

Documentation

Overview

main is the main package for the Docker Infrastructure Provider.

Directories

Path Synopsis
api
Package controllers provides access to reconcilers implemented in internal/controllers.
Package controllers provides access to reconcilers implemented in internal/controllers.
exp
internal
Package webhooks contains docker infrastructure webhook implementations for some of our API types.
Package webhooks contains docker infrastructure webhook implementations for some of our API types.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL