multicloud-operators-channel

multicloud-operators-channel

Table of Contents generated with DocToc

• Overview
• Quick Start
  • Setting up a channel to sync resourcese between your hub cluster and a object bucket
  • Trouble shooting
• Community, discussion, contribution, and support
• References
  • multicloud-operators repositories

Overview

Channel controller sync and promote resources from the target source to a channel namespace on your hub cluster or to a host(such as object bucket). Then your subscription can consume these resources from the channel directly.

Quick Start

Please keep in mind, if you were using this operator before, you might need to migrate your resource api-group and version from app.ibm.com/v1alpha1 to multicloud-apps.io/v1. Example can be found under the examples folder.

For a quick start, we are going to create a namespace channel, meaning you can put the resouce to a namespace, which is watching by our channel operator, then the operator will promote this resoucre to the channel namespace, which should be the namesapce the channel operator sits.

The following example is tested on a minikube, so that you can play with this operator with out worrying too much extra stuff, such as secrity for a real cluster.

Note: please adjust the image setting of the operator at ./deploy/standalone/operator.yaml, at least make sure, it's using the correct image tag and image policy.

Setting up a channel to sync resourcese between your hub cluster and a object bucket

• Clone the channel operator repository

% mkdir -p "$GOPATH"/src/github.com/open-cluster-management

% cd "$GOPATH"/src/github.com/open-cluster-management

% git clone https://github.com/open-cluster-management/multicloud-operators-channel.git

% cd "$GOPATH"/src/github.com/open-cluster-management/multicloud-operators-channel

• Setup environment and deploy channel operator

# apply all the necessary CRDs
% kubectl apply -f ./deploy/crds
% kubectl apply -f ./deploy/dependent-crds


**Note, if you are seeing the following error, it's fine, since we kept the CR generated by operator-sdk in the deploy folder to keep consistency.**

error: unable to recognize "deploy/crds/multicloud-apps.io_v1_channel_cr.yaml": no matches for kind "Channel" in version "multicloud-apps.io/v1"

# deploy the channel controller to your cluster via a deployment, also grant access to the controller
% kubectl apply -f ./deploy/standalone

• Create a Channel and deploy the payload(the resource you want channel operator to help you move/promote around)

# a simple namespace type channel example
% kubectl apply -f ./examples/channel-alone

As a result, a config map wrapped by deployable, at default namespace. At the meantime, it will also deploy a channel resource at the ch-ns namespace.

% kubectl get deployables.multicloud-apps.io

NAME                            TEMPLATE-KIND   TEMPLATE-APIVERSION   AGE   STATUS
payload-cfg-namespace-channel   ConfigMap       v1                    9s

% kubectl get channel -n ch-ns

NAME   TYPE        PATHNAME   AGE
ns     Namespace   ch-ns      20s

Resouces got moved to it destination, and subscription can take over from here, deploying this resource(it will be the configmap deployed) to your managed cluster.

% kubectl get deployables.multicloud-apps.io -n ch-ns

NAME                                  TEMPLATE-KIND   TEMPLATE-APIVERSION   AGE   STATUS
payload-cfg-namespace-channel-gt47s   ConfigMap       v1                    37s

Check the Getting Started doc for more details

Trouble shooting

• Check operator availability

% kubectl get deploy,pods
NAME                                           READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/multicloud-operators-channel   1/1     1            1           41m

NAME                                               READY   STATUS    RESTARTS   AGE
pod/multicloud-operators-channel-f4fbbb9d9-6mcql   1/1     Running   0          13m

• Check Channel and its status

% kubectl describe channel ns -n ch-ns

Name:         ns
Namespace:    ch-ns
Labels:       <none>
Annotations:  kubectl.kubernetes.io/last-applied-configuration:
                {"apiVersion":"app.ibm.com/v1alpha1","kind":"Channel","metadata":{"annotations":{},"name":"ns","namespace":"ch-ns"},"spec":{"pathname":"ch...
API Version:  app.ibm.com/v1alpha1
Kind:         Channel
Metadata:
  Creation Timestamp:  2020-02-25T16:05:08Z
  Generation:          1
  Resource Version:    10126
  Self Link:           /apis/app.ibm.com/v1alpha1/namespaces/ch-ns/channels/ns
  UID:                 6796d764-1f89-4747-9e2c-e49533ecd8dd
Spec:
  Pathname:  ch-ns
  Source Namespaces:
    default
  Type:  Namespace
Events:
  Type    Reason  Age   From     Message
  ----    ------  ----  ----     -------
  Normal  Deploy  59s   channel  Depolyable ch-ns/payload-cfg-namespace-channel-gt47s created in the channel, Status: Success, Channel: ch-ns/ns>

• Check Channel operator log

Normally, we care the reconcile trace. For each flow, it should at least have a valid reconcile log for the deployable.

% kubectl logs multicloud-operators-channel-f4fbbb9d9-6mcql

I0225 15:47:46.659919       1 manager.go:65] Go Version: go1.13
I0225 15:47:46.660006       1 manager.go:66] Go OS/Arch: linux/amd64
I0225 15:47:46.660012       1 manager.go:67] Version of operator-sdk: v0.12.0
I0225 15:47:48.705442       1 manager.go:148] Registering Components.
I0225 15:47:48.705517       1 manager.go:151] setting up scheme
I0225 15:47:48.706721       1 manager.go:171] Setting up controller
I0225 15:47:48.707552       1 manager.go:178] setting up webhooks
time="2020-02-25T15:47:50Z" level=info msg="Could not create ServiceMonitor objecterrorno ServiceMonitor registered with the API" source="manager.go:216"
I0225 15:47:50.748181       1 manager.go:220] Install prometheus-operator in your cluster to create ServiceMonitor objectserrorno ServiceMonitor registered with the API
I0225 15:47:50.748663       1 manager.go:224] Starting the Cmd.
I0225 15:47:50.850112       1 synchronizer.go:78] Housekeeping loop ...
I0225 15:47:50.850377       1 synchronizer.go:125] Housekeeping loop ...
I0225 15:48:00.850993       1 synchronizer.go:78] Housekeeping loop ...
I0225 15:48:00.851535       1 synchronizer.go:125] Housekeeping loop ...
I0225 15:48:10.851468       1 synchronizer.go:78] Housekeeping loop ...
I0225 15:48:10.851723       1 synchronizer.go:125] Housekeeping loop ...
I0225 15:48:20.852381       1 synchronizer.go:125] Housekeeping loop ...
I0225 15:48:20.852529       1 synchronizer.go:78] Housekeeping loop ...

....


I0225 16:00:19.424095       1 deployable_controller.go:293] Creating deployable in channel{{ } { payload-cfg-namespace-channel- ch-ns    0 0001-01-01 00:00:00 +0000 UTC <nil> <nil> map[] map[app.ibm.com/channel:ch-ns/ns app.ibm.com/hosting-deployable:default/payload-cfg-namespace-channel app.ibm.com/is-local-deployable:false kubectl.kubernetes.io/last-applied-configuration:{"apiVersion":"multicloud-apps.io/v1alpha1","kind":"Deployable","metadata":{"annotations":{"app.ibm.com/is-local-deployable":"false"},"name":"payload-cfg-namespace-channel","namespace":"default"},"spec":{"channels":["ns"],"template":{"apiVersion":"v1","data":{"database":"mongodb"},"kind":"ConfigMap","metadata":{"name":"cfg-from-ch-qa"}}}}

Please refer to Trouble shooting documentation for further info.

Community, discussion, contribution, and support

Check the DEVELOPMENT Doc for how to build and make changes.

Check the CONTRIBUTING Doc for how to contribute to the repo.

You can reach the maintainers of this by raising issues. Slack communication is coming soon

References

multicloud-operators repositories

• multicloud-operators-deployable
• multicloud-operators-placementrule
• multicloud-operators-channel
• multicloud-operators-subscription
• multicloud-operators-subscription-release

If you have any further questions, please refer to help documentation for further information.