You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/using-airbyte/getting-started/oss-quickstart.md
+22-6
Original file line number
Diff line number
Diff line change
@@ -156,6 +156,12 @@ If this command prints the installed version of the Airbyte Command Line Tool, i
156
156
157
157
Ensure that Docker Desktop is up and running. Then, with abctl installed, the following command gets Airbyte running:
158
158
159
+
:::tip
160
+
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`.
161
+
162
+
By specifying the `--host` flag, Airbyte will be accessible to both `localhost` and the FDQN passed to the `--host` flag.
163
+
:::
164
+
159
165
```
160
166
abctl local install
161
167
```
@@ -242,11 +248,6 @@ If you're using a version of Airbyte that you've installed with `abctl`, you can
242
248
243
249
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.
244
250
245
-
:::tip
246
-
`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.
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`.
286
+
:::
287
+
:::tip
288
+
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`
289
+
290
+
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.
291
+
:::
283
292
284
293
```shell
285
-
abctl local install
294
+
abctl local install --host [HOSTNAME]
286
295
```
287
296
288
297
### Editing the Ingress
289
298
299
+
:::note
300
+
The latest versions of `abctl` support a `--host` flag replacing the need to manually modify the ingress rules.
301
+
302
+
For example, if you are hosting Airbyte on the FDQN of `airbyte.company.example`, you would execute the following command:
303
+
`abctl local install --host airbyte.company.example`
304
+
:::
305
+
290
306
By default `abctl` will install and Nginx Ingress and set the host name to `localhost`. You will need to edit this to
291
307
match the host name that you have deployed Airbyte to. To do this you will need to have the `kubectl` command installed
0 commit comments