bastion-baas-cli
v0.1.5
Published
CLI app for deploying your bastion infrastructure
Downloads
16
Readme
Usage
$ npm install -g bastion-baas-cli
$ bastion <COMMAND>
running command...
$ bastion (-v|--version|version)
bastion-baas-cli/0.1.0 darwin-arm64 node-v16.13.0
$ bastion --help [COMMAND]
USAGE
$ bastion COMMAND
...
Prerequisites
- AWS Account
- AWS CLI configured with your AWS Account credentials
- Node and NPM installed on your local machine
Getting Started
- Make sure you have installed the AWS CLI and have given it your AWS credentials
- To install:
npm install -g bastion-baas-cli
- Run
bastion deploy
and give it a name and region when prompted. This will provision your initial AWS infrastructure so you can begin creating Bastion instances for your backend.
To integrate your frontend with Bastion backend:
Uninstall:
- To uninstall:
npm uninstall -g bastion-baas-cli
(does not remove your AWS infrastructure)
Commands
bastion deploy
bastion destroy
bastion help [COMMAND]
bastion config
bastion show
bastion deploy
Deploys the initial AWS infrastructure that your Bastion instances will run on. The name must be different from any other AWS infrastructure stack you have created. You will be prompted for the following information:
- Name to give to your Bastion infrastructure
- Default is
BastionInitial
- Default is
- The region you will be deploying your infrastructure to
- You will be given a list of AWS regions to choose from
- Default is
us-east-1
bastion deploy
can take up to 30 minutes to provision all of your infrastructure. To check the status of your stack, you can use bastion show
.
bastion destroy
Destroys all of the AWS infrastructure for the name of the stack you provided in bastion deploy
. It also removes the infrastructure related to that application in your local configuration file. To see where your configuration file lives, enter bastion config
.
Upon entering this command you will be prompted for the following information:
- The name of the AWS infrastructure stack you want to delete from a list of dropdown options
- A confirmation message asking if you are sure you want to delete your infrastructure
bastion destroy
can take a few minutes to fully complete.
If you use bastion destroy
before bastion deploy
has fully provisioned your infrastructure, it will still succeed in destroying your stack resources.
bastion help [COMMAND]
Displays help for Bastion CLI commands
USAGE
$ bastion help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
bastion config
Shows the location of your local configuration file. This file contains the names and AWS regions of your infrastructure stacks. The stack name specified on bastion destroy
removes the corresponding name/region combination from this file.
bastion show
Displays the status of a stack you have created with bastion deploy
. It tells you if your infrastructure is ready and if so, gives you a DNS name. You will be prompted for the name of the stack you would like to check the status of.