README
¶
Cluster Registry
A lightweight tool for maintaining a list of clusters and associated metadata.
What is it?
The cluster registry helps you keep track of and perform operations on your clusters. This repository contains an implementation of the Cluster Registry API (code, design) as a Kubernetes Custom Resource Definition, which is the canonical representation of the cluster registry.
Documentation
Documentation is in the docs directory.
Most directories containing Go code have package documentation, which you can view on Godoc. Most directories that have interesting content but do not have Go code have README.md files that briefly describe their contents.
Getting involved
The cluster registry is still a young project, but we welcome your contributions, suggestions and input! Please reach out to the kubernetes-sig-multicluster mailing list, or find us on Slack in #sig-multicluster.
Maintainers
Development
Basic instructions for working in the cluster-registry repo are here.
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
slackcontroller
command
|
|
|
pkg
|
|
|
apis
+domain=k8s.io
|
+domain=k8s.io |
|
apis/clusterregistry
+k8s:deepcopy-gen=package,register +groupName=clusterregistry.k8s.io
|
+k8s:deepcopy-gen=package,register +groupName=clusterregistry.k8s.io |
|
apis/clusterregistry/v1alpha1
Package v1alpha1 is the v1alpha1 version of the clusterregistry API.
|
Package v1alpha1 is the v1alpha1 version of the clusterregistry API. |
|
client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/clusterregistry/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/clusterregistry/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
controller
Package controller is unused by the cluster registry but required by kubebuilder.
|
Package controller is unused by the cluster registry but required by kubebuilder. |
|
inject
Package inject is unused by the cluster registry but required by kubebuilder.
|
Package inject is unused by the cluster registry but required by kubebuilder. |
|
test
|
|
|
integration
Package integration contains an integration test harness and an integration test for the cluster registry API server.
|
Package integration contains an integration test harness and an integration test for the cluster registry API server. |