CLI Command Reference

hub

SuperHub is a lifecycle and stack composition tool Synopsis. Hub CLI is an interface to SuperHub. SuperHub is a lifecycle and stack composition tool: template and stack creation, stack lifecycle;. st…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api

Use remote Automation Hub API to access Control Plane Synopsis. Use remote Automation Hub API to access Control Plane Options. -h, --help help for api Options inherited from parent commands. --all-wa…

Rick Richardson
Updated 4 months ago by Rick Richardson

hub_api_application

Create and manage Applications Synopsis. Create and manage Applications Options. -h, --help help for application Options inherited from parent commands. --all-warnings Repeat all warnings before [suc…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_application_get

Show a list of applications or details about the application Synopsis. Show a list of all user accessible applications or details about the particular application (specify Id or search by full domain…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_cloudaccount

Create and manage Cloud Accounts Synopsis. Create and manage Cloud Accounts Options. -h, --help help for cloudaccount Options inherited from parent commands. --all-warnings Repeat all warnings before…

Rick Richardson
Updated 4 months ago by Rick Richardson

hub_api_environment

Create and manage Environments Synopsis. Create and manage Environments Options. -h, --help help for environment Options inherited from parent commands. --all-warnings Repeat all warnings before [suc…

Rick Richardson
Updated 4 months ago by Rick Richardson

hub_api_environment_get

Show a list of environments or details about the environment Synopsis. Show a list of all user accessible environments or details about the particular environment (specify Id or search by name) hub a…

Rick Richardson
Updated 4 months ago by Rick Richardson

hub_api_import

Import Kubernetes cluster Synopsis. Import Kubernetes cluster into Control Plane to become Platform Stack. Currently supported cluster types are: k8s-aws - AgileStacks Kubernetes on AWS (stack-k8s-aw…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_instance

Create and manage Stack Instances Synopsis. Create and manage Stack Instances Options. -h, --help help for instance Options inherited from parent commands. --all-warnings Repeat all warnings before […

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_instance_create

Create Stack Instance Synopsis. Create Stack Instance by sending JSON via stdin, for example: { “name”: “kubernetes”, “template”: “1”, “environment”: “2”, “tags”: [], “parameters”: [ { “name”: “dns.n…

Rick Richardson
Updated 4 months ago by Rick Richardson

hub_api_instance_delete

Delete Stack Instance by Id or full domain name Synopsis. Delete Stack Instance by Id or full domain name hub api instance delete <id | domain> [flags] Options. -h, --help help for delete Options inh…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_instance_deploy

Deploy Stack Instance by Id or full domain name Synopsis. Deploy Stack Instance by Id or full domain name hub api instance deploy <id | domain> [flags] Options. -h, --help help for deploy -w, --wait…

Rick Richardson
Updated 4 months ago by Rick Richardson

hub_api_instance_get

Show a list of instances or details about the instance Synopsis. Show a list of all user accessible stack instances or details about the particular instance (specify Id or search by full domain name)…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_instance_kubeconfig

Download Stack Instance Kubeconfig by Id or full domain name Synopsis. Download Stack Instance Kubeconfig by Id or full domain name hub api instance kubeconfig <id | domain> [flags] Options. -h, --he…

Rick Richardson
Updated 4 months ago by Rick Richardson

hub_api_instance_sync

Sync Stack Instance state from the state file Synopsis. Sync Stack Instance state from state file hub api instance sync <id | domain> [flags] Options. -h, --help help for sync -s, --state string Path…

Rick Richardson
Updated 4 months ago by Rick Richardson

hub_api_instance_undeploy

Undeploy Stack Instance by Id or full domain name Synopsis. Undeploy Stack Instance by Id or full domain name hub api instance undeploy <id | domain> [flags] Options. -h, --help help for undeploy -w,…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_secret

Create secret in Environment, Template, or Stack Instance Synopsis. To create Secret, provide: optionally, entity kind is one of: environment (default), stackTemplate, stackInstance. selector is eith…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_stack

List Base Stacks Synopsis. List Base Stacks Options. -h, --help help for stack Options inherited from parent commands. --all-warnings Repeat all warnings before [successful] exit (default true) --api…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_stack_get

Show a list of base stacks or details about the base stack Synopsis. Show a list of all base stacks or details about the particular base stack (specify Id) hub api stack get [id] [flags] Options. -h,…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_template

Create and manage Stack Templates Synopsis. Create and manage Stack Templates Options inherited from parent commands. --all-warnings Repeat all warnings before [successful] exit (default true) --api…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_template_create

Create Stack Template Synopsis. Create Stack Template by sending JSON via stdin, for example: { “name”: “EKS”, “description”: “EKS with Terraform”, “stack”: “eks:1”, “componentsEnabled”: [“stack-k8s-…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_template_delete

Delete Stack Template by Id Synopsis. Delete Stack Template by Id hub api template delete <id | name> [flags] Options. -h, --help help for delete Options inherited from parent commands. --all-warning…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_template_get

Show a list of templates or details about the template Synopsis. Show a list of all user accessible templates or details about the particular template (specify Id or search by name) hub api template…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_template_init

Initialize Stack Template by Id or name Synopsis. Initialize Stack Template by Id or name hub api template init <id | name> [flags] Options. -h, --help help for init Options inherited from parent com…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_backup

Create and manage backups Synopsis. Create backup of stack components; transform backup bundle into parameters manifest. Options. -h, --help help for backup Options inherited from parent commands. --…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_backup_create

Create backup bundle Synopsis. Create backup of stack component(s). Each stack component that supports ‘backup’ verb is invoked. Bundle can be saved into multiple files and also sent to S3. hub backu…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_backup_unbundle

Create parameters for restore from bundle Synopsis. Transform backup bundle(s) into parameters manifest. Multiple bundles will be merged with priority determined by file order on command-line (from l…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_doc

Generate Hub CLI reference in Markdown format Synopsis. Generate command reference and store files in hub doc <directory> [flags] Options. -h, --help help for doc Options inherited from parent comman…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_elaborate

Assemble hub.yaml.elaborate Synopsis. Assemble a complete Stack or Application deployment manifest by joining stack and components manifests. Parameters are injected from parameters manifest(s) and o…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_explain

Explain stack outputs, provides, and parameters evolution Synopsis. Display user-level stack outputs, history of parameters evolution during deployment, and component’s capabilities. Parameters histo…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_init

Init stack or component manifest Synopsis. Create stack or component manifest with initial values provided. Options. -h, --help help for init Options inherited from parent commands. --all-warnings Re…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_init_component

Init component manifest Synopsis. Create component manifest with initial values provided. hub init component [dir] [flags] Options. -h, --help help for component Options inherited from parent command…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_invoke

Invoke component’s verb (from another component) Synopsis. Invoke stack component’s verb from other component during lifecycle operation. hub invoke <component> <verb> [-e 'ADDITIONAL_ENV_VAR1=value,…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_login

Obtain login token for subsequent Hub API calls Synopsis. Sign-in to Hub API service to obtain a Login Token. The token is used to call API service to manage Secrets, print Environment or Stack Insta…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_pull

Pull stack sources Synopsis. Clone or update stack and component sources from Git. hub pull hub.yaml [-b <base directory>] [-f] [-r] [flags] Options. -b, --baseDir string Path to base directory to cl…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_render

Render component templates Synopsis. Render component templates with additional parameters during lifecycle operation. hub render <template glob>... [-a 'additional.parameter1=value,...'] [flags] Opt…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_undeploy

Undeploy stack Synopsis. Undeploy stack instance. hub undeploy hub.yaml.elaborate [flags] Options. -b, --base-dir string Path to component sources base directory (default to manifest dir) -c, --compo…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_init_stack

Init stack manifest Synopsis. Create stack manifest with initial values provided. hub init stack [dir] [flags] Options. -h, --help help for stack Options inherited from parent commands. --all-warning…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_deploy

Deploy stack Synopsis. Deploy stack instance by supplying a fully populated Hub Manifest. hub deploy hub.yaml.elaborate [flags] Options. -b, --base-dir string Path to component sources base directory…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_kubeconfig

Create ~/.kube/config from state file Synopsis. Create or update kubectl context with Kubernetes key files stored in state file. The context name is stack FQDN, ie. dns.domain. State files are separa…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_version

Print the version number of Hub CLI Synopsis. Print the version number of Hub CLI hub version [flags] Options. -h, --help help for version Options inherited from parent commands. --all-warnings Repea…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub.yaml

The hub.yaml is the manifest for a Stack template. It outlines the inventory of a Template, and the plan for deployment. It has several sections which merit some explanation. An example hub.yaml look…

Rick Richardson
Updated 3 months ago by Rick Richardson

hub_backup_unbundle

Create parameters for restore from bundle Synopsis. Transform backup bundle(s) into parameters manifest. Multiple bundles will be merged with priority determined by file order on command-line (from l…

Michael Delzer
Updated 4 months ago by Michael Delzer

Installing the Hub CLI Tool

TODO

Rick Richardson
Updated 3 months ago by Rick Richardson

hub_api_logs

Tail logs and status updates Synopsis. Tail deployment logs, lifecycle operation phases, and stack instance status changes. A list of Ids or domain names may be supplied to limit the output, otherwis…

Michael Delzer
Updated 4 months ago by Michael Delzer

hub_api_cloudaccount_get

Show a list of Cloud Accounts or details about the Cloud Account Synopsis. Show a list of all user accessible Cloud Accounts or details about the particular Cloud Account (specify Id or search by ful…

Rick Richardson
Updated 4 months ago by Rick Richardson

hub_api_instance

Create and manage Stack Instances Synopsis. Create and manage Stack Instances Options. -h, --help help for instance Options inherited from parent commands. --all-warnings Repeat all warnings before […

Michael Delzer
Updated 4 months ago by Michael Delzer

Contact