Overview
Getting Started Architecture Concepts
Usage
Configuration CLI
Apps
ecommerce
Plugins
Kubernetes
gke kind minikube
Observability
elastic-cloud grafana-cloud
Alerts
slack
Development
Apps Plugins Versioning Contributing

CLI

Commands

See also: Global options

setup

Usage: microbs setup [OPTIONS]

Creates all or part of the microbs environment as configured in the deployment.app and deployment.plugins* configuration fields.

If you specify the --app, --k8s, --obs, or --alerts command flags, then microbs will only attempt to setup those specified components. Otherwise, microbs will attempt to setup all components. If microbs finds that a component has already been setup, then microbs will avoid duplicating its setup.

microbs attempts to setup components in a specific order to account for their dependencies, regardless of the order you specify in the command. That order is:

  1. Alerts plugin (configured in deployment.plugins.alerts)
  2. Kubernetes plugin (configured in deployment.plugins.kubernetes)
  3. Observability plugin (configured in deployment.plugins.observability)
  4. Application (configured in deployment.app)

Optional command flags

Short Long Description
-a --app Rollout the application to Kubernetes
-k --k8s Run the setup() command of the Kubernetes plugin
-o --obs Run the setup() command of the observability plugin
-l --alerts Run the setup() command of the alerts plugin

rollout

Usage: microbs rollout [VARIANT_NAME] [OPTIONS]

Rolls out a variant (VARIANT_NAME) of the application deployed to Kubernetes. If no variant name is given, then the default main profile of the application is rolled out to Kubernetes, which is the same thing as deploying the application via setup.

stabilize

Usage: microbs stabilize [OPTIONS]

An alias for microbs rollout main [OPTIONS]. Returns a deployed application to its main profile.

destroy

Usage: microbs destroy [OPTIONS]

Destroys all or part of the microbs environment as configured in the deployment.app and deployment.plugins* configuration fields.

If you specify the --app, --k8s, --obs, or --alerts command flags, then microbs will only attempt to destroy those specified components. Otherwise, microbs will attempt to destroy all components.

microbs attempts to destroy components in a specific order to account for their dependencies, regardless of the order you specify in the command. That order is:

  1. Application (configured in deployment.app)
  2. Alerts plugin (configured in deployment.plugins.alerts)
  3. Observability plugin (configured in deployment.plugins.observability)
  4. Kubernetes plugin (configured in deployment.plugins.kubernetes)

Optional command flags

Short Long Description
-a --app Remove the application from Kubernetes
-k --k8s Run the destroy() command of the Kubernetes plugin
-o --obs Run the destroy() command of the observability plugin
-l --alerts Run the destroy() command of the alerts plugin

validate

Usage: microbs validate [OPTIONS]

Validates the installation and configuration of microbs, and reports the status of each validation check. Offers guidance where possible.

The scope of the validate command includes:

  • Software dependency installation
  • Software dependency versions
  • Config file existence
  • Config file syntax
  • Config file values

plugins

Manages microbs plugins

Usages:

  • microbs plugins list
  • microbs plugins search
  • microbs plugins install PLUGIN_NAME [...] [OPTIONS]
  • microbs plugins update PLUGIN_NAME [...] [OPTIONS]
  • microbs plugins uninstall PLUGIN_NAME [...] [OPTIONS]

plugins.list

microbs plugins list displays the plugins installed on the same machine as the microbs CLI.

plugins.search

microbs plugins search searches for official microbs plugins on the npm registry. The names of official plugins packages are prefixed with @microbs.io/plugin-.

plugins.install

microbs plugins install PLUGIN_NAME [...] installs one or more plugins by name from the npm registry. microbs automatically prefixes the plugin package name with @microbs.io/plugin-, thus if you wanted to install the gke plugin, you would only need to run microbs plugin install gke and not @microbs.io/plugin-gke. Plugins are installed under the node_modules directory of the microbs CLI.

Optional command flags

Short Long Description
--all Install all official microbs plugins from the npm registry.

plugins.update

microbs plugins update PLUGIN_NAME [...] updates one or more installed plugins by name.

Optional command flags

Short Long Description
--all Update all installed microbs plugins.

plugins.uninstall

microbs plugins uninstall PLUGIN_NAME [...] removes one or more installed plugins by name.

Optional command flags

Short Long Description
--all Uninstall all installed microbs plugins.

apps

Manages microbs apps

Usages:

  • microbs apps list
  • microbs apps search
  • microbs apps install APP_NAME [...] [OPTIONS]
  • microbs apps update APP_NAME [...] [OPTIONS]
  • microbs apps uninstall APP_NAME [...] [OPTIONS]

apps.list

microbs apps list displays the apps installed on the same machine as the microbs CLI.

apps.search

microbs apps search searches for official microbs apps on the npm registry. The names of official apps packages are prefixed with @microbs.io/app-.

apps.install

microbs apps install APP_NAME [...] installs one or more apps by name from the npm registry. microbs automatically prefixes the app package name with @microbs.io/app-, thus if you wanted to install the ecommerce app, you would only need to run microbs apps install ecommerce and not @microbs.io/app-ecommerce. Apps are installed under the node_modules directory of the microbs CLI.

Optional command flags

Short Long Description
--all Install all official microbs apps from the npm registry.

apps.update

microbs apps update APP_NAME [...] updates one or more installed apps by name.

Optional command flags

Short Long Description
--all Update all installed microbs apps.

apps.uninstall

microbs apps uninstall APP_NAME [...] removes one or more installed apps by name.

Optional command flags

Short Long Description
--all Uninstall all installed microbs apps.

init

Usage: microbs init [OPTIONS]

Creates $HOME/.microbs and $HOME/.microbs/config.yaml if they do not exist. The config.yaml file is given some default values but will require some fields to be provided manually.

Optional command flags

Short Long Description
-c --config Path to config directory (default: $HOME/.microbs)

version

Usage: microbs version

Displays the version of microbs.

help

Usage: microbs help [OPTIONS]

Displays a concise explanation of commands and options available to the CLI.

Global options

These options can be used for all commands.

Short Long Description
-c --config Path to config directory (default: $HOME/.microbs)
-L --log-level Filter logs by: debug, info, warn, error (default: info)
--no-color Disable colors in log messages
-v --verbose Include timestamps and log levels in logs
© 2022 Dave Moore.
Licensed under the Apache License, Version 2.0.
This website uses Google Analytics.
microbs is a project of the open source community. microbs is not officially supported by any vendors named in this documentation or the software (e.g. Cloud Native Computing Foundation, Amazon, Google, Microsoft, Elastic, Grafana), though employees or partners of those vendors may contribute to the project.