https://github.com/trendyol/cbef
GitOps Capability Provider for Couchbase Eventing Functions 🚀
https://github.com/trendyol/cbef
couchbase couchbase-eventing eventing eventing-functions gitops
Last synced: 9 months ago
JSON representation
GitOps Capability Provider for Couchbase Eventing Functions 🚀
- Host: GitHub
- URL: https://github.com/trendyol/cbef
- Owner: Trendyol
- License: bsd-3-clause
- Created: 2023-11-12T16:22:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-03T11:24:36.000Z (about 1 year ago)
- Last Synced: 2025-04-02T07:04:41.536Z (12 months ago)
- Topics: couchbase, couchbase-eventing, eventing, eventing-functions, gitops
- Language: Go
- Homepage: https://ty.gl/cbef
- Size: 1.07 MB
- Stars: 40
- Watchers: 8
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
## cbef (Couchbase Eventing Functions)
[](https://github.com/Trendyol/cbef/releases)
[](https://pkg.go.dev/github.com/Trendyol/cbef)
[](https://github.com/Trendyol/cbef/actions/workflows/tag-push.yml)
`cbef` is a simple, gitops capability provider for [Couchbase eventing functions](https://www.couchbase.com/products/eventing/).
## Table of Contents
- [Why?](#why)
- [Quickstart](#quickstart)
- [Local](#local)
- [Docker](#docker)
- [GitLab](#gitlab)
- [Function Configurations](#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](https://github.com/trendyol/cbef/releases) page.
Clone the `cbef` repository from the given GitHub URL
```bash
git clone https://github.com/trendyol/cbef
```
Change the current working directory to the `cbef` directory
```bash
cd cbef
```
Update function settings
```bash
nano ./examples/functions/basic.json
```
> Note: JavaScript eventing code file is found automatically.
Update function file
```bash
nano ./examples/functions/basic.js
```
> Note: If you need to example eventing functions code, click [here](https://docs.couchbase.com/server/current/eventing/eventing-examples.html) to read official Couchbase documentation.
Download dependencies
```bash
go mod tidy
```
Set the environment variable `CONFIG_FILE` to the path of the `basic.json` configuration file
```bash
export CONFIG_FILE=./examples/functions/basic.json
```
Set the environment variable `CI_COMMIT_AUTHOR` to the value `foo`, representing the author of the commit
```bash
export CI_COMMIT_AUTHOR=foo
```
Run the Go program located in the `cmd` directory
```bash
go run ./cmd
```
### Docker
Pull latest image
```bash
docker pull ghcr.io/trendyol/cbef:1.0.2-amd64
```
Run latest image
```bash
docker run --platform=linux/amd64 ghcr.io/trendyol/cbef:1.0.2-amd64
```
> Note: All images available in the [packages](https://github.com/Trendyol/cbef/pkgs/container/cbef) 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
| Field | Description | Value Type | Required | Options |
|------------------------------------------|--------------------------------------------------------------|:--------------:|:--------:|------------------------------------|
| cluster | Couchbase connection configurations | object | ✅ | |
| cluster.connection_string | Couchbase cluster connection string | string | ✅ | env supported with {{ENV}} |
| cluster.user | Username for cluster authentication | string | ✅ | env supported with {{ENV}} |
| cluster.pass | Password for cluster authentication | string | ✅ | env supported with {{ENV}} |
| name | Function name | string | ✅ | |
| metadata_keyspace | Metadata keyspace configurations | object | ✅ | |
| metadata_keyspace.bucket | Metadata bucket name | string | ✅ | |
| metadata_keyspace.scope | Metadata scope name | string | ✅ | |
| metadata_keyspace.collection | Metadata collection name | string | ✅ | |
| source_keyspace | Source keyspace configurations | object | ✅ | |
| source_keyspace.bucket | Source bucket name | string | ✅ | |
| source_keyspace.scope | Source scope name | string | ✅ | |
| source_keyspace.collection | Source collection name | string | ✅ | |
| bucket_bindings | Bucket bindings configurations | object array | ❌ | |
| bucket_bindings.alias | Alias for bucket binding | string | ❌ | |
| bucket_bindings.bucket | Target bucket name for binding | string | ❌ | |
| bucket_bindings.scope | Target scope name for binding | string | ❌ | |
| bucket_bindings.collection | Target collection name for binding | string | ❌ | |
| bucket_bindings.access | Access level for binding | string | ❌ | r (read-only), rw (read-write) |
| url_bindings | URL bindings configurations | object array | ❌ | |
| bucket_bindings.hostname | Hostname for URL binding | string | ❌ | |
| bucket_bindings.alias | Alias for URL binding | string | ❌ | |
| bucket_bindings.allow_cookies | Allow cookies for URL binding | bool | ❌ | |
| bucket_bindings.validate_ssl_certificate | Validate SSL certificate for URL binding | bool | ❌ | |
| bucket_bindings.auth | Authentication configurations for URL binding | object | ❌ | |
| bucket_bindings.auth.type | Authentication type for URL binding | string | ❌ | basic, digest, bearer |
| bucket_bindings.auth.user | Username for URL binding authentication | string | ❌ | |
| bucket_bindings.auth.pass | Password for URL binding authentication | string | ❌ | |
| bucket_bindings.auth.token | Token for URL binding authentication | string | ❌ | |
| constant_bindings | Constant bindings configurations | object array | ❌ | |
| constant_bindings.alias | Alias for constant binding | string | ❌ | |
| constant_bindings.literal | Literal value for constant binding | string | ❌ | |
| settings | Function configurations | object | ❌ | |
| settings.dcp_stream_boundary | The preferred deployment time feed boundary for the function | string | ❌ | everything, from_now |
| settings.description | Description for function | string | ❌ | |
| settings.log_level | Granularity of system events being captured in the log | string | ❌ | INFO, ERROR, WARNING, DEBUG, TRACE |
| settings.query_consistency | Consistency level of N1QL statements in the function | uint | ❌ | 1 (NotBounded), 2 (RequestPlus) |
| settings.worker_count | Number of workers per node to process the events | uint | ❌ | |
| settings.language_compatibility | Language compatibility of the function | string | ❌ | 6.0.0, 6.5.0, 6.6.2 |
| settings.execution_timeout | Time after which the function's execution will be timed out | uint (seconds) | ❌ | |
| settings.timer_context_size | Maximum allowed value of the timer context size in bytes | uint | ❌ | |