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

Docs for custom image registries #49137

Merged
merged 8 commits into from
Dec 23, 2024

Conversation

ian-at-airbyte
Copy link
Contributor

@ian-at-airbyte ian-at-airbyte commented Dec 12, 2024

What

Deployment docs for custom image registries.

How

Adds a new topic to the OSS deployment guide, and a new section to the enterprise deployment guide. These sections are mostly the same, and provide guidance on how to modify your values.yaml file and push images to your registry.

Review guide

  1. https://airbyte-docs-git-10298-docs-private-regis-ac8abb-airbyte-growth.vercel.app/deploying-airbyte/integrations/custom-image-registries (whole page)
  2. https://airbyte-docs-git-10298-docs-private-regis-ac8abb-airbyte-growth.vercel.app/enterprise-setup/implementation-guide#configure-a-custom-image-registry (just this section)

User Impact

People now have instructions to set up custom registries for their images.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Copy link

vercel bot commented Dec 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 6:36pm

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Dec 12, 2024
@ian-at-airbyte
Copy link
Contributor Author

In a separate task I'm reviewing the deployment docs and may end of merging/repurposing OSS and enterprise. For now this information appears twice. It's not meant to be this way permanently.

@ian-at-airbyte
Copy link
Contributor Author

Thanks Alex. This feedback was really good.

I mostly used the structure you proposed, but I realized I could tuck the auth portion within the first heading reasonably well, so I did that and kept the process to two main steps. Hopefully that makes sense to people.

I tested the overall flow and have the images in my GitHub account (thanks for the command you provided).

It's also possible to override specific platform images in the helm charts, such as webapp.image.registry = docker.io/foo.

I don't consider this a blocker, but I was never able to get this part to work. I'm probably doing it wrong though.

@ian-at-airbyte ian-at-airbyte marked this pull request as ready for review December 18, 2024 22:30
@ian-at-airbyte ian-at-airbyte changed the title [Do not merge][Draft] - Custom image registries Docs for custom image registries Dec 18, 2024
@Hesperide
Copy link
Contributor

These docs are awesome. Left a couple nits, then good to merge.

@ian-at-airbyte ian-at-airbyte merged commit c9237bd into master Dec 23, 2024
26 checks passed
@ian-at-airbyte ian-at-airbyte deleted the 10298-docs-private-registry-support branch December 23, 2024 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants