Skip to content

Commit 0d45fc2

Browse files
authored
docs: add a section on resource usage and running over http to the quickstart. (#44190)
1 parent 383f0b1 commit 0d45fc2

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

docs/using-airbyte/getting-started/oss-quickstart.md

+19-16
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,18 @@ As long as your Docker Desktop daemon is running in the background, you can use
194194

195195
If you quit Docker Desktop and want to return to your local Airbyte workspace, just start Docker Desktop again. Once Docker finishes restarting, you'll be able to access Airbyte's local installation as normal.
196196

197+
198+
### Suggested Resources
199+
200+
For the best performance, we suggest you run on a machine with 4 or more CPU's and at least 8 GB of memory. Currently
201+
`abctl` does support running on 2 cpus and 8 gb of ram with the `--low-resource-mode` flag. You can pass the low
202+
resource mode flag when install Airbyte with `abctl`:
203+
204+
```shell
205+
abctl local install --low-resource-mode
206+
```
207+
208+
197209
## 3: Move Data
198210

199211
In the Building Connections section, you'll learn how to start moving data. Generally, there are three steps:
@@ -294,24 +306,15 @@ Ensure the security group configured for the EC2 Instance allows traffic in on t
294306
abctl local install --host [HOSTNAME]
295307
```
296308

297-
### Editing the Ingress
309+
### Running over HTTP
298310

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-
306-
By default `abctl` will install and Nginx Ingress and set the host name to `localhost`. You will need to edit this to
307-
match the host name that you have deployed Airbyte to. To do this you will need to have the `kubectl` command installed
308-
on your EC2 Instance and available on your path.
311+
Airbyte suggest that you secure your instance of Airbyte using TLS. Running over plain HTTP allows attackers to see your
312+
password over clear text. If you understand the risk and would still like to run Airbyte over HTTP, you must set
313+
Secure Cookies to false. You can do this with `abctl` by passing the `--insecure-cookies` flag to `abctl`:
309314

310-
If you do not already have the CLI tool kubectl installed, please [follow these instructions to install](https://kubernetes.io/docs/tasks/tools/).
311-
312-
Then you can run `kubectl edit ingress -n airbyte-abctl --kubeconfig ~/.airbyte/abctl/abctl.kubeconfig` and edit the `host`
313-
key under the spec.rules section of the Ingress definition. The host should match the FQDN name that you are trying to
314-
host Airbyte at, for example: `airbyte.company.example`.
315+
```shell
316+
abctl local install --host [HOSTNAME] --insecure-cookies
317+
```
315318

316319
## Uninstalling
317320

0 commit comments

Comments
 (0)