Table of Contents generated with DocToc

• kubefed-operator
  • Deploying and testing
    • Prerequisites
    • Using operator-sdk up local
    • Smoke Testing
      • Usage:
      • Example: for in-cluster deployment

kubefed-operator

This repository contains code for an operator for deploying KubeFed. It is planned to replace the federation-v2-operator repo.

Deploying and testing

This work-in-progress section describes how people developing this operator can deploy it.

Prerequisites

• Kind tool
• The latest version of kubefedctl binary installed in your $PATH
• If you’re planning to test against the openshift cluster then ensure that it’s already up and running.
• Operator-SDK CLI tool

Using operator-sdk up local

The operator SDK provides a way to run your operator locally outside a cluster. This allows you to easily iterate on changes without having to push an image.

All you need to do is run the following command from the root directory of this project:

# if you already have a kubernetes cluster
$ kubectl create ns kubefed-test
# or use create-cluster.sh script to create one
$ ./scripts/create-cluster.sh
$ kubectl apply -f deploy/crds/operator_v1alpha1_kubefed_cr.yaml
$ operator-sdk up local --namespace=kubefed-test

This will run the operator configured to watch the kubefed-test namespace.

{"level":"info","ts":1560806650.3372273,"logger":"kubebuilder.controller","msg":"Starting workers","controller":"kubefed-controller","worker count":1}

Once you get the above message, you can create a KubeFed in the kubefed-test namespace to drive the installation in that namespace:

$ kubectl create -f deploy/crds/operator_v1alpha1_kubefed_cr.yaml -n kubefed-test

When the operator is ready, you will see the following message:

{"level":"info","ts":1560806722.3100324,"logger":"controller_kubefed","msg":"Finished reconciling kubefed","Request.Namespace":"kubefed-test","Request.Name":"kubefed-resource"}

Altenatively, you can also install the operator locally by using the following script:

$ ./scripts/install-kubefed.sh -n kubefed-test -d local -s Namespaced

Smoke Testing

The smoke-test script is designed to peform smoke testing on the kubefed-operator. It's handling the following scenarios:

• A local deployment (Location: local)
• in-cluster deployment using Kind (Location: cluster)
• Deployment via OLM on Minikube (Location: olm-kube)
• Deployment via OLM on Openshift Cluster (Location: olm-openshift)

Usage:

$ ./scripts/smoke-test.sh  -n ${NAMESPACE} -d ${LOCATION} -i ${IMAGE_NAME} -s ${SCOPE} -o ${OPERATOR_VERSION}

Flag	Description	Default value
n	Namespace where you will be installing the kubefed-operator	default
d	Location defines the mode of deployment	local
i	Docker Image location	quay.io/openshift/kubefed-operator:v0.1.0-rc6
s	Scope of the kubefed resource	Namespaced
o	Operator Version the versioned directory from where the CRD definitions will be applied for olm-kube and olm-openshift deployments

Example: for in-cluster deployment

$ ./scripts/smoke-test.sh -n kubefed-test -d cluster -s Namespaced