Cbef Save

cbef (Couchbase Eventing Functions)

cbef is a simple, gitops capability provider for Couchbase eventing functions.

Table of Contents

• Why?
• Quickstart
  • Local
  • Docker
  • GitLab
• Function Configurations

Why?

In production projects where code reliability is a key consideration, it is essential to control and review the implemented processes using Git.

cbef facilitates GitOps support for the operations performed within eventing functions.

Moreover, to ensure the seamless functionality of eventing functions before deploying to the live environment, testing support is provided. This testing ensures that the functions operate as expected, offering confidence in their reliability.

In contrast to operations carried out through the UI, transitioning to a new function version is designed to be zero-downtime, allowing for rapid rollback if needed. The inclusion of revision history support further enhances the ability to track and manage changes effectively.

Quickstart

Local

Note: Precompiled cbef for all arch types is available in the releases page.

Clone the cbef repository from the given GitHub URL

git clone https://github.com/trendyol/cbef

Change the current working directory to the cbef directory

cd cbef

Update function settings

nano ./examples/functions/basic.json

Note: JavaScript eventing code file is found automatically.

Update function file

nano ./examples/functions/basic.js

Note: If you need to example eventing functions code, click here to read official Couchbase documentation.

Download dependencies

go mod tidy

Set the environment variable CONFIG_FILE to the path of the basic.json configuration file

export CONFIG_FILE=./examples/functions/basic.json

Set the environment variable CI_COMMIT_AUTHOR to the value foo, representing the author of the commit

export CI_COMMIT_AUTHOR=foo

Run the Go program located in the cmd directory

go run ./cmd

Docker

Pull latest image

docker pull ghcr.io/trendyol/cbef:1.0.2-amd64

Run latest image

docker run --platform=linux/amd64 ghcr.io/trendyol/cbef:1.0.2-amd64

Note: All images available in the packages page.

GitLab

Just open a new repository and copy the examples folder.

The structure in examples/.gitlab-ci.yml will help you deploy your eventing function.

Also, you can store cluster connection secrets as masked and protected in ci/cd variables.

Function Configurations

Configurations that can be used in files with .json extension located in the functions folder