Burla
GitHub
  • Welcome
  • Overview
  • API-Reference
  • CLI-Reference
  • Installation
  • Architecture
  • Examples
  • About
  • Buy a brick. Get 10% off for life.
Powered by GitBook
On this page
  • CLI-Reference
  • burla login
  • burla install
PreviousAPI-ReferenceNextInstallation

Last updated 6 days ago

CLI-Reference

Burla CLI Reference

Description

Burla's CLI provides the ability to:

  • Authenticate using the command: burla login.

  • Install Burla in inside your Google Cloud project using the command: burla install

The global arg --help can be placed after any command or command group to see CLI documentation.


burla login

Ensures only authorized users can run commands on your cluster.

Description

Launches the "sign in with google" page in your default web browser. This gives our backend access to only your email and name according to your google account. See our to learn how we protect this information.

This is used to ensure that only emails you have authorized can run things on your cluster.

Once signed-in successfully, an auth-token is saved in the text file burla_credentials.json. This file is stored in your operating system's recommended user data directory which is determined using the python library.

This token is refreshed each time the burla login authorization flow is completed.

burla install

Currently, burla only be installed in Google Cloud.

Description

Installs burla inside the google cloud project that gcloud is currently pointing to.

To view your current project run: gcloud config get project To change your current project run: gcloud config set project <desired-project-id>

When run, burla install enables the following google cloud services:

  • Compute Engine

  • Cloud Run

  • Firestore

  • Cloud Resource Manager

In order to install burla you will need a Google Cloud account with user or admin level permission on all of these resources. If a permission is missing the error should tell you which permission you'll need.

After enabling, burla install runs three gcloud commands in the background that:

  • Open port 8080 to any VM's with the tag burla-cluster-node

  • Create a new firestore database called burla

Once installed, simply point your client at the new burla cluster by setting the enviroinment variable BURLA_API_URL to the URL of the cloud run service that was just deployed. The burla install command will print this URL as well a short quickstart when finished.


Deploys the latest image to google cloud run.

Questions? , or email jake@burla.dev. We're always happy to talk.

privacy-policy
appdirs
Burla-main-service
Schedule a call with us