Skip to content

Latest commit

 

History

History
218 lines (154 loc) · 9.1 KB

README.md

File metadata and controls

218 lines (154 loc) · 9.1 KB
Raw

tb

tb is a CLI for running services and apps on a development machine.

It is aimed at making local development easy in a complicated microservices architecture by provisioning your machine with the dependencies you need and making it easy for you to run them on your machine in an environment that is close to how they run in production.

If you want to know more about why we built tb, check out our blog post.

Table of Contents

Requirements

Installed Software

The main requirement for using tb is having docker and docker compose v2 installed. See the Docker installation instructions and select your operating system for more details. See the Compose installation instructions to ensure you have Compose v2 installed.

If you are using macOS having the Xcode CLI tools is also required. These can be easily installed by running xcode-select --install.

It is also highly recommended to install lazydocker. This is a CLI UI that makes it easier to see the docker containers created by tb to run services. See the lazydocker installation instructions to install it.

SSH Key

tb uses ssh for certain git operations and assumes you have an ssh key connected to your GitHub account. If you do not have one, please create one by following the instructions here.

If your SSH key uses a passphrase, you need to ensure that it's loaded into ssh-agent before running tb. This can be done automatically using your MacOS keyring to automatically load the key to your shell with ssh-add -K $HOME/.ssh/id_rsa, which can be added to your shell configuration.

Installation

Homebrew (Recommended)

tb is available through TouchBistro's homebrew tap. If you do not have homebrew, you can install it by going to brew.sh

brew install touchbistro/tap/tb

Updating tb

To update to the latest version of tb do the following:

  1. Update homebrew: 
    brew update
  2. Upgrade tb: 
    brew upgrade tb

Quickstart

To see tb in action you can use the example tb-registry.

Add the registry:

tb registry add TouchBistro/tb-registry-example

Run the db playlist which contains postgres and redis:

tb up -p db

Basic Usage

By default tb contains no services on its own. Run tb list to confirm this. This will also generate a default ~/.tbrc.yml which will need to be edited. To add services to tb you will need to add a registry. A registry is a GitHub repo that contains a list of services, playlists, and apps tb can run. You can read the documentation on registries here.

Add a registry by editing ~/.tbrc.yml and add a registry to the registries: section:

registries:
  - name: org/registry-name

You can run a service or playlist by running tb up -s <service> or tb up -p <playlist>. tb will install any dependencies it needs and then start your services in docker containers.

tb up will start lazydocker. For more information about how to interact with it, check out its README. You can quit lazydocker, and containers will continue to run. You can always run lazydocker again without having to restart your services.

Try running tb --help or tb up --help to see what else you can do.

For more information about running services in tb see the services docs.

Running Apps

tb provides the ability to run iOS and desktop apps. For more information see the tb app docs.

Commands

tb comes with a lot of convenient commands. See the documentation here to learn more about the various features offered by tb.

Run tb --help to see the commands available. Run tb <cmd> --help to get help on a specific command.

tb also provides man pages which can be viewed by running man tb or man tb-<cmd> for a specific command.

Configuration

tb can be configured through the .tbrc.yml file located in your home directory. tb will automatically create a basic .tbrc.yml for you if one doesn't exist.

Timeout

You can specify a timeout value in .tbrc.yml. This value will be used to kill any operation that exceeds the given time. All you need to do is set timeoutSeconds: 1000 in your .tbrc.yml. Allowed values are 5 to 3600 inclusive. If timeoutSeconds is not specified or set to 0, tb will default to 3600 seconds (i.e 60 minutes).

Toggling experimental mode

To enable experimental mode set the experimental field to true. Experimental mode will give you access to any new features that are still in the process of being tested. Please be aware that you may encounter bugs with these features as they have not yet been deemed ready for general use. Also, experimental mode is not covered by semver guarantees, so there could be breaking changes at any time.

If you would like to help test new features, we would appreciate it if you could enable experimental mode and report any issues you encounter.

Adding custom playlists

You can create custom playlists by adding a new object to the playlists property.

Example:

playlists:
  my-playlist:
    extends: core
    services:
      - venue-admin-frontend
      - partners-config-service

Each playlist can extend another playlist though the use of the extends property. This will add all the services from the playlist being extended to this playlist.

The services in the playlist are specified in the services property.

Overriding service properties

You can override certain properties for services. To do this use the overrides property.

Example:

overrides:
  TouchBistro/tb-registry/mokta:
    mode: build
  TouchBistro/tb-registry/venue-admin-frontend:
    mode: remote
    remote:
      tag: <tag name>

Overrides must use the full service name, i.e. <registry>/<service>.

You can disable using the remote version by setting mode: build, which will cause an image to be built from the local repo instead of pulling an image from the remote registry.

You can also use a specific image tag by setting the remote.tag property.

Override schema:

<name>:
  envVars: map         # A list of env vars to set for the service, will be merged with exisiting env vars
  mode: remote | build # What mode to use: remote or build
  preRun: string       # Script to run before starting the service
  repo:
    path: string # Path to a local version of the Git repo. This will override the @REPOPATH built in variable in services.yml.
  build:               # Configuration when building the service locally
    command: string # Command to run when the container starts
    target: string  #
  remote:        # Configuration when pulling the service from a remote registry
    command: string  # Command to run when the container starts
    tag: string      # The image tag to use

Overriding Remote Tag using CLI

Additionally, you can run a docker image with a specific remote tag using the CLI. An example of doing so for a single service looks like this:

sso tb up my-service -t my_tag

Alternatively, you could also use the following syntax when running a single service:

sso tb up my-service -t my-service:my_tag

You can also override a remote tag when running a playlist. To override multiple remote tags for multiple services, you will need to provide a comma-separated list of service:tag arguments.

sso tb up -p my-playlist -t postgres:my_tag1,redis:my_tag2

Additionally, you can override multiple services' tags when a list of services:

sso tb up my-service my-service1 -t my-service:my_tag1,my-service:my_tag2

NOTE: If you specify a remote tag in your .tbrc.yml and supply a tag using the CLI, the CLI tag will always takes precedence over the .tbrc.yml override.

Contributing

See contributing for instructions on how to contribute to tb. PRs welcome!

License

MIT © TouchBistro, see LICENSE for details.