Cluster-registry

module

v0.0.1 Latest Latest Go to latest Published: Dec 18, 2017 License: Apache-2.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kubernetes/Cluster-registry

Links

Open Source Insights

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 API (code, design) backed by a Kubernetes-style API server, which is the canonical implementation 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

There is a nightly build here

Basic instructions for working in the cluster-registry repo are here.

Directories ¶

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

Path	Synopsis
cmd
clusterregistry clusterregistry is the main API server that serves the Cluster Registry API.	clusterregistry is the main API server that serves the Cluster Registry API.
crinit crinit is a tool for bootstrapping a cluster registry in a Kubernetes cluster.	crinit is a tool for bootstrapping a cluster registry in a Kubernetes cluster.
examples
slackcontroller
pkg
apis/clusterregistry Package clusterregistry contains the Go definitions for the cluster registry API, as well as some scaffolding code for using this API in Go code.	Package clusterregistry contains the Go definitions for the cluster registry API, as well as some scaffolding code for using this API in Go code.
apis/clusterregistry/install Package install registers the clusterregistry API group and adds its types to a scheme.	Package install registers the clusterregistry API group and adds its types to a scheme.
apis/clusterregistry/v1alpha1 Package v1alpha1 is the v1alpha1 version of the clusterregistry API, whose internal version is defined in k8s.io/cluster-registry/pkg/apis/clusterregistry.	Package v1alpha1 is the v1alpha1 version of the clusterregistry API, whose internal version is defined in k8s.io/cluster-registry/pkg/apis/clusterregistry.
apis/clusterregistry/validation Package validation defines validation routines for the clusterregistry API.	Package validation defines validation routines for the clusterregistry API.
client/clientset_generated/clientset This package has the automatically generated clientset.	This package has the automatically generated clientset.
client/clientset_generated/clientset/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
client/clientset_generated/clientset/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
client/clientset_generated/clientset/typed/clusterregistry/v1alpha1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
client/clientset_generated/clientset/typed/clusterregistry/v1alpha1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
client/clientset_generated/internalclientset This package has the automatically generated clientset.	This package has the automatically generated clientset.
client/clientset_generated/internalclientset/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
client/clientset_generated/internalclientset/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
client/clientset_generated/internalclientset/typed/clusterregistry/internalversion This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
client/clientset_generated/internalclientset/typed/clusterregistry/internalversion/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
client/informers_generated/externalversions
client/informers_generated/externalversions/clusterregistry
client/informers_generated/externalversions/clusterregistry/v1alpha1
client/informers_generated/externalversions/internalinterfaces
client/informers_generated/internalversion
client/informers_generated/internalversion/clusterregistry
client/informers_generated/internalversion/clusterregistry/internalversion
client/informers_generated/internalversion/internalinterfaces
client/listers_generated/clusterregistry/internalversion
client/listers_generated/clusterregistry/v1alpha1
clusterregistry Package clusterregistry contains the meat of the implementation for k8s.io/cluster-registry/cmd/clusterregistry.	Package clusterregistry contains the meat of the implementation for k8s.io/cluster-registry/cmd/clusterregistry.
clusterregistry/authenticator Package authenticator contains code for creating an authenticator for a standalone cluster registry based on the configuration provided to the clusteregistry binary.	Package authenticator contains code for creating an authenticator for a standalone cluster registry based on the configuration provided to the clusteregistry binary.
clusterregistry/options Package options contains flags and options for interacting with the cluster registry API server.	Package options contains flags and options for interacting with the cluster registry API server.
crinit Package crinit contains the meat of the implementation for the crinit tool, which bootstraps a cluster registry into an existing Kubernetes cluster.	Package crinit contains the meat of the implementation for the crinit tool, which bootstraps a cluster registry into an existing Kubernetes cluster.
crinit/aggregated Package aggregated contains the implementation of the `aggregated` subcommand of crinit, which deploys a cluster registry as an aggregated API server in a Kubernetes cluster.	Package aggregated contains the implementation of the `aggregated` subcommand of crinit, which deploys a cluster registry as an aggregated API server in a Kubernetes cluster.
crinit/standalone Package standalone contains the implementation of the `standalone` subcommand of `crinit`, which deploys a cluster registry as a standalone API server in a host Kubernetes cluster.	Package standalone contains the implementation of the `standalone` subcommand of `crinit`, which deploys a cluster registry as a standalone API server in a host Kubernetes cluster.
crinit/util Package util contains code shared between the subcommands of crinit.	Package util contains code shared between the subcommands of crinit.
registry/cluster Package cluster contains the implementation of a registry for Cluster objects.	Package cluster contains the implementation of a registry for Cluster objects.
registry/cluster/etcd Package etcd contains an implementation of a store for Cluster objects.	Package etcd contains an implementation of a store for Cluster objects.
registry/cluster/etcd/registrytestutil Package registrytestutil contains utilities for testing the etcd-based Cluster storage implementation.	Package registrytestutil contains utilities for testing the etcd-based Cluster storage implementation.
version
test
integration Package testing contains an integration test harness and an integration test for the cluster registry API server.	Package testing contains an integration test harness and an integration test for the cluster registry API server.