Skip to content

feat: k8s compatibility #317

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.

Sign up for GitHub

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

Draft
v-rocheleau wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: k8s compatibility #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,7 @@ etc/tests/*/*/*/__pycache__
etc/tests/*/geckodriver
etc/tests/*/geckodriver.log
geckodriver.log

# resolved k8s kompose resources
k8s/kompose
k8s/resolved-compose.yaml
45 changes: 45 additions & 0 deletions k8s/k8s-gen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Bento Kubernetes resources

Currently, Bento uses Docker Compose for development and deployment.

Kubernetes (k8s) is a container orchestration system, which enables better deployment automation and scaling.

As we are porting Bento for k8s, our goal is **NOT** to completely replace Docker Compose with k8s resources.

Compose is already tightly integrated with `bentoctl`, and it offers us a simple and reliable development environment.

The goal of this work is to keep using Docker Compose as the source of truth for defining a Bento stack, and to have a mechanism
that allows us to translate Docker Compose stacks into k8s resources for production deployments.

To achieve this, we will be using the [Kompose](https://kompose.io/) CLI tool, which is officialy supported and developed
by the Kubernetes project for this use-case.

## Converting Bento Compose files to Kubernets

WIP: simple proof of concept usage of Kompose for Bento

```bash
# Generate a resolved Docker Compose config file with bentoctl
./bentoctl.bash compose-config >> k8s/resolved-compose.yaml

# Convert the compose config to k8s resources using Kompose
mkdir k8s/kompose
kompose -f k8s/resolved-compose.yaml convert -o k8s/kompose

# Deploy the resources to a k8s cluster
kubectl apply -f k8s/kompose
```

## Kompose labels

Per Kompose's docs on [labels](https://kompose.io/user-guide/#labels):
> `kompose` supports Kompose-specific labels within the `compose.yaml` file to get you the rest of the way there.
>
> Labels are an important kompose concept as they allow you to add Kubernetes modifications without having to edit the YAML afterwards.
>
> For example, adding an init container, or a custom readiness check.

To bridge the gap between k8s and Docker Kompose, we will need to include various Kompose labels in our compose files.

These labels will only take effect when converting using Kompose.