MCPcopy
hub / github.com/kubernetes-sigs/cluster-api

github.com/kubernetes-sigs/cluster-api @v1.13.3 sqlite

repository ↗ · DeepWiki ↗ · release v1.13.3 ↗
13,588 symbols 55,734 edges 1,338 files 8,034 documented · 59%
README

capi

GitHub release (latest SemVer)

Cluster API

👋 Welcome to our project! Our Book can help you get started and provides lots of in-depth information.

Useful links

✨ What is the Cluster API?

Cluster API is a Kubernetes subproject focused on providing declarative APIs and tooling to simplify provisioning, upgrading, and operating multiple Kubernetes clusters.

Started by the Kubernetes Special Interest Group (SIG) Cluster Lifecycle, the Cluster API project uses Kubernetes-style APIs and patterns to automate cluster lifecycle management for platform operators. The supporting infrastructure, like virtual machines, networks, load balancers, and VPCs, as well as the Kubernetes cluster configuration are all defined in the same way that application developers operate deploying and managing their workloads. This enables consistent and repeatable cluster deployments across a wide variety of infrastructure environments.

⚙️ Providers

Cluster API can be extended to support any infrastructure (AWS, Azure, vSphere, etc.), bootstrap or control plane (kubeadm is built-in) provider. There is a growing list of supported providers available.

🤗 Community, discussion, contribution, and support

Cluster API is developed in the open, and is constantly being improved by our users, contributors, and maintainers. It is because of you that we are able to automate cluster lifecycle management for the community. Join us!

If you have questions or want to get the latest project news, you can connect with us in the following ways:

  • Chat with us on the Kubernetes Slack in the #cluster-api channel
  • Subscribe to the SIG Cluster Lifecycle Google Group for access to documents and calendars
  • Join our Cluster API working group sessions where we share the latest project news, demos, answer questions, and triage issues

Pull Requests and feedback on issues are very welcome! See the issue tracker if you're unsure where to start, especially the Good first issue and Help wanted tags, and also feel free to reach out to discuss.

See also our contributor guide and the Kubernetes community page for more details on how to get involved.

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

Extension points exported contracts — how you extend this code

SourceWatcher (Interface)
SourceWatcher is a scoped-down interface from Controller that only has the Watch func. [8 implementers]
controllers/clustercache/cluster_cache.go
Creator (Interface)
Creator can creates resources. [11 implementers]
test/framework/interfaces.go
PatchOption (Interface)
PatchOption represents an option for the patchObject and patchTemplate funcs. [8 implementers]
internal/controllers/topology/cluster/patches/patch.go
MetadataClient (Interface)
MetadataClient has methods to work with metadata hosted on a provider repository. Metadata are yaml files providing addi [37 …
cmd/clusterctl/client/repository/metadata_client.go
Entry (Interface)
Entry is the interface for the type of Cache entries. [8 implementers]
util/cache/cache.go
WorkloadClustersMuxOption (Interface)
WorkloadClustersMuxOption define an option for the WorkloadClustersMux creation. [5 implementers]
test/infrastructure/inmemory/pkg/server/mux.go
Generator (Interface)
Generator is a generator to generate the desired state. [4 implementers]
exp/topology/desiredstate/desired_state.go
MergeStrategy (Interface)
MergeStrategy defines a strategy used to merge conditions during the aggregate or summary operation. [4 implementers]
util/conditions/merge_strategies.go

Core symbols most depended-on inside this repo

Build
called by 1821
internal/runtime/client/fake/fake_client.go
Run
called by 1606
cmd/clusterctl/client/cluster/crd_migration.go
String
called by 987
controlplane/kubeadm/internal/proxy/addr.go
String
called by 715
internal/contract/types.go
Build
called by 696
internal/controllers/topology/cluster/patches/template.go
Info
called by 616
cmd/clusterctl/log/logger.go
Get
called by 520
internal/runtime/registry/registry.go
Set
called by 509
util/conditions/setter.go

Shape

Function 5,866
Method 5,373
Struct 1,931
TypeAlias 179
Interface 150
FuncType 87
Class 2

Languages

Go100%
Python1%

Modules by API surface

api/core/v1beta2/zz_generated.deepcopy.go330 symbols
api/core/v1beta1/zz_generated.conversion.go274 symbols
util/test/builder/builders.go241 symbols
api/core/v1beta1/zz_generated.deepcopy.go232 symbols
test/infrastructure/docker/api/v1beta1/zz_generated.conversion.go223 symbols
test/infrastructure/docker/api/v1beta2/zz_generated.deepcopy.go196 symbols
api/runtime/hooks/v1alpha1/zz_generated.deepcopy.go162 symbols
api/core/v1beta2/zz_generated.openapi.go156 symbols
api/bootstrap/kubeadm/v1beta1/zz_generated.conversion.go150 symbols
test/infrastructure/docker/api/v1beta1/zz_generated.deepcopy.go146 symbols
api/bootstrap/kubeadm/v1beta2/zz_generated.deepcopy.go112 symbols
api/bootstrap/kubeadm/v1beta1/zz_generated.deepcopy.go112 symbols

Used by 2 indexed graphs manifest dependencies, hub-wide

github.com/rancher/rancher
github.com/thingsboard/thingsboard

Dependencies from manifests, versioned

al.essio.dev/pkg/shellescapev1.5.1 · 1×
cel.dev/exprv0.25.1 · 1×
cloud.google.com/gov0.123.0 · 1×
cloud.google.com/go/authv0.20.0 · 1×
cloud.google.com/go/auth/oauth2adaptv0.2.8 · 1×
cloud.google.com/go/compute/metadatav0.9.0 · 1×
cloud.google.com/go/iamv1.7.0 · 1×
cloud.google.com/go/monitoringv1.24.3 · 1×
cloud.google.com/go/storagev1.62.1 · 1×
dario.cat/mergov1.0.1 · 1×
github.com/BurntSushi/tomlv1.4.0 · 1×
github.com/GoogleCloudPlatform/opentelemetry-operations-go/detectors/gcpv1.31.0 · 1×

For agents

$ claude mcp add cluster-api \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact