Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework the OSS deployment docs to center around Helm. #39537

Merged
merged 27 commits into from
Jul 12, 2024
Merged
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
3ccc89a
Rework the OSS deployment docs to center around Helm.
bgroff Jun 17, 2024
1978164
Merge branch 'master' into bgroff/deploy-documentation-refactor
Adorism Jul 4, 2024
f6ac87a
edits to deployment overview, sidebar nav, and a redirect
Adorism Jul 5, 2024
f836f8e
update wording on example usecases for Pyairbyte
Adorism Jul 5, 2024
75f2c86
Merge branch 'master' into bgroff/deploy-documentation-refactor
Adorism Jul 5, 2024
f8535a2
Merge branch 'master' into bgroff/deploy-documentation-refactor
Adorism Jul 5, 2024
a02a5a8
Merge branch 'master' into bgroff/deploy-documentation-refactor
Adorism Jul 9, 2024
5868d91
edits to deployment reference overview, database, and ingress
Adorism Jul 9, 2024
9f7cd70
Merge branch 'master' into bgroff/deploy-documentation-refactor
Adorism Jul 9, 2024
5476ddc
comment out some navigation to enable incremental additions of deploy…
Adorism Jul 9, 2024
84a5b9d
fix build errors and update wording in secrets guide
Adorism Jul 9, 2024
7822ffb
Merge branch 'master' into bgroff/deploy-documentation-refactor
Adorism Jul 9, 2024
eaec7c2
Update the documentation to address some of the feedback given.
bgroff Jul 10, 2024
5cc18d0
Fix link
bgroff Jul 10, 2024
f4e74ed
Take two on link fixing.
bgroff Jul 10, 2024
4314147
Removed all references to Enterprise. Added a note in the Ingress sec…
bgroff Jul 12, 2024
492a7ad
Merge branch 'master' into bgroff/deploy-documentation-refactor
bgroff Jul 12, 2024
76ddf22
Revert this file.
bgroff Jul 12, 2024
2a61a1f
Merge branch 'bgroff/deploy-documentation-refactor' of github.com:air…
bgroff Jul 12, 2024
e285f0c
Add section on adding the help repo.
bgroff Jul 12, 2024
85b9d92
Add section for AWS.
bgroff Jul 12, 2024
96abe19
Fix typo.
bgroff Jul 12, 2024
75cff9a
wording
nataliekwong Jul 12, 2024
f999f62
wording integrations
nataliekwong Jul 12, 2024
13c4d17
typing
nataliekwong Jul 12, 2024
c160c6e
Merge branch 'master' into bgroff/deploy-documentation-refactor
bgroff Jul 12, 2024
4f22582
Merge branch 'master' into bgroff/deploy-documentation-refactor
bgroff Jul 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
wording integrations
  • Loading branch information
nataliekwong committed Jul 12, 2024
commit f999f62ac4d0de060d78bae3ca11f0c5185686f7
20 changes: 9 additions & 11 deletions docs/deploying-airbyte/deploying-airbyte.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Enterprise Customers should follow the steps outlined in our docs on [Airbyte Se

Airbyte is built to be deployed into a Kubernetes cluster.
You can use a Cloud Provider, such as, AWS, GCP, Azure, or onto a single node, such as an EC2 VM, or even locally on your computer.
We recommend deploying Airbyte using Helm and the documented Helm chart values.

We highly recommend deploying Airbyte using Helm and the documented Helm chart values.

Helm is a Kubernetes package manager for automating deployment and management of complex applications with microservices on Kubernetes. Refer to our [Helm Chart Usage Guide](https://airbytehq.github.io/helm-charts/) for more information about how to get started.

Expand All @@ -28,7 +29,7 @@ The [Infrastructure](infrastructure/aws) section describes the Airbyte's recomme
Charts are stored in `helm-repo`. As a result, you do not need to clone the repo each time you need to deploy the chart.

To add remote helm repo:
1. Run: `helm repo add airbyte https://airbytehq.github.io/helm-charts`. `airbyte` is the name of the repository that will be indexed locally.
1. Run: `helm repo add airbyte https://airbytehq.github.io/helm-charts`. In this example, `airbyte` is being used to represent the name of the repository that will be indexed locally.

2. After adding the repo, perform the repo indexing process by running `helm repo update`.

Expand Down Expand Up @@ -113,9 +114,9 @@ kubectl create secret generic airbyte-config-secrets \
## Creating a values.yaml override file

To configure your installation of Airbyte, you will need to override specific parts of the Helm Chart. To do this you should create a new file called `values.yaml` somewhere that is accessible during the installation process.
The documentation has been created to "build up" a values.yaml, so there is no need to copy the whole of the Chart values.yaml, you only need to provide the specific overrides.
The documentation has been created to "build up" a values.yaml, so there is no need to copy the whole of the Chart values.yaml. You only need to provide the specific overrides.

Each [Integrations](#integrations) will provide a section of the specific values that you should override and provide examples of what the values should look like. An example `values.yaml` file might look something like:
Each [Integration](#integrations) will provide a section of the specific values that you should override and provide examples of what the values should look like. An example `values.yaml` file may look like the following:

```yaml
global:
Expand All @@ -140,11 +141,9 @@ global:

## Integrations

The Airbyte platform is built to integrate with your existing cloud infrastructure. You can
configure various components of the platform to suit your needs. This includes an object store,
such as S3 or GCS for storing logs and state, a database for externalizing state, and a secret
manager for keep your secrets secure. Each of these integrations can be configured to suit your
needs. Their configuration is described in the Integrations section. Each of these integrations has its own section where you'll find an explanation of the rationale for why it's useful to configure the integration. There, you'll also find details about how to configure the integration.
The Airbyte platform is built to integrate with your existing cloud infrastructure. You can configure various components of the platform to suit your needs. This includes an object store, such as S3 or GCS for storing logs and state, a database for externalizing state, and a secrets manager for keep your secrets secure.

Each of these integrations can be configured to suit your specific needs and is described in the [Integration](#integrations) section. Each of these integrations has its own section where you'll find an explanation for why it's useful to configure the integration. There, you'll also find details about how to configure the integration.

- [State and Logging Storage](./integrations/storage)
- [Secret Management](./integrations/secrets)
Expand All @@ -154,8 +153,7 @@ needs. Their configuration is described in the Integrations section. Each of the

## Installing Airbyte

After you have applied your Secret values to the Cluster and you have filled out a values.yaml file appropriately for your specific configuration,
you can begin a Helm Install. To do this, make sure that you have the [Helm Client](https://helm.sh/docs/intro/install/) installed and on your path.
After you have applied your Secret values to the Cluster and you have filled out a values.yaml file appropriately for your specific configuration, you can begin a Helm Install. To do this, make sure that you have the [Helm Client](https://helm.sh/docs/intro/install/) installed and on your path.
Then you can run:

```sh
Expand Down
Loading