Orb consists of two major components:
- The Control Plane—comprised of microservices, communication systems, databases, etc.—deploys to a central location (usually a cloud environment on Kubernetes).
- The Orb Agent—a lightweight observability agent—deploys to all the infrastructure you wish to monitor.
The instructions below are for installing the Control Plane. If you just need to install the Orb Agent (
orb-agent), see these instructions instead.
The Control Plane can be self-hosted, or you can use our free Orb SaaS service. Self-hosting gives you full privacy and control but is more complex. On the other hand, our SaaS gets you up and running quickly since you only need to create a free account on orb.live and then install the Orb Agent to your infrastructure.
The Orb SaaS platform (orb.live) is now in active development. This free-forever service allows you to enjoy the benefits of the Orb platform without having to run your own control plane.
If you need to install the Orb Agent to be used with orb.live, see these instructions.
The Orb SaaS service is still under active development and is not yet production ready. Please use it for non-production testing purposes only. The service may become unavailable, and your data may be reset without notice.
There are two main deployment methods for those wanting to self-host:
- Docker Compose - This option is useful for developer or testing installations, allowing you to run both the Orb Control Plane and the Orb Agent on a single machine.
- Helm Chart - This option is intended for production deployments, requiring access to a Kubernetes cluster.
Follow the instructions below after choosing a self-host option.
If you're just interested in trying out Orb quickly to see what it's all about, use the Docker Compose method.
Orb with Docker Compose¶
The Orb repo contains a full Docker Compose environment, useful both for developers wishing to contribute and casual users looking to try Orb for the first time.
Running Orb with Docker Compose requires you to have a copy of the Orb repo, although it is not necessary to build any software as the Compose file will download appropriate versions of the services from Docker Hub.
If you would like to build the software, or if you need to troubleshoot your environment, you can find more detailed instructions on setting up a development environment here.
git clone https://github.com/ns1labs/orb.git
This will pull Orb’s containers from Docker Hub and start all services. You may run
docker ps to confirm all services started successfully.
If you are running on your local machine, upon success the Orb UI will be available at https://localhost/
Orb Helm Chart¶
Helm is a package manager for Kubernetes. A Helm Chart is a package that allows you to customize your deployment on Kubernetes.
To configure and deploy an Orb Helm Chart, follow the instructions below.
This guide assumes installation into namespace
orb. It requires a HOSTNAME over which you have DNS control. It uses Let's Encrypt for TLS certification management.
cd to working directory
Add helm repos for dependencies.
helm repo add jaegertracing https://jaegertracing.github.io/helm-charts helm repo add bitnami https://charts.bitnami.com/bitnami helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx helm repo add jetstack https://charts.jetstack.io helm repo update helm dependency update
kubectl create namespace orb
Create JWT signing key secret.
kubectl create secret generic orb-auth-service --from-literal=jwtSecret=MY_SECRET -n orb
Create admin user secrets.
kubectl create secret generic orb-user-service --from-literal=adminEmailfirstname.lastname@example.org --from-literal=adminPassword=12345678 -n orb
Deploy ingres-nginx helm (to default namespace) with tcp config map configured from helm for 8883 (MQTTS). Note you need to reference both namespace and helm release name here.
helm install --set tcp.8883=orb/my-orb-nginx-internal:8883 ingress-nginx ingress-nginx/ingress-nginx
Wait for an external IP to be available.
kubectl --namespace default get services -o wide -w ingress-nginx-controller
Choose a HOSTNAME, then point an A record for this hostname to the external IP.
helm install cert-manager jetstack/cert-manager --namespace cert-manager --create-namespace --version v1.5.3 --set installCRDs=true
Create Issuer CRDs (in the
cp issuers/production-issuer-tpt.yaml issuers/production-issuer.yaml
spec.acme.emailto a real email address.
kubectl create -f issuers/production-issuer.yaml -n orb
Install Orb. Replace
my-orbwith your helm release name.
helm install --set ingress.hostname=HOSTNAME -n orb my-orb .
Upon successful installation, visit our Getting Started section to keep moving forward with Orb.