Skip to main content

Infrastructure

Cloud providers​

You can deploy the components for Breign to cloud providers, we can provide you with the official Breign container images, and you can use them to deploy the platform on your preferred cloud provider.

The recommended method is to deploy the platform using Kubernetes, which provides a scalable and resilient environment for running containerized applications. We provide Helm charts to simplify the deployment process on Kubernetes clusters. This method ensures you run the platform in a production-ready environment that is fully supported and well tested.

However, you can also deploy the platform using the primitives of your desired cloud provider. While we have tested the deployment with several cloud providers and their services, we cannot guarantee that all features will work as expected in every environment. We recommend testing the platform in a staging environment before deploying it to production.

Make sure to scale your deployment according to your needs, and monitor the performance of the platform to ensure it is running smoothly.

You can start with very small instances in order to test the platform and support a few users. The usual minimum requirements is 512MB of RAM and 1 CPU core for each component.

We recommend at least 1GB of RAM and 2 CPU cores for better performance for every components in production environments, especially if you expect a higher number of users or more intensive workloads. We support horizontal scaling, so you can add more instances of each component as needed to handle increased load using load balancers and auto-scaling features provided by your cloud provider.

Examples​

  • OVH:
    • We recommend the managed kubernetes service on public cloud to deploy the platform using our helm charts.
    • Deploying manually the containers on virtual machines is also possible, but it requires more setup and maintenance.
  • Azure:
    • You can use Kubernetes service to deploy the platform using our helm charts.
    • You can deploy on App Services (you can start with the base B1 plan of the instances) (linux-based instances using containers).
      • You will need to setup in addition:
        • a database instance (we support MongoDB or PostgreSQL. Azure DocumentDB with MongoDB Compatibility do work).
        • an Azure Blob Storage bucket.
        • a vector database with embedding capabilities (Weaviate).
        • an OpenID Connect provider for authentication (eg. Azure Entra, or you can use KeyCloak deployed on GKE).
  • Google Cloud Platform:
    • Either deploy using Kubernetes with GKE (we provide helm charts for that);
    • or for more simplicity, you can use Cloud Run to deploy all the containers.
      • Breign API
      • Breign App
      • Document API
    • You will need to setup in addition (unless you encapsulate them in your Kubernetes cluster):
      • a database instance (we support MongoDB or PostgreSQL)
      • a google storage bucket.
      • a vector database with embedding capabilities (Weaviate).
      • an OpenID Connect provider for authentication (eg. Google Identity Platform, or you can use KeyCloak deployed on GKE).

Custom servers/bare metal/on-premise​

For bare metal/on-premise deployments, you can deploy the platform using Kubernetes, depending on your preference and infrastructure capabilities. We provide Helm charts to simplify the deployment process.

You may still deploy manually each components using our components images, but it requires more setup and maintenance, and we recommend using Kubernetes for better scalability and resilience.

SaaS / Hosted Platform​

For testing purposes and some use-cases, our platform is accessible as a SaaS. In such cases, dedicated terms and condition apply.