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.

Sign up for GitHub

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

Remove Kustomize references in docs and replace with Helm Chart #30008

Merged
merged 4 commits into from
Aug 31, 2023
Merged

Remove Kustomize references in docs and replace with Helm Chart #30008

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
681000c
remove kustomize ref
marcosmarxm Aug 30, 2023
6da1752
fix ref
marcosmarxm Aug 30, 2023
aa4926b
update deployment guidance
marcosmarxm Aug 30, 2023
1ddb9fe
link to custom helm deploy
marcosmarxm Aug 30, 2023
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
8 changes: 3 additions & 5 deletions docs/operator-guides/configuring-airbyte.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,12 @@ If you want to manage your own docker files, please refer to Airbyte's docker fi

## Kubernetes Deployments

The recommended way to run an Airbyte Kubernetes deployment is via the `Kustomize` overlays.

We recommend using the overlays in the `stable` directory as these have preset resource limits.
The recommended way to run an [Airbyte Kubernetes deployment](../deploying-airbyte/on-kubernetes-via-helm.md) is via the `Helm Charts`.

To configure the default Airbyte Kubernetes deployment, modify the `.env` in the respective directory. Each application will consume the appropriate
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is true for Helm charts. As far as I know, the .env file has no impact on Helm deployments of Airbyte. Instead, values need to be defined in the env-configmap.yaml template.

@git-phu could you sanity check my claim here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that is correct. Modifying the .env file has no impact on Helm deployments.

The instructions for configuring a helm deployment are already present in the linked helm docs here https://docs.airbyte.com/deploying-airbyte/on-kubernetes-via-helm/#custom-deployment

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@git-phu @pmossman can you check the new sentence? I'll reference to the custom deployment guides too.

env var from a generated configmap.

If you want to manage your own Kube manifests, please refer to the various `Kustomize` overlays for examples.
If you want to manage your own Kube manifests, please refer to the `Helm Chart`.

## Reference

Expand Down Expand Up @@ -156,7 +154,7 @@ A job specific variable overwrites the default sync job variable defined above.

#### Worker

1. `TEMPORAL_WORKER_PORTS` - Define the local ports the Airbyte Worker pod uses to connect to the various Job pods. Port 9001 - 9040 are exposed by default in the Kustomize deployments.
1. `TEMPORAL_WORKER_PORTS` - Define the local ports the Airbyte Worker pod uses to connect to the various Job pods. Port 9001 - 9040 are exposed by default in the Helm Chart.

#### Logging

Expand Down
2 changes: 1 addition & 1 deletion docs/understanding-airbyte/jobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ Brief description of how this works,

The Cloud Storage store is treated as the source-of-truth of execution state.

The Container Orchestrator is only available for Airbyte Kubernetes today and automatically enabled when running the Airbyte Helm charts/Kustomize deploys.
The Container Orchestrator is only available for Airbyte Kubernetes today and automatically enabled when running the Airbyte Helm Charts deploys.

![Orchestrator Lifecycle](../.gitbook/assets/orchestrator-lifecycle.png)

Expand Down