Skip to content

Commit

Permalink
Add operator code
Browse files Browse the repository at this point in the history
  • Loading branch information
damemi committed Jan 29, 2025
1 parent 9afcdfc commit 9930ffe
Show file tree
Hide file tree
Showing 63 changed files with 4,308 additions and 0 deletions.
12 changes: 12 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@ build-image/%:
--build-arg SUMMARY="$(SUMMARY)" \
--build-arg DESCRIPTION="$(DESCRIPTION)"

.PHONY: build-operator-index
build-operator-index:
opm index add --bundles $(ORG)/odigos-bundle:$(TAG) --tag $(ORG)/odigos-index:$(TAG) --container-tool=docker

.PHONY: build-operator
build-operator:
$(MAKE) build-image/operator DOCKERFILE=operator/$(DOCKERFILE) SUMMARY="Odigos Operator" DESCRIPTION="Kubernetes Operator for Odigos installs Odigos" TAG=$(TAG) ORG=$(ORG) IMG_SUFFIX=$(IMG_SUFFIX)

.PHONY: build-odiglet
build-odiglet:
$(MAKE) build-image/odiglet DOCKERFILE=odiglet/$(DOCKERFILE) SUMMARY="Odiglet for Odigos" DESCRIPTION="Odiglet is the core component of Odigos managing auto-instrumentation. This container requires a root user to run and manage eBPF programs." TAG=$(TAG) ORG=$(ORG) IMG_SUFFIX=$(IMG_SUFFIX)
Expand Down Expand Up @@ -123,6 +131,10 @@ push-image/%:
--build-arg SUMMARY="$(SUMMARY)" \
--build-arg DESCRIPTION="$(DESCRIPTION)"

.PHONY: push-operator
push-operator:
$(MAKE) push-image/operator DOCKERFILE=operator/$(DOCKERFILE) SUMMARY="Odigos Operator" DESCRIPTION="Kubernetes Operator for Odigos installs Odigos" TAG=$(TAG) ORG=$(ORG) IMG_SUFFIX=$(IMG_SUFFIX)

.PHONY: push-odiglet
push-odiglet:
$(MAKE) push-image/odiglet DOCKERFILE=odiglet/$(DOCKERFILE) SUMMARY="Odiglet for Odigos" DESCRIPTION="Odiglet is the core component of Odigos managing auto-instrumentation." TAG=$(TAG) ORG=$(ORG) IMG_SUFFIX=$(IMG_SUFFIX)
Expand Down
3 changes: 3 additions & 0 deletions operator/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file
# Ignore build and test binaries.
bin/
27 changes: 27 additions & 0 deletions operator/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib
bin/*
Dockerfile.cross

# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Go workspace file
go.work

# Kubernetes Generated files - skip generated files, except for vendored files
!vendor/**/zz_generated.*

# editor and IDE paraphernalia
.idea
.vscode
*.swp
*.swo
*~
47 changes: 47 additions & 0 deletions operator/.golangci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
run:
timeout: 5m
allow-parallel-runners: true

issues:
# don't skip warning about doc comments
# don't exclude the default set of lint
exclude-use-default: false
# restore some of the defaults
# (fill in the rest as needed)
exclude-rules:
- path: "api/*"
linters:
- lll
- path: "internal/*"
linters:
- dupl
- lll
linters:
disable-all: true
enable:
- dupl
- errcheck
- exportloopref
- ginkgolinter
- goconst
- gocyclo
- gofmt
- goimports
- gosimple
- govet
- ineffassign
- lll
- misspell
- nakedret
- prealloc
- revive
- staticcheck
- typecheck
- unconvert
- unparam
- unused

linters-settings:
revive:
rules:
- name: comment-spacings
68 changes: 68 additions & 0 deletions operator/DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Development and testing

## Building the Operator image

From the root repo directory (ie `cd ..` from here), run:

```
make build-operator
```

You can build a test image by setting `ORG` and `TAG` build arguments, eg:

```
make build-operator ORG=mikeodigos TAG=dev
```

If you are on Mac and want to test this in an OpenShift cluster running on Linux, use the
`make push-operator` command instead (which uses `docker buildx` to cross-compile).

## Building the Operator Bundle

For OpenShift, we need an Operator Bundle which is an image consisting of the manifests
and metadata required to install the Operator.

From this directory, run:

```
make generate manifests bundle
```

You can set your dev image by passing the `IMG` build arg:

```
make bundle IMG=docker.io/mikeodigos/odigos-operator:dev
```

Note that the fully-qualified domain is required (`docker.io`). This will rewrite the manifests
with Kustomize to point to your docker image.

Next, build the Bundle Image:

```
make build-bundle
```

Again, you can point to your image by setting `IMAGE_TAG_BASE`:

```
make build-bundle IMAGE_TAG_BASE=mikeodigos/odigos-operator VERSION=dev
```

This will build a new docker image for the bundle containing all the generated manifests.

### Running in OpenShift

To test in an OpenShift cluster, push the operator image and bundle image to your registry.

Connect to the cluster with `oc login` and run:

```
operator-sdk run bundle <path to bundle image:tag>
```

Clean up with:

```
operator-sdk cleanup odigos-operator --delete-all
```
33 changes: 33 additions & 0 deletions operator/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Build the manager binary
FROM golang:1.23 AS builder
ARG TARGETOS
ARG TARGETARCH

WORKDIR /go/src/github.com/odigos-io/odigos
COPY api/ api/
COPY k8sutils/ k8sutils/
COPY cli/ cli/
COPY common/ common/
COPY profiles/ profiles/

WORKDIR /go/src/github.com/odigos-io/odigos/operator
COPY operator/ .
# 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

# Build
# the GOARCH has not a default value to allow the binary be built according to the host where the command
# was called. For example, if we call make docker-build in a local env which has the Apple Silicon M1 SO
# the docker BUILDPLATFORM arg will be linux/arm64 when for Apple x86 it will be linux/amd64. Therefore,
# by leaving it empty we can ensure that the container and binary shipped on it will have the same platform.
RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -tags=embed_manifests -a -o manager cmd/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 /go/src/github.com/odigos-io/odigos/operator/manager .
USER 65532:65532

ENTRYPOINT ["/manager"]
Loading

0 comments on commit 9930ffe

Please sign in to comment.