Skip to content

Commit

Permalink
fix: improve --host documentation (#43715)
Browse files Browse the repository at this point in the history
  • Loading branch information
colesnodgrass authored Aug 11, 2024
1 parent 0f4d0e3 commit 45a36a7
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions docs/using-airbyte/getting-started/oss-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,12 @@ If this command prints the installed version of the Airbyte Command Line Tool, i

Ensure that Docker Desktop is up and running. Then, with abctl installed, the following command gets Airbyte running:

:::tip
By default, `abctl` only configures an ingress rule for the host `localhost`. If you plan to access Airbyte outside of `localhost`, you will need to specify the `--host` flag to the `local install` command, providing the FQDN of the host which is hosting Airbyte. For example, `abctl local install --host airbyte.company.example`.

By specifying the `--host` flag, Airbyte will be accessible to both `localhost` and the FDQN passed to the `--host` flag.
:::

```
abctl local install
```
Expand Down Expand Up @@ -242,11 +248,6 @@ If you're using a version of Airbyte that you've installed with `abctl`, you can

This guide will assume that you are using the Amazon Linux distribution. However. any distribution that supports a docker engine should work with `abctl`. The launching and connecting to your EC2 Instance is outside the scope of this guide. You can find more information on how to launch and connect to EC2 Instances in the [Get started with Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html) documentation from Amazon.

:::tip
`abctl` runs by default on port 8000. You can change the port by passing the `--port` flag to the `local install` command. Make sure that the security group that you have configured for the EC2 Instance allows traffic in on the port that you deploy Airbyte on. See the [Control traffic to your AWS resources using security groups](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html) documentation for more information.
:::


1. Install the docker engine:

```shell
Expand Down Expand Up @@ -280,13 +281,28 @@ curl -LsfS https://get.airbyte.com | bash -
```

6. Run the `abctl` command and install Airbyte:
:::tip
By default, `abctl` only configures an ingress rule for the host `localhost`. In order to ensure that Airbyte can be accessed outside of the EC2 instance, you will need to specify the `--host` flag to the `local install` command, providing the FQDN of the host which is hosting Airbyte. For example, `abctl local install --host airbyte.company.example`.
:::
:::tip
By default, `abctl` will listen on port 8000. If port 8000 is already in used or you require a different port, you can specify this by passing the `--port` flag to the `local install` command. For example, `abctl local install --port 6598`

Ensure the security group configured for the EC2 Instance allows traffic in on the port (8000 by default, or whatever port was passed to `--port`) that you deploy Airbyte on. See the [Control traffic to your AWS resources using security groups](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html) documentation for more information.
:::

```shell
abctl local install
abctl local install --host [HOSTNAME]
```

### Editing the Ingress

:::note
The latest versions of `abctl` support a `--host` flag replacing the need to manually modify the ingress rules.

For example, if you are hosting Airbyte on the FDQN of `airbyte.company.example`, you would execute the following command:
`abctl local install --host airbyte.company.example`
:::

By default `abctl` will install and Nginx Ingress and set the host name to `localhost`. You will need to edit this to
match the host name that you have deployed Airbyte to. To do this you will need to have the `kubectl` command installed
on your EC2 Instance and available on your path.
Expand Down

0 comments on commit 45a36a7

Please sign in to comment.