microsoft / bedrock-cli

The CLI for Bedrock
https://microsoft.github.io/bedrock-cli/commands/
MIT License
28 stars 12 forks source link
azure-devops azure-kubernetes-service gitops kubernetes kubernetes-cluster kubernetes-deployment typescript

Bedrock CLI

Build Status Azure DevOps coverage

bedrock helps you automate, manage, and observe Kubernetes deployment operations based on Bedrock patterns and principles.

Key features:

  1. Builds event triggered GitOps pipelines (learn more)
  2. Provides tabular introspection of applications from Docker image build to multi-cluster deployment (learn more)
  3. Streamlines management of versioned Terraform environments (learn more)

bedrock diagram

Install

You can install bedrock via homebrew or with the pre-compiled binaries.

Homebrew

Version v0.6.6 and newer are available via homebrew.

Tap to the formulae repository:

$ brew tap microsoft/bedrock

Install bedrock:

$ brew install microsoft/bedrock/bedrock-cli

Run bedrock

$ bedrock

Pre-compile binaries

Download pre-compiled binaries of bedrock on the releases page.

CLI

$ bedrock
Usage: bedrock [options] [command]

The missing Bedrock CLI

Options:
  -v, --verbose      Enable verbose logging
  -V, --version      output the version number
  -h, --help         output usage information

Commands:
  init|i [options]   Initialize the bedrock tool for the first time.
  setup|s [options]  An interactive command to setup resources in azure and azure dev-ops
  deployment         Introspect your deployments
  hld                Commands for initalizing and managing a bedrock HLD repository.
  infra              Manage and modify your Bedrock infrastructure.
  project            Initialize and manage your Bedrock project.
  service            Create and manage services for a Bedrock project.

Prerequisites

To use bedrock, you must make sure you have the following tools installed:

Follow instructions to download and install the rest of the prerequisites here.

Getting Started

The fastest way to get started with bedrock is to following our interactive initialization.

bedrock init -i

This will guide you through the process of creating a configuration. Alternatively if you already have a configuration file you can run the command:

bedrock init -f bedrock-config.yaml

Guides

You will find several guides to help you get started on each of the CLI area here.

CLI Command Reference

https://microsoft.github.io/bedrock-cli/commands/

Contributing

Contributing to bedrock.