Merge pull request #2 from oranichu/main

Initial release of golang Skydive operator

Author: lebauce

.idea/.gitignore

@@ -0,0 +1,27 @@
+# Build the manager binary
+FROM golang:1.13 as builder
+
+WORKDIR /workspace
+# Copy the Go Modules manifests
+COPY go.mod go.mod
+COPY go.sum go.sum
+# cache deps before building and copying source so that we don't need to re-download as much
+# and so that source changes don't invalidate our downloaded layer
+RUN go mod download
+
+# Copy the go source
+COPY main.go main.go
+COPY api/ api/
+COPY controllers/ controllers/
+
+# Build
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on go build -a -o manager main.go
+
+# Use distroless as minimal base image to package the manager binary
+# Refer to https://github.com/GoogleContainerTools/distroless for more details
+FROM gcr.io/distroless/static:nonroot
+WORKDIR /
+COPY --from=builder /workspace/manager .
+USER nonroot:nonroot
+
+ENTRYPOINT ["/manager"]

.idea/modules.xml

@@ -0,0 +1,80 @@
+
+# Image URL to use all building/pushing image targets
+IMG ?= controller:latest
+# Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
+CRD_OPTIONS ?= "crd:crdVersions=v1"
+
+# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
+ifeq (,$(shell go env GOBIN))
+GOBIN=$(shell go env GOPATH)/bin
+else
+GOBIN=$(shell go env GOBIN)
+endif
+
+all: manager
+
+# Run tests
+test: generate fmt vet manifests
+	go test ./... -coverprofile cover.out
+
+# Build manager binary
+manager: generate fmt vet
+	go build -o bin/manager main.go
+
+# Run against the configured Kubernetes cluster in ~/.kube/config
+run: generate fmt vet manifests
+	go run ./main.go
+
+# Install CRDs into a cluster
+install: manifests
+	kustomize build config/crd | kubectl apply -f -
+
+# Uninstall CRDs from a cluster
+uninstall: manifests
+	kustomize build config/crd | kubectl delete -f -
+
+# Deploy controller in the configured Kubernetes cluster in ~/.kube/config
+deploy: manifests
+	cd config/manager && kustomize edit set image controller=${IMG}
+	kustomize build config/default | kubectl apply -f -
+
+# Generate manifests e.g. CRD, RBAC etc.
+manifests: controller-gen
+	$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
+
+# Run go fmt against code
+fmt:
+	go fmt ./...
+
+# Run go vet against code
+vet:
+	go vet ./...
+
+# Generate code
+generate: controller-gen
+	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
+
+# Build the docker image
+docker-build: test
+	docker build . -t ${IMG}
+
+# Push the docker image
+docker-push:
+	docker push ${IMG}
+
+# find or download controller-gen
+# download controller-gen if necessary
+controller-gen:
+ifeq (, $(shell which controller-gen))
+	@{ \
+	set -e ;\
+	CONTROLLER_GEN_TMP_DIR=$$(mktemp -d) ;\
+	cd $$CONTROLLER_GEN_TMP_DIR ;\
+	go mod init tmp ;\
+	go get sigs.k8s.io/controller-tools/cmd/[email protected] ;\
+	rm -rf $$CONTROLLER_GEN_TMP_DIR ;\
+	}
+CONTROLLER_GEN=$(GOBIN)/controller-gen
+else
+CONTROLLER_GEN=$(shell which controller-gen)
+endif

.idea/skydive-golang-operator.iml

@@ -0,0 +1,19 @@
+domain: example.com
+repo: skydive
+resources:
+- group: skydive
+  kind: SkydiveAgents
+  version: v1beta1
+- group: skydive
+  kind: SkydiveAnalyzer
+  version: v1beta1
+- group: skydive
+  kind: Skydive
+  version: v1
+- group: skydive
+  kind: SkydiveFlowExporter
+  version: v1
+- group: skydive
+  kind: PrometheusConnector
+  version: v1
+version: "2"

.idea/vcs.xml

@@ -0,0 +1,92 @@
+<!-- ABOUT THE PROJECT -->
+
+# Skydive Operator
+
+This is an operator to deploy skydive analyzer, agents and flow-exporter.
+
+<!-- GETTING STARTED -->
+
+## Getting Started
+
+To set up this operator follow the instructions below:
+
+### Prerequisites
+
+* Make sure you have golang installed on your machine, The go-lang version that this operator was built on is go1.15.7
+  darwin/amd64
+
+* An openshift cluster
+    * If you wish to run this locally by using kind please
+      check [KindInstallationREADME.md](hack/KindInstallationREADME.md)
+
+### Installation - Open-Shift
+
+run the script (make sure you are logged into open shift cluster):
+
+```
+./deploy_skydive_operator_on_openshift.sh
+```
+
+If for some reason you have changed your KUBECONFIG default location please update the KUBECONFIG environment variable
+by using this command:
+
+```bash
+export KUBECONFIG=$PATH_TO_YOUR_KUBECONFIG
+```
+
+#### Analyzer UI
+
+1a. Check that all the pods, services and routes are running and afterwards run the following command:
+
+```sh
+oc get routes
+  ```
+
+2a. post the url into your web-browser (make sure you have got an access to the cluster and are not blocked by it's
+firewall)
+
+1b. If routes option doesn't work, run the following command
+
+  ```sh
+oc port-forward service/skydive-analyzer 8082:8082 --namespace=skydive
+  ```
+
+2b. Now open web-browser on localhost:8082
+
+#### Flow Exporter
+
+After a successful deployment of skydive operator run the script:
+
+```
+./deploy_skydive_flow_exporter_operator.sh
+```
+
+for deployment developing using minio run: (don't forget to kill the old flow_exporter_operator if still running)
+
+```
+./hack/deploy_skydive_flow_exporter_dev_operator.sh
+```
+
+#### Prometheus Connector
+
+After a successful deployment of skydive operator run the script:
+
+```
+./deploy_prometheus_connector.sh
+```
+
+### Customize skydive deployment / CRD
+
+Modify the current config/skydive_v1_skydive.yaml and pick what you wish to deploy (insert true or false in the relevant
+field), the options are as follows:
+
+* Skydive agents
+* Skydive analyzer
+    * Service route
+
+You can provide the skydive operator with environments variables in order to customize your skydive deployment.
+Checkout [this example](config/skydive_v1_skydive_env_example.yaml) of crd to get started with providing environment
+variables to the skydive operator, full list of acceptable enviorment variables are
+listed [here](https://github.com/skydive-project/skydive/blob/master/etc/skydive.yml.default)
+
+Choose your logging level (defaults to DEBUG)

Dockerfile

@@ -0,0 +1,36 @@
+/*
+
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package v1 contains API Schema definitions for the skydive v1 API group
+// +kubebuilder:object:generate=true
+// +groupName=skydive.example.com
+package v1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"sigs.k8s.io/controller-runtime/pkg/scheme"
+)
+
+var (
+	// GroupVersion is group version used to register these objects
+	GroupVersion = schema.GroupVersion{Group: "skydive.example.com", Version: "v1"}
+
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+
+	// AddToScheme adds the types in this group-version to the given scheme.
+	AddToScheme = SchemeBuilder.AddToScheme
+)

Makefile

@@ -0,0 +1,71 @@
+/*
+
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+import (
+	v1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
+// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
+
+// PrometheusConnectorSpec defines the desired state of PrometheusConnector
+type PrometheusConnectorSpec struct {
+	Namespace string `json:"namespace,omitempty"`
+
+	Deployment PrometheusConnectorDeploymentSpec `json:"deployment"`
+}
+
+type PrometheusConnectorDeploymentSpec struct {
+	// List of environment variables to set in the container.
+	// Cannot be updated.
+	// +optional
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	Env []v1.EnvVar `json:"env,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,7,rep,name=env"`
+}
+
+// PrometheusConnectorStatus defines the observed state of PrometheusConnector
+type PrometheusConnectorStatus struct {
+	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+}
+
+// +kubebuilder:object:root=true
+
+// PrometheusConnector is the Schema for the prometheusconnectors API
+type PrometheusConnector struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   PrometheusConnectorSpec   `json:"spec,omitempty"`
+	Status PrometheusConnectorStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// PrometheusConnectorList contains a list of PrometheusConnector
+type PrometheusConnectorList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []PrometheusConnector `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&PrometheusConnector{}, &PrometheusConnectorList{})
+}