Skip to main content

Install Beiboot Operator

Install Beiboot on the Host Cluster​

Please notice the following requirements:

  • You will need the appropriate permissions to apply all resources from this file in the cluster
  • The cluster must provide a Kubernetes API in version >=1.22

Standard​

If you don't run one of the managed Kubernetes service offerings, you can install Beiboot with these two options:

beibootctl install | kubectl apply -f -

or

kubectl apply -f https://raw.githubusercontent.com/Getdeck/beiboot/main/operator/manifests/beiboot.yaml

Installation on GKE​

Do you already have a GKE cluster running? Fine. Let's turn it into a Beiboot host cluster.

Prepare the cluster​

For the best experience make sure you have the GKE Cluster Autoscaler activated. That will ensure that each Beiboot cluster will get its capacity.

Important: In the Google cloud firewall you need to permit TCP and UDP traffic to the Kubernetes default node port range (30000-32768) of the host cluster.

Please run the following command

gcloud compute firewall-rules create <cluster-name> --allow tcp:30000-32768 --allow udp:30000-32768

or create this firewall rule using the GCP Console.

Install the Beiboot Operator​

You can install the Beiboot operator with this in your GKE cluster

beibootctl install --preset gke | kubectl apply -f -

(please mind that the beibootctl install command provides a lot of options for customizing the installation)

or

kubectl apply -f https://raw.githubusercontent.com/Getdeck/beiboot/main/operator/manifests/beiboot-gke.yaml

Installation on EKS​

Do you already have an EKS (public) cluster running? Fine. Let's turn it into a Beiboot host cluster.

Prepare the cluster​

For the best experience make sure you have the EKS Cluster Autoscaler activated. That will ensure that each Beiboot cluster will get its capacity.

Important: In the AWS firewall you need to permit TCP and UDP traffic to the Kubernetes default node port range (30000-32768) of the host cluster.

Install the Beiboot Operator​

You can install the Beiboot operator with the following command in your EKS cluster

beibootctl install | kubectl apply -f -

(please mind that the beibootctl install command provides a lot of options for customizing the installation)

or

kubectl apply -f https://raw.githubusercontent.com/Getdeck/beiboot/main/operator/manifests/beiboot.yaml