Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Bootstrap code with kubebuilder and set up initial CRDs #2

Merged
merged 7 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .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/
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,7 @@ go.work.sum

# env file
.env

# Downloaded and built binaries
bin/
tools
47 changes: 47 additions & 0 deletions .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
96 changes: 96 additions & 0 deletions .prow.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
presubmits:
- name: pull-kcp-operator-verify
always_run: true
decorate: true
clone_uri: "https://github.com/kcp-dev/kcp-operator"
labels:
preset-goproxy: "true"
spec:
containers:
- image: ghcr.io/kcp-dev/infra/build:1.22.7-1
command:
- make
- verify
resources:
requests:
memory: 1Gi
cpu: 1

- name: pull-kcp-operator-lint
always_run: true
decorate: true
clone_uri: "https://github.com/kcp-dev/kcp-operator"
labels:
preset-goproxy: "true"
spec:
containers:
- image: ghcr.io/kcp-dev/infra/build:1.22.7-1
command:
- make
- lint
resources:
requests:
memory: 4Gi
cpu: 2

- name: pull-kcp-operator-build-image
always_run: true
decorate: true
clone_uri: "https://github.com/kcp-dev/kcp-operator"
labels:
preset-goproxy: "true"
spec:
containers:
- image: quay.io/containers/buildah:v1.30.0
command:
- hack/ci/build-image.sh
env:
- name: DRY_RUN
value: '1'
# docker-in-docker needs privileged mode
securityContext:
privileged: true
resources:
requests:
memory: 1Gi
cpu: 1

- name: pull-kcp-operator-test
always_run: true
decorate: true
clone_uri: "https://github.com/kcp-dev/kcp-operator"
labels:
preset-goproxy: "true"
spec:
containers:
- image: ghcr.io/kcp-dev/infra/build:1.22.7-1
command:
- make
- test
env:
- name: USE_GOTESTSUM
value: '1'
resources:
requests:
memory: 4Gi
cpu: 2

- name: pull-kcp-operator-test-e2e
always_run: false
decorate: true
clone_uri: "https://github.com/kcp-dev/kcp-operator"
labels:
preset-goproxy: "true"
spec:
containers:
- image: ghcr.io/kcp-dev/infra/build:1.22.7-1
command:
- make
- test-e2e
env:
- name: USE_GOTESTSUM
value: '1'
resources:
requests:
memory: 4Gi
cpu: 2
16 changes: 16 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Development

## kubebuilder

For historic documentation, this project has been generated with [kubebuilder](https://book.kubebuilder.io/) with the following version information:

```sh
$ kubebuilder version
Version: main.version{KubeBuilderVersion:"4.3.1", KubernetesVendor:"unknown", GitCommit:"a9ee3909f7686902879bd666b92deec4718d92c9", BuildDate:"2024-11-09T09:58:43Z", GoOs:"darwin", GoArch:"arm64"}
```

The project has been initialised with:

```sh
$ kubebuilder init --domain operator.kcp.io --owner "The KCP Authors" --project-name kcp-operator
```
33 changes: 33 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Build the manager binary
FROM --platform=${BUILDPLATFORM} docker.io/golang:1.22.9 AS builder
ARG TARGETOS
ARG TARGETARCH

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 cmd/main.go cmd/main.go
COPY api/ api/
COPY internal/controller/ internal/controller/

# 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 -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 /workspace/manager .
USER 65532:65532

ENTRYPOINT ["/manager"]
Loading