suse / registries-operator

A Kubernetes operator for images registries

Registry operator:

• Description
• Quickstart
• Devel
• Additional Info

Description

A Docker registries operator for Kubernetes, developed inside the Kubic project.

features:

• Automatic installation of registries certificates based on some CRDs.

Quick start

• load the operator with

  kubectl apply -f https://raw.githubusercontent.com/kubic-project/registries-operator/master/deployments/registries-operator-full.yaml
  

• once the operator is running, store the certificate for your registry in a Secret with:

  kubectl create secret generic suse-ca-crt --from-file=ca.crt=/etc/pki/trust/anchors/SUSE_CaaSP_CA.crt -n kube-system
  

  where /etc/pki/trust/anchors/SUSE_CaaSP_CA.crt is the certificate and suse-ca-crt is the Secret.

• create a Registry object like this:

  # registry.yaml
  apiVersion: "kubic.opensuse.org/v1beta1"
  kind: Registry
  metadata:
    name: suse-registry
    namespace: kube-system
  spec:
    hostPort: "registry.suse.de:5000"
    # secret with the ca.crt used for pulling images from this registry
    certificate:
      name: suse-ca-crt
      namespace: kube-system

  then you can load it with kubectl apply -f registry.yaml.

• once this is done, the suse-ca-crt should automatically appear in all the machines in your cluster, and all the Docker daemons in your cluster will be able to pull from that registry automatically.

Devel

• See the development documentation if you intend to contribute to this project.

Extra

• the registries-operator image in the Docker Hub.
• the kubic-init container, a container for bootstrapping a Kubernetes cluster on top of MicroOS (an openSUSE-Tumbleweed-based OS focused on running containers).
• the Kubic Project home page.

registries-operator's Issues

fix golint target failing

fix golint failing at moment

Follow-up backport logic from dex-operator tests integration

backport same logic as pr SUSE/dex-operator#3

enable tests unit in circle ci when separation is done

#15

integration-test: test certificate removal during int. tests

We should test cert removal during integration test.

fix `make test` target

fix make test target currently failing

integration-tests: test certificate update

description:

we need to test the certification update in integration tests

Building Docker image from Dockerfile fails

Running a docker build -t <label> . form the project's root directory generates the following error:

make: *** No rule to make target 'deps'. Stop.
make: Leaving directory '/go/src/github.com/kubic-project/registries-operator'
The command '/bin/sh -c make -C $BUILD_DIR clean deps' returned a non-zero code: 2

The offending command in the Dockerfile is RUN make -C $BUILD_DIR clean deps

e2e-tests: deploy operator inside the cluster with kind

Problem

Currently we deploy the reg. operator outside cluster running in background.

We need to deploy the full-operator image inside the k8s cluster.

This can achieve with kind.
We also need an extra target like make e2e-tests-full-kind or something like that.

Infos

Take inspiration from this https://github.com/xmudrii/travis-kind/blob/master/build_images.sh

fix golint and make golint fail to circleci

Description:

• Fix current golint issues we have. See log here

• Make golint fail in circleci if there an offences ( at moment make check will always succeed)

>>> Reformatting code
pkg/apis/kubic/v1beta1/register.go
/home/dmaiocchi/go/src/github.com/kubic-project/registries-operator/cmd/registries-operator/main.go:1:1: package comment should not have leading space
/home/dmaiocchi/go/src/github.com/kubic-project/registries-operator/cmd/registries-operator/main.go:42:1: comment on exported var Version should be of the form "Version ..."
/home/dmaiocchi/go/src/github.com/kubic-project/registries-operator/cmd/registries-operator/main.go:44:5: exported var Build should have comment or be unexported
/home/dmaiocchi/go/src/github.com/kubic-project/registries-operator/pkg/apis/kubic/v1beta1/registry_types.go:49:1: comment on exported type RegistryCertificateStatus should be of the form "RegistryCertificateStatus ..." (with optional leading article)
/home/dmaiocchi/go/src/github.com/kubic-project/registries-operator/pkg/apis/kubic/v1beta1/registry_types.go:76:1: comment on exported method Registry.GetCertificateSecret should be of the form "GetCertificateSecret ..."
/home/dmaiocchi/go/src/github.com/kubic-project/registries-operator/pkg/apis/kubic/v1beta1/registry_types.go:91:1: receiver name r should be consistent with previous receiver name registry for Registry
/home/dmaiocchi/go/src/github.com/kubic-project/registries-operator/pkg/config/globals.go:21:2: comment on exported var DefaultPrefix should be of the form "DefaultPrefix ..."
/home/dmaiocchi/go/src/github.com/kubic-project/registries-operator/pkg/config/globals.go:24:2: comment on exported var DefaultDeployNumReplicas should be of the form "DefaultDeployNumReplicas ..."
/home/dmaiocchi/go/src/github.com/kubic-project/registries-operator/pkg/test/util.go:1:1: package comment should be of the form "Package test ..."
/home/dmaiocchi/go/src/github.com/kubic-project/registries-operator/pkg/test/util.go:1:1: package comment should not have leading space
/home/dmaiocchi/go/src/github.com/kubic-project/registries-operator/pkg/util/strings.go:26:6: func SafeId should be SafeID

add godoc badget and goreport badget

Description:

Add this 2 badgets on readme

Take inspiration from https://github.com/kubic-project/kubic-init

ApiGroup name kubic is perhaps to generic

Each operator can have differents Api groups, we should change the kubic api group name and make it more specific.
https://github.com/kubic-project/registries-operator/tree/master/pkg/apis

i think registry could be ok , open for suggestions

research on updating dockerhub images via circleci job

Description:

it would be nice that if the dockerbuild image job pass, we could push the image to dockerhub