Initial commit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug Report
+about: Help us diagnose and fix bugs in this Function
+labels: bug
+---
+<!--
+Thank you for helping to improve Crossplane!
+
+Please be sure to search for open issues before raising a new one. We use issues
+for bug reports and feature requests. Please find us at https://slack.crossplane.io
+for questions, support, and discussion.
+-->
+
+### What happened?
+<!--
+Please let us know what behaviour you expected and how this Function diverged
+from that behaviour.
+-->
+
+
+### How can we reproduce it?
+<!--
+Help us to reproduce your bug as succinctly and precisely as possible. Artifacts
+such as example manifests or a script that triggers the issue are highly
+appreciated!
+-->
+
+### What environment did it happen in?
+Function version: 
+
+<!--
+Include at least the version or commit of Crossplane you were running. Consider
+also including your:
+
+* Cloud provider or hardware configuration
+* Kubernetes version (use `kubectl version`)
+* Kubernetes distribution (e.g. Tectonic, GKE, OpenShift)
+* OS (e.g. from /etc/os-release)
+* Kernel (e.g. `uname -a`)
+-->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature Request
+about: Help us make this Function more useful
+labels: enhancement
+---
+<!--
+Thank you for helping to improve Crossplane!
+
+Please be sure to search for open issues before raising a new one. We use issues
+for bug reports and feature requests. Please find us at https://slack.crossplane.io
+for questions, support, and discussion.
+-->
+
+### What problem are you facing?
+<!--
+Please tell us a little about your use case - it's okay if it's hypothetical!
+Leading with this context helps frame the feature request so we can ensure we
+implement it sensibly.
+--->
+
+### How could this Function help solve your problem?
+<!--
+Let us know how you think this Function could help with your use case. 
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+<!--
+Thank you for helping to improve Crossplane!
+
+Please read through https://git.io/fj2m9 if this is your first time opening a
+Crossplane pull request. Find us in https://slack.crossplane.io/messages/dev if
+you need any help contributing.
+-->
+
+### Description of your changes
+
+<!--
+Briefly describe what this pull request does, and how it is covered by tests.
+Be proactive - direct your reviewers' attention to anything that needs special
+consideration.
+
+You MUST either [x] check or ~strikethrough~ every item in the checklist below.
+
+We love pull requests that fix an open issue. If yours does, use the below line
+to indicate which issue it fixes, for example "Fixes #500".
+-->
+
+Fixes # 
+
+I have:
+
+- [ ] Read and followed Crossplane's [contribution process].
+- [ ] Added or updated unit tests for my change.
+
+[contribution process]: https://git.io/fj2m9
+[docs]: https://docs.crossplane.io/contribute/contribute

.github/workflows/ci.yml

@@ -0,0 +1,164 @@
+name: CI
+
+on:
+ push:
+ branches:
+ - main
+ - release-*
+ pull_request: {}
+ workflow_dispatch:
+ inputs:
+ version:
+ description: Package version (e.g. v0.1.0)
+ required: false
+
+env:
+ # Common versions
+ GO_VERSION: '1.21.3'
+ GOLANGCI_VERSION: 'v1.54.2'
+ DOCKER_BUILDX_VERSION: 'v0.11.2'
+
+ # These environment variables are important to the Crossplane CLI install.sh
+ # script. They determine what version it installs.
+ XP_CHANNEL: master # TODO(negz): Pin to stable once v1.14 is released.
+ XP_VERSION: current # TODO(negz): Pin to a version once v1.14 is released.
+
+ # This CI job will automatically push new builds to xpkg.upbound.io if the
+ # XPKG_ACCESS_ID and XPKG_TOKEN secrets are set in the GitHub respository (or
+ # organization) settings. Create a token at https://accounts.upbound.io.
+ XPKG_ACCESS_ID: ${{ secrets.XPKG_ACCESS_ID }}
+
+ # The package to push, without a version tag. The default matches GitHub. For
+ # example xpkg.upbound.io/crossplane/function-template-go.
+ XPKG: xpkg.upbound.io/${{ github.repository}}
+
+ # The package version to push. The default is 0.0.0-gitsha.
+ XPKG_VERSION: ${{ inputs.version }}
+
+jobs:
+ lint:
+ runs-on: ubuntu-22.04
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Setup Go
+ uses: actions/setup-go@v5
+ with:
+ go-version: ${{ env.GO_VERSION }}
+ cache: false # The golangci-lint action does its own caching.
+
+ - name: Lint
+ uses: golangci/golangci-lint-action@v3
+ with:
+ version: ${{ env.GOLANGCI_VERSION }}
+
+ unit-test:
+ runs-on: ubuntu-22.04
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Setup Go
+ uses: actions/setup-go@v5
+ with:
+ go-version: ${{ env.GO_VERSION }}
+
+ - name: Run Unit Tests
+ run: go test -v -cover ./...
+
+ # We want to build most packages for the amd64 and arm64 architectures. To
+ # speed this up we build single-platform packages in parallel. We then upload
+ # those packages to GitHub as a build artifact. The push job downloads those
+ # artifacts and pushes them as a single multi-platform package. 
+ build:
+ runs-on: ubuntu-22.04
+ strategy:
+ fail-fast: true
+ matrix:
+ arch:
+ - amd64
+ - arm64
+ steps:
+ - name: Setup QEMU
+ uses: docker/setup-qemu-action@v3
+ with:
+ platforms: all
+
+ - name: Setup Docker Buildx
+ uses: docker/setup-buildx-action@v3
+ with:
+ version: ${{ env.DOCKER_BUILDX_VERSION }}
+ install: true
+
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ # We ask Docker to use GitHub Action's native caching support to speed up
+ # the build, per https://docs.docker.com/build/cache/backends/gha/.
+ - name: Build Runtime
+ id: image
+ uses: docker/build-push-action@v5
+ with:
+ context: .
+ platforms: linux/${{ matrix.arch }}
+ cache-from: type=gha
+ cache-to: type=gha,mode=max
+ target: image
+ build-args:
+ GO_VERSION=${{ env.GO_VERSION }}
+ outputs: type=docker,dest=runtime-${{ matrix.arch }}.tar
+
+ - name: Setup the Crossplane CLI
+ run: "curl -sL https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh | sh"
+
+ - name: Build Package
+ run: ./crossplane xpkg build --package-file=${{ matrix.arch }}.xpkg --package-root=package/ --embed-runtime-image-tarball=runtime-${{ matrix.arch }}.tar
+
+ - name: Upload Single-Platform Package
+ uses: actions/upload-artifact@v4
+ with:
+ name: package-${{ matrix.arch }}
+ path: "*.xpkg"
+ if-no-files-found: error
+ retention-days: 1
+
+ # This job downloads the single-platform packages built by the build job, and
+ # pushes them as a multi-platform package. We only push the package it the
+ # XPKG_ACCESS_ID and XPKG_TOKEN secrets were provided.
+ push:
+ runs-on: ubuntu-22.04
+ needs:
+ - build
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Download Single-Platform Packages
+ uses: actions/download-artifact@v4
+ with:
+ path: .
+ merge-multiple: true
+
+ - name: Setup the Crossplane CLI
+ run: "curl -sL https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh | sh"
+
+ - name: Login to Upbound
+ uses: docker/login-action@v3
+ if: env.XPKG_ACCESS_ID != ''
+ with:
+ registry: xpkg.upbound.io
+ username: ${{ secrets.XPKG_ACCESS_ID }}
+ password: ${{ secrets.XPKG_TOKEN }}
+
+ # If a version wasn't explicitly passed as a workflow_dispatch input we
+ # default to version v0.0.0-<git-commit-date>-<git-short-sha>, for example
+ # v0.0.0-20231101115142-1091066df799. This is a simple implementation of
+ # Go's pseudo-versions: https://go.dev/ref/mod#pseudo-versions.
+ - name: Set Default Multi-Platform Package Version
+ if: env.XPKG_VERSION == ''
+ run: echo "XPKG_VERSION=v0.0.0-$(date -d@$(git show -s --format=%ct) +%Y%m%d%H%M%S)-$(git rev-parse --short=12 HEAD)" >> $GITHUB_ENV
+
+ - name: Push Multi-Platform Package to Upbound
+ if: env.XPKG_ACCESS_ID != ''
+ run: "./crossplane --verbose xpkg push --package-files $(echo *.xpkg|tr ' ' ,) ${{ env.XPKG }}:${{ env.XPKG_VERSION }}"

.gitignore

@@ -0,0 +1,21 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work

Dockerfile

@@ -0,0 +1,46 @@
+# syntax=docker/dockerfile:1
+
+# We use the latest Go 1.x version unless asked to use something else.
+# The GitHub Actions CI job sets this argument for a consistent Go version.
+ARG GO_VERSION=1
+
+# Setup the base environment. The BUILDPLATFORM is set automatically by Docker.
+# The --platform=${BUILDPLATFORM} flag tells Docker to build the function using
+# the OS and architecture of the host running the build, not the OS and
+# architecture that we're building the function for.
+FROM --platform=${BUILDPLATFORM} golang:${GO_VERSION} AS build
+
+WORKDIR /fn
+
+# Most functions don't want or need CGo support, so we disable it.
+ENV CGO_ENABLED=0
+
+# We run go mod download in a separate step so that we can cache its results.
+# This lets us avoid re-downloading modules if we don't need to. The type=target
+# mount tells Docker to mount the current directory read-only in the WORKDIR.
+# The type=cache mount tells Docker to cache the Go modules cache across builds.
+RUN --mount=target=. --mount=type=cache,target=/go/pkg/mod go mod download
+
+# The TARGETOS and TARGETARCH args are set by docker. We set GOOS and GOARCH to
+# these values to ask Go to compile a binary for these architectures. If
+# TARGETOS and TARGETOS are different from BUILDPLATFORM, Go will cross compile
+# for us (e.g. compile a linux/amd64 binary on a linux/arm64 build machine).
+ARG TARGETOS
+ARG TARGETARCH
+
+# Build the function binary. The type=target mount tells Docker to mount the
+# current directory read-only in the WORKDIR. The type=cache mount tells Docker
+# to cache the Go modules cache across builds.
+RUN --mount=target=. \
+ --mount=type=cache,target=/go/pkg/mod \
+ --mount=type=cache,target=/root/.cache/go-build \
+ GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -o /function .
+
+# Produce the Function image. We use a very lightweight 'distroless' image that
+# does not include any of the build tools used in previous stages.
+FROM gcr.io/distroless/base-debian11 AS image
+WORKDIR /
+COPY --from=build /function /function
+EXPOSE 9443
+USER nonroot:nonroot
+ENTRYPOINT ["/function"]