operator

README

formance-operator

This operator is in charge of deploying a full or partial Formance OSS Stack. It aims to simplify deployment and releases management of different parts of the Formance ecosystem.

Getting Started

You’ll need a Kubernetes cluster to run against. Scripts of this repository are using K3D. You have to install it. Also, we use Garden for management.

Running on the cluster

1. Create the cluster:

garden run workflow create-cluster

1. Deploy:

garden run workflow deploy

This will automatically install all the stack. When developing, use following command to update the operator code :

garden run workflow update

1. Create a stack

kubectl apply -f garden/example-v1beta2.yaml

Add an entry for host.k3d.internal inside /etc/hosts file, pointing to 127.0.0.1. Go to http://host.k3d.internal. Login with admin@formance.com / password

Tests

Run command :

make test

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster

Test It Out

You can install a full stack using the command:

kubectl apply -f example.yaml

License

Copyright 2022.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.