Documentation
¶
Index ¶
- Constants
- func NewFromExisting(name string) (clusters.Cluster, error)
- type Builder
- func (b *Builder) Build(ctx context.Context) (clusters.Cluster, error)
- func (b *Builder) WithCalicoCNI() *Builder
- func (b *Builder) WithClusterVersion(version semver.Version) *Builder
- func (b *Builder) WithConfig(filename string) *Builder
- func (b *Builder) WithConfigReader(cfg io.Reader) *Builder
- func (b *Builder) WithIPv6Only() *Builder
- func (b *Builder) WithName(name string) *Builder
- type Cluster
- func (c *Cluster) Cleanup(ctx context.Context) error
- func (c *Cluster) Client() *kubernetes.Clientset
- func (c *Cluster) Config() *rest.Config
- func (c *Cluster) DeleteAddon(ctx context.Context, addon clusters.Addon) error
- func (c *Cluster) DeployAddon(ctx context.Context, addon clusters.Addon) error
- func (c *Cluster) DumpDiagnostics(ctx context.Context, meta string) (string, error)
- func (c *Cluster) GetAddon(name clusters.AddonName) (clusters.Addon, error)
- func (c *Cluster) IPFamily() clusters.IPFamily
- func (c *Cluster) ListAddons() []clusters.Addon
- func (c *Cluster) Name() string
- func (c *Cluster) Type() clusters.Type
- func (c *Cluster) Version() (semver.Version, error)
Constants ¶
const ( // KindClusterType indicates that the Kubernetes cluster was provisioned by Kind. KindClusterType clusters.Type = "kind" // EnvKeepCluster is the environment variable that can be set to "true" in order // to circumvent teardown during cleanup of clusters in order to allow a user to inspect them instead. EnvKeepCluster = "KIND_KEEP_CLUSTER" // DefaultKindDockerNetwork is the Docker network that a kind cluster uses by default. DefaultKindDockerNetwork = "kind" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Builder ¶
type Builder struct {
Name string
// contains filtered or unexported fields
}
Builder generates clusters.Cluster objects backed by Kind given provided configuration options.
func (*Builder) Build ¶
Build creates and configures clients for a Kind-based Kubernetes clusters.Cluster.
func (*Builder) WithCalicoCNI ¶ added in v0.17.0
WithCalicoCNI disables the default CNI for the kind cluster and instead deploys Calico (https://projectcalico.docs.tigera.io/about/about-calico) which includes deep features including NetworkPolicy enforcement.
func (*Builder) WithClusterVersion ¶
WithClusterVersion configures the Kubernetes cluster version for the Builder to use when building the Kind cluster.
func (*Builder) WithConfig ¶ added in v0.13.0
WithConfig sets a filename containing a KIND config See: https://kind.sigs.k8s.io/docs/user/configuration This will override any config set previously.
func (*Builder) WithConfigReader ¶ added in v0.31.0
WithConfigReader sets a reader containing a KIND config See: https://kind.sigs.k8s.io/docs/user/configuration This will override any config set previously.
func (*Builder) WithIPv6Only ¶ added in v0.40.0
WithIPv6Only configures KIND to only use IPv6.
type Cluster ¶ added in v0.11.0
type Cluster struct {
// contains filtered or unexported fields
}
Cluster is a clusters.Cluster implementation backed by Kubernetes In Docker (KIND)
func (*Cluster) Client ¶ added in v0.11.0
func (c *Cluster) Client() *kubernetes.Clientset
func (*Cluster) DeleteAddon ¶ added in v0.11.0
func (*Cluster) DeployAddon ¶ added in v0.11.0
func (*Cluster) DumpDiagnostics ¶ added in v0.24.0
DumpDiagnostics produces diagnostics data for the cluster at a given time. It uses the provided meta string to write to meta.txt file which will allow for diagnostics identification. It returns the path to directory containing all the diagnostic files and an error.
Source Files