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

Jump to bottom

self-managed docs rewrite #32605

Merged
merged 6 commits into from
Nov 16, 2023
Merged

self-managed docs rewrite #32605

merged 6 commits into from
Nov 16, 2023

Conversation

Hesperide
Copy link
Contributor

Changes:

  • Creates a new 'enterprise setup' section. I will add a section for Cloud (SSO) in a separate PR.
  • Moves all self-managed docs into this section.
  • Creates a more focused implementation guide, separated from existing OSS setup.
  • Documents deploying self managed without SSO.
  • Moves the instructions for creating a app for Airbyte in Okta (will be centralized after adding Cloud docs).

@vercel Vercel
Copy link

vercel bot commented Nov 16, 2023 •
edited
Loading

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 Nov 16, 2023 10:52pm

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Nov 16, 2023
@Hesperide Hesperide marked this pull request as ready for review November 16, 2023 17:02
@octavia-squidington-iv octavia-squidington-iv requested a review from a team November 16, 2023 17:20
@Hesperide Hesperide force-pushed the alex.cuoci/self-managed-docs branch 2 times, most recently from 342a16a to 7e920bd Compare November 16, 2023 19:02
@Hesperide Hesperide removed the request for review from a team November 16, 2023 19:02
@octavia-squidington-iii octavia-squidington-iii removed the area/connectors Connector related issues label Nov 16, 2023
@octavia-squidington-iv octavia-squidington-iv requested a review from a team November 16, 2023 19:03
@Hesperide Hesperide removed the request for review from a team November 16, 2023 19:17
colesnodgrass
colesnodgrass approved these changes Nov 16, 2023
View reviewed changes
Copy link
Member

@colesnodgrass colesnodgrass left a comment

Choose a reason for hiding this comment

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

With some recommendations to address a few inconsistencies.

docs/enterprise-setup/self-managed/implementation-guide.md Outdated

# Implementation Guide

[Airbyte Self Managed](./README.md) is in an early access stage for select priority users. Once you [are qualified for an Airbyte Self Managed license key](https://airbyte.com/company/talk-to-sales), you can deploy Airbyte with the following instructions.
Copy link
Member

Choose a reason for hiding this comment

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

missing - in Self-Managed

docs/enterprise-setup/self-managed/implementation-guide.md Outdated
</Tabs>
</details>

## Deploy Airbyte Self Managed
Copy link
Member

Choose a reason for hiding this comment

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

Missing - in Self-Managed

docs/enterprise-setup/self-managed/implementation-guide.md Outdated
After specifying your own configuration, run the following command:

```text
./tools/bin/install_airbyte_pro_on_helm.sh --values path/to/values.yaml %release_name% airbyte/airbyte
Copy link
Member

Choose a reason for hiding this comment

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

I know this was in the previous docs as well, but using % here is incorrect. We should have $RELEASE_NAME or simply leave it out.

docs/enterprise-setup/self-managed/sso.md Outdated
Airbyte Enterprise supports Single Sign-On, allowing an organization to manage user access to their Airbyte Enterprise instance through the configuration of an Identity Provider (IdP). Airbyte Enterprise currently supports SSO via OIDC with [Okta](https://www.okta.com/) as an IdP.
The following instructions walk you through:
1. [Setting up the Okta OIDC App Integration to be used by your Airbyte instance](#setting-up-okta-for-sso)
2. [Configuring Airbyte Self Managed to use SSO](#deploying-airbyte-enterprise-with-okta)
Copy link
Member

Choose a reason for hiding this comment

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

Missing - in Self-Managed

docs/enterprise-setup/self-managed/sso.md Outdated

_Example values_

`<your-airbyte-domain>` should point to where your Airbyte instance will be available, including the http/https protocol.


## Deploying Airbyte Enterprise with Okta
Copy link
Member

@colesnodgrass colesnodgrass Nov 16, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Seems we may be inconsistent with Airbyte Self-Managed vs Airbyte Enterprise. Do we use both names or should we pick one?

@Hesperide Hesperide enabled auto-merge (squash) November 16, 2023 22:51
@Hesperide Hesperide merged commit ddd233b into master Nov 16, 2023
10 checks passed
@Hesperide Hesperide deleted the alex.cuoci/self-managed-docs branch November 16, 2023 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@colesnodgrass colesnodgrass colesnodgrass approved these changes

@timroes timroes Awaiting requested review from timroes

Assignees
No one assigned
Labels
area/documentation Improvements or additions to documentation connectors/source/bing-ads
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Hesperide @colesnodgrass @octavia-squidington-iii