cluster-registry

This repository contains the code for the cluster registry. The cluster registry is an effort being led under the auspices of sig-multicluster.

This is currently in the prototyping stage, and is not yet ready for use except by contributors and experimenters.

If you have questions, please reach out to kubernetes-sig-federation.

Cluster Registry API design

Development

Prerequisites

You must have a recent version of bazel installed. Bazel is the recommended way to build and test the cluster registry. Bazel is designed to maintain compatibility with standard Go tooling, but this is not tested on a regular basis, and some scripts/tooling in this project are built around Bazel.

NOTE: There is an issue with version bazel 0.6.0. As a workaround, use 0.5.x, or pass the flag --incompatible_comprehension_variables_do_not_leak=false to bazel 0.6.0 invocations.

Before doing any development work, you must (in order, from the repository root directory, after cloning):

1. run update-codegen.sh
2. run bazel run //:gazelle

Building crinit

From the root of the repository:

1. Run bazel build //cmd/crinit.

Building clusterregistry

1. Run bazel build //cmd/clusterregistry
2. If you want to build a docker image, run bazel build //cmd/clusterregistry:clusterregistry-image
3. To push an image to Google Container registry, you'll need to run bazel run //cmd/clusterregistry:push-clusterregistry-image --define project=<your_project_id>

Run all tests

You can run all the unit tests by running bazel test ... from the repository root.