Skip to content
This repository has been archived by the owner on Apr 13, 2020. It is now read-only.

CatalystCode/spk

Repository files navigation

SPK

Build Status Azure DevOps coverage

spk 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)

spk diagram

Install

Download pre-compiled binaries of SPK on the release page.

CLI

$ spk
Usage: spk [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 spk 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.
  variable-group     Creates Variable Group in Azure DevOps project.

Prerequisites

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

  • git - at least version 2.22. Follow download instructions here

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

Getting Started

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

spk 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:

spk init -f spk-config.yaml

Guides

You will find several guides to help you get started on each of the areas at SPK guides.

CLI Command Reference

https://catalystcode.github.io/spk/commands/

Contributing

Contributing to spk.