Skip to content

Commit

Permalink
docs(basti): document new --bastion-assign-public-ip option
Browse files Browse the repository at this point in the history
  • Loading branch information
BohdanPetryshyn committed Sep 27, 2024
1 parent 47496c6 commit d2fb20b
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 5 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
<br/>

<!-- The following toc is generated with the Markdown All in One VSCode extension (https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) -->
<!-- omit from toc -->

<!-- omit from toc -->
## Table of contents

- [💡 Why Basti?](#-why-basti)
Expand All @@ -47,6 +47,7 @@
- [🎛️ Advanced initialization options](#️-advanced-initialization-options)
- [Resource tags](#resource-tags)
- [Bastion instance type](#bastion-instance-type)
- [Assign public IP address](#assign-public-ip-address)
- [🦾 Automatic mode](#-automatic-mode)
- [📝 Configuration file](#-configuration-file)
- [💫 Infrastructure as code (IaC)](#-infrastructure-as-code-iac)
Expand Down
13 changes: 10 additions & 3 deletions docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ Basti CLI is a command line tool that allows you to connect to your private AWS

<!-- omit from toc -->
## Table of contents

- [Commands](#commands)
- [basti init](#basti-init)
- [basti connect](#basti-connect)
- [basti cleanup](#basti-cleanup)


## Commands

### basti init<span id="basti-init-command"></span>
Expand Down Expand Up @@ -67,6 +67,13 @@ _String_, _Default: "t2.micro"_

The EC2 instance type to be used for the bastion instance.

<!-- omit from toc -->
#### `--bastion-assign-public-ip <true|false>`

_Boolean_, _Default: true_

Whether to assign a public IP address to the bastion instance.

<!-- omit from toc -->
#### `--tag <tag-name>=<tag-value>`

Expand Down Expand Up @@ -119,7 +126,7 @@ Starts a port forwarding session to the connection target. The connection target
If used without arguments, the interactive mode will prompt you for all the required options. Alternatively, you can pass all the required options as command line arguments or specify a `connection` defined in the [Basti configuration file](./configuration-file.md).

<!-- omit from toc -->
#### `connection`
#### `connection`

_String_

Expand Down Expand Up @@ -219,7 +226,7 @@ The name of the AWS region to be used to interact with AWS. If not specified, th
basti cleanup
```

Removes all the resources created by Basti in your AWS account. The list of resources will be displayed and you will be prompted to confirm the cleanup.
Removes all the resources created by Basti in your AWS account. The list of resources will be displayed and you will be prompted to confirm the cleanup.

<!-- omit from toc -->
#### `--confirm`
Expand Down
3 changes: 2 additions & 1 deletion packages/basti/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
<br/>

<!-- The following toc is generated with the Markdown All in One VSCode extension (https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) -->
<!-- omit from toc -->

<!-- omit from toc -->
## Table of contents

- [💡 Why Basti?](#-why-basti)
Expand All @@ -53,6 +53,7 @@
- [🎛️ Advanced initialization options](#️-advanced-initialization-options)
- [Resource tags](#resource-tags)
- [Bastion instance type](#bastion-instance-type)
- [Assign public IP address](#assign-public-ip-address)
- [🦾 Automatic mode](#-automatic-mode)
- [📝 Configuration file](#-configuration-file)
- [💫 Infrastructure as code (IaC)](#-infrastructure-as-code-iac)
Expand Down

0 comments on commit d2fb20b

Please sign in to comment.