docker

command module
Version: v0.0.0-...-40841d9 Latest Latest
Warning

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

Go to latest
Published: Jun 2, 2021 License: Apache-2.0 Imports: 24 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 -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.

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
api
v1alpha3
Package v1alpha3 contains the v1alpha3 API implementation.
Package v1alpha3 contains the v1alpha3 API implementation.
v1alpha4
Package v1alpha4 contains API Schema definitions for the infrastructure v1alpha4 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io
Package v1alpha4 contains API Schema definitions for the infrastructure v1alpha4 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io
Package cloudinit defines cloud init adapter for kind nodes.
Package cloudinit defines cloud init adapter for kind nodes.
Package controllers implements controller functionality.
Package controllers implements controller functionality.
Package docker implements docker functionality.
Package docker implements docker functionality.
types
Package types implements type functionality.
Package types implements type functionality.
exp
api/v1alpha3
Package v1alpha3 contains the v1alpha3 API implementation.
Package v1alpha3 contains the v1alpha3 API implementation.
api/v1alpha4
Package v1alpha4 contains API Schema definitions for the exp.infrastructure v1alpha4 API group +kubebuilder:object:generate=true +groupName=exp.infrastructure.cluster.x-k8s.io
Package v1alpha4 contains API Schema definitions for the exp.infrastructure v1alpha4 API group +kubebuilder:object:generate=true +groupName=exp.infrastructure.cluster.x-k8s.io
controllers
Package controllers implements controller functionality.
Package controllers implements controller functionality.
docker
Package docker implements docker functionality.
Package docker implements docker functionality.
third_party
forked/loadbalancer
Package loadbalancer contains external loadbalancer related constants and configuration
Package loadbalancer contains external loadbalancer related constants and configuration

Jump to

Keyboard shortcuts

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