34282926a1
## What Generates version 2.0 of the Airbyte platform documentation using Docusaurus's built-in versioning system. This creates a frozen snapshot of the current documentation that users can reference. Requested by ian.alton@airbyte.io via [Slack thread](https://airbytehq-team.slack.com/archives/D08FX8EC9L0/p1760490197805979?thread_ts=1760490197.805979). Link to Devin run: https://app.devin.ai/sessions/689693593bac44f4903f476aa17b872e ## How - Ran `pnpm run docusaurus docs:version:platform 2.0` in the docusaurus directory - This automatically: - Created `platform_versioned_docs/version-2.0/` containing a snapshot of all current platform docs - Created `platform_versioned_sidebars/version-2.0-sidebars.json` with the sidebar navigation structure - Updated `platform_versions.json` to add "2.0" to the version list - Ran prettier to format the JSON files - Verified the documentation builds successfully locally (build completed in ~3 minutes with only pre-existing broken anchor warnings) ## Review guide 1. **Verify timing**: Confirm this is the correct time to release version 2.0 of the documentation 2. **Version order**: Check `docusaurus/platform_versions.json` - verify "2.0" is first in the array (newest version first) 3. **Build verification**: Ensure CI/Vercel builds pass without errors 4. **Spot check**: Optionally review 2-3 files in `docusaurus/platform_versioned_docs/version-2.0/` to ensure content looks reasonable Note: This is a standard Docusaurus versioning operation that creates a frozen snapshot of the current "next" documentation. The generated files are extensive (500+ files) but follow Docusaurus conventions. ## User Impact Users will see version 2.0 available in the version dropdown on docs.airbyte.com. This provides a stable reference point for platform documentation at this point in time. Existing versions (1.6, 1.7, 1.8) remain unchanged. ## Can this PR be safely reverted and rolled back? - [x] YES 💚 This is an additive change that doesn't modify existing versioned docs. Reverting would simply remove version 2.0 from the version list and delete the associated documentation files. Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
2.7 KiB
products
| products |
|---|
| oss-community |
Using an EC2 Instance with abctl
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 documentation from Amazon.
- Install the docker engine:
sudo yum install -y docker
- Add the ec2-user (or whatever your distros default user) to the docker group:
sudo usermod -a -G docker ec2-user
- Start and optionally enable (start on boot) the docker engine:
sudo systemctl start docker
sudo systemctl enable docker
- Exit the shell and reconnect to the ec2 instance, an example would look like:
exit
ssh -i ec2-user-key.pem ec2-user@1.2.3.4
- Download the latest version of abctl and install it in your path:
curl -LsfS https://get.airbyte.com | bash -
- Run the
abctlcommand and install Airbyte: :::tip By default,abctlonly configures an ingress rule for the hostlocalhost. In order to ensure that Airbyte can be accessed outside of the EC2 instance, you will need to specify the--hostflag to thelocal installcommand, providing the FQDN of the host which is hosting Airbyte. For example,abctl local install --host airbyte.company.example. :::
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 documentation for more information.
abctl local install --host [HOSTNAME]
Running over HTTP
Airbyte suggest that you secure your instance of Airbyte using TLS. Running over plain HTTP allows attackers to see your
password over clear text. If you understand the risk and would still like to run Airbyte over HTTP, you must set
Secure Cookies to false. You can do this with abctl by passing the --insecure-cookies flag to abctl:
abctl local install --host [HOSTNAME] --insecure-cookies