[WIP] console-operator based on client-go

Dockerfile

@@ -1,10 +1,25 @@
-# This is an example operator.
-#
-# The standard name for its image is enj/example-operator
-#
-FROM openshift/origin-release:golang-1.10
-COPY . /go/src/github.com/enj/example-operator
-RUN cd /go/src/github.com/enj/example-operator && go build ./cmd/example
+FROM openshift/origin-release:golang-1.10 as builder
+WORKDIR /go/src/github.com/openshift/console-operator
+COPY . .
+RUN make build
 
 FROM centos:7
-COPY --from=0 /go/src/github.com/enj/example-operator/example /usr/bin/example
+RUN useradd console-operator
+USER console-operator
+COPY --from=builder /go/src/github.com/openshift/console-operator/_output/local/bin/linux/amd64/console /usr/bin
+
+# these manifests are necessary for the installer
+COPY manifests /manifests/
+
+LABEL io.k8s.display-name="OpenShift console-operator" \
+      io.k8s.description="This is a component of OpenShift Container Platform and manages the lifecycle of the web console." \
+      io.openshift.tags="openshift" \
+      maintainer="Benjamin A. Petersen <bpetersen@redhat.com>"
+
+LABEL io.openshift.release.operator true
+
+# entrypoint specified in 03-operator.yaml as `console-operator`
+# CMD ["/usr/bin/console", "operator", "--kubeconfig", "path/to/config", "--config", "./install/config.yaml", "--v", "4"]
+CMD ["/usr/bin/console", "operator", "--v", "4"]
+
+

Dockerfile.osx

@@ -0,0 +1,27 @@
+FROM openshift/origin-release:golang-1.10 as builder
+WORKDIR /go/src/github.com/openshift/console-operator
+COPY . .
+RUN make build
+
+FROM centos:7
+RUN useradd console-operator
+USER console-operator
+COPY --from=builder /go/src/github.com/openshift/console-operator/_output/local/bin/darwin/amd64/console /usr/bin
+
+# these manifests are necessary for the installer
+COPY manifests /manifests/
+
+LABEL io.k8s.display-name="OpenShift console-operator" \
+      io.k8s.description="This is a component of OpenShift Container Platform and manages the lifecycle of the web console." \
+      io.openshift.tags="openshift" \
+      maintainer="Benjamin A. Petersen <bpetersen@redhat.com>"
+
+LABEL io.openshift.release.operator true
+
+# entrypoint specified in 03-operator.yaml as `console-operator`
+# CMD ["/usr/bin/console", "operator", "--kubeconfig", "path/to/config", "--config", "./install/config.yaml", "--v", "4"]
+CMD ["/usr/bin/console", "operator", "--v", "4"]
+
+
+
+

README.md

@@ -1,17 +1,84 @@
-# Example Operator
+# Console Operator
 
-```shell
-cd "${GOPATH}/src/github.com/enj/example-operator"
+An operator for OpenShift Console built using the operator-sdk.
 
-oc new-project example-operator
+The console-operator installs and maintains the web console on a cluster.
 
-oc create -f manifests/00-crd.yaml
-oc create -f install/cr.yaml
+## Run on a 4.0.0 cluster
 
+The console operator is installed by default and will automatically maintain a console.  
+
+## Development Setup
+
+* Install Go -- https://golang.org/doc/install
+
+## Development on a < 4.0.0 cluster 
+
+If using `oc cluster up` on a `< 4.0.0` cluster you will need the `--public-hostname` flag 
+when you cluster up. The `--server-loglevel` flag is helpful for debugging. OAuth issues 
+will not be visible unless set to at least `3`.
+
+```bash 
+# there are a variety of ways to get your machine IP address
+# this example works on OSX
+oc cluster up --public-hostname=$(ipconfig getifaddr en0) --server-loglevel 3 
+```
+
+Then, create the manifests:
+
+```bash
+# pre 4.0.0 needs this, but it is not part of the post 4.0.0 manifests payload
+oc create -f ./examples/crd-clusteroperator.yaml
+# standard 4.0.0 deploy of the operator
+oc create -f ./manifests
+# to run the operator locally, delete the deployment and follow instructions below
+oc delete -f ./manifests/05-operator.yaml 
+```
+
+If you don't know where your `kubeconfig` file is:
+
+```bash 
+# just a high number
+oc whoami --loglevel=100
+# likely output will be $HOME/.kube/config 
+```
+
+Build the console operator binary:
+
+```bash 
+make update-codegen
 make
-export PATH="_output/local/bin/linux/amd64:${PATH}"
-example operator --kubeconfig admin.kubeconfig --config install/config.yaml --v=4
+make verify 
+# add the binary to your path 
+# arc will be "linux" or "darwin", etc
+export PATH="_output/local/bin/<arc>/amd64:${PATH}"
+```
+
+Now, run the console operator locally:
+
+```bash
+IMAGE=docker.io/openshift/origin-console:latest \ 
+    console operator \
+    --kubeconfig $HOME/.kube/config \
+    --config examples/config.yaml \
+    --create-default-console \ 
+    --v 4
+```
 
-oc get exampleoperator example-operator-resource -o yaml
-oc get secret example-operator-resource -o yaml
+Check for the existence of expected resources:
+
+```bash 
+oc get console 
+# etc
 ```
+
+
+Explanation:
+
+- The `IMAGE` env var is needed to declare what console image to deploy.  The `manifests/05-operator.yaml` shows this var as well
+- The `--operator-flags` flag is used to pass flags to the operator binary
+    - `--create-default-console true` tells the operator binary to create a console CR if one does not exist on startup.
+
+The `IMAGE` env var exists so that when the console-operator is packaged up for a release, we can replace the value
+with a final image.  See CVO documentation for details. 
+

cmd/example/main.go → cmd/console/main.go

@@ -1,40 +1,50 @@
 package main
 
 import (
+	// standard lib
 	goflag "flag"
 	"fmt"
 	"math/rand"
 	"os"
 	"time"
-
+	// 3rd party
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
-
+	// kube / openshift
 	utilflag "k8s.io/apiserver/pkg/util/flag"
 	"k8s.io/apiserver/pkg/util/logs"
-
-	"github.com/enj/example-operator/pkg/cmd/operator"
+	// us
+	"github.com/openshift/console-operator/pkg/cmd/operator"
+	"github.com/openshift/console-operator/pkg/cmd/version"
 )
 
 func main() {
+	// random seed, set it & forget it
 	rand.Seed(time.Now().UTC().UnixNano())
-
+	// normalize flags, if _ use -
 	pflag.CommandLine.SetNormalizeFunc(utilflag.WordSepNormalizeFunc)
+	// add the default flag set for go
 	pflag.CommandLine.AddGoFlagSet(goflag.CommandLine)
 
 	logs.InitLogs()
 	defer logs.FlushLogs()
 
-	command := NewExampleCommand()
+	// build a new cobra command
+	command := NewOperatorCommand()
+	// die on errors
 	if err := command.Execute(); err != nil {
 		fmt.Fprintf(os.Stderr, "%v\n", err)
 		os.Exit(1)
 	}
 }
 
-func NewExampleCommand() *cobra.Command {
+// create the root "console" command
+// we will add subcommands to this
+func NewOperatorCommand() *cobra.Command {
+	// "console" just prints help, then exists.  It doesn't start
+	// the operator.
 	cmd := &cobra.Command{
-		Use:   "example",
+		Use:   "console",
 		Short: "Top level command",
 		Run: func(cmd *cobra.Command, args []string) {
 			cmd.Help()
@@ -43,6 +53,7 @@ func NewExampleCommand() *cobra.Command {
 	}
 
 	cmd.AddCommand(operator.NewOperator())
+	cmd.AddCommand(version.NewVersion())
 
 	return cmd
 }

dev_delete_all.sh

@@ -0,0 +1,49 @@
+#!/usr/bin/env bash
+
+# this just deletes everything under /manifests,
+# but tries to space them out a bit to avoid errors.
+# in the end, it creates a custom resource to kick
+# the operator into action
+
+FILE=examples/cr.yaml
+echo "creating ${FILE}"
+oc create -f $FILE
+
+for FILE in `find ./manifests -name '05-*'`
+do
+  echo "deleting ${FILE}"
+  oc create -f $FILE
+done
+
+for FILE in `find ./manifests -name '04-*'`
+do
+  echo "deleting ${FILE}"
+  oc create -f $FILE
+done
+
+for FILE in `find ./manifests -name '03-*'`
+do
+  echo "deleting ${FILE}"
+  oc create -f $FILE
+done
+
+for FILE in `find ./manifests -name '02-*'`
+do
+  echo "deleting ${FILE}"
+  oc create -f $FILE
+done
+
+for FILE in `find ./manifests -name '01-*'`
+do
+  echo "deleting ${FILE}"
+  oc create -f $FILE
+done
+
+for FILE in `find ./manifests -name '00-*'`
+do
+  echo "deleting ${FILE}"
+  oc create -f $FILE
+done
+
+
+

dev_deploy_all.sh

@@ -0,0 +1,59 @@
+#!/usr/bin/env bash
+
+# this just deploys everything under /manifests,
+# but tries to space them out a bit to avoid errors.
+# in the end, it creates a custom resource to kick
+# the operator into action
+
+for FILE in `find ./manifests -name '00-*'`
+do
+    echo "creating ${FILE}"
+  oc create -f $FILE
+done
+
+sleep 2
+
+for FILE in `find ./manifests -name '01-*'`
+do
+    echo "creating ${FILE}"
+  oc create -f $FILE
+done
+
+sleep 2
+
+for FILE in `find ./manifests -name '02-*'`
+do
+  echo "creating ${FILE}"
+  oc create -f $FILE
+done
+
+sleep 2
+
+for FILE in `find ./manifests -name '03-*'`
+do
+  echo "creating ${FILE}"
+  oc create -f $FILE
+done
+
+sleep 2
+
+for FILE in `find ./manifests -name '04-*'`
+do
+  echo "creating ${FILE}"
+  oc create -f $FILE
+done
+
+sleep 2
+
+for FILE in `find ./manifests -name '05-*'`
+do
+  echo "creating ${FILE}"
+  oc create -f $FILE
+done
+
+sleep 2
+
+
+FILE=examples/cr.yaml
+echo "creating ${FILE}"
+oc create -f $FILE