hub

README

Hub CLI

Hub CLI is stack composition and lifecycle tool.

Example of usage

hub elaborate hub.yaml params.yaml -o hub.yaml.elaborate
hub deploy hub.yaml.elaborate -e NAME=stage
hub version
hub help

Installation

Pre-build binary

To download the latest release, run:

curl -LJ "https://github.com/agilestacks/hub/releases/latest/download/hub_$(uname -s)_$(uname -m).tar.gz" | tar xz -C /tmp
sudo mv /tmp/hub /usr/local/bin

There are macOS amd64, macOS arm64, Linux amd64, Linux arm64 and Windows x64 binaries.

Homebrew

brew tap agilestacks/tap
brew install agilestacks/tap/hub

Sorry for the name conflict with GitHub hub.

Extensions

Optionally, install extensions:

hub extensions install

Hub CLI Extensions requires: jq and yq v4. Optionally install Node.js and NPM for hub pull extension, AWS CLI, Azure CLI, [GCP SDK] kubectl, eksctl for hub ext eks extension.

macOS users

Depending on your's machine Security & Privacy settings and macOS version (10.15+), you may get an error cannot be opened because the developer cannot be verified. Please read on for a simple workaround:

xattr -d com.apple.quarantine hub.darwin_amd64

Alternatively, to set a global preference to Allow apps downloaded from: Anywhere, execute:

sudo spctl --master-disable

Development

Setup

Before make any changes you should configure git hooks for this repository

git config core.hooksPath .githooks

Build

Use make to build Hub CLI:

make

Or directly with go:

go build -o bin/$(go env GOOS)/hub github.com/agilestacks/hub/cmd/hub

Clean up

make clean

Usage metrics

When you use a pre-built binary from the releases page, it will send usage metrics to SuperHub and Datadog.

We value your privacy and only send anonymized usage metrics for the following commands:

• elaborate
• deploy
• undeploy
• backup create
• api *

A usage metric sample contains:

• Hub CLI command invoked without arguments, ie. 'deploy' or 'backup create', or 'api instance get'
• synthetic machine id - an UUID generated in first interactive session (stdout is a TTY)
• usage counter - 1 per invocation

Edit $HOME/.hub-cache.yaml to change settings:

    metrics:
      disabled: false
      host: 68af657e-6a51-4d4b-890c-4b548852724d

Set disabled: true to skip usage metrics reporting. Set host: "" to send the counter but not the UUID.

You could always review an up-to-date help via hub util metrics -h.

What's next?

Deploy App Stack or Machine Learning Stack on AWS EKS.

More information in the wiki.