Skip to content

Commit c306552

Browse files
authored
Fixes (#38366)
1 parent 0db33b8 commit c306552

File tree

1 file changed

+60
-21
lines changed

1 file changed

+60
-21
lines changed

docs/enterprise-setup/implementation-guide.md

+60-21
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,10 @@ stringData:
105105
instance-admin-email: ## e.g. [email protected]
106106
instance-admin-password: ## e.g. password
107107

108+
# SSO OIDC Credentials
109+
client-id: ## e.g. e83bbc57-1991-417f-8203-3affb47636cf
110+
client-secret: ## e.g. wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
111+
108112
# AWS S3 Secrets
109113
s3-access-key-id: ## e.g. AKIAIOSFODNN7EXAMPLE
110114
s3-secret-access-key: ## e.g. wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
@@ -158,10 +162,14 @@ stringData:
158162
database-user: ## e.g. airbyte
159163
database-password: ## e.g. password
160164

161-
# Instance Admin
165+
# Instance Admin Credentials
162166
instance-admin-email: ## e.g. [email protected]
163167
instance-admin-password: ## e.g. password
164168

169+
# SSO OIDC Credentials
170+
client-id: ## e.g. e83bbc57-1991-417f-8203-3affb47636cf
171+
client-secret: ## e.g. wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
172+
165173
# GCP Secrets
166174
gcp.json: <CREDENTIALS_JSON_BLOB>
167175
```
@@ -202,15 +210,62 @@ Follow these instructions to add the Airbyte helm repository:
202210

203211
2. Paste the following into your newly created `values.yaml` file. This is required to deploy Airbyte Self-Managed Enterprise:
204212

205-
```yml
213+
```yaml
206214
global:
207215
edition: enterprise
216+
```
217+
218+
3. To enable SSO authentication, add instance admin details [SSO auth details](/access-management/sso) to your `values.yaml` file, under `global`. See the [following guide](/access-management/sso#set-up) on how to collect this information for various IDPs, such as Okta and Azure Entra ID.
219+
220+
```yaml
221+
auth:
222+
instanceAdmin:
223+
firstName: ## First name of admin user.
224+
lastName: ## Last name of admin user.
225+
identityProvider:
226+
type: oidc
227+
secretName: airbyte-config-secrets ## Name of your Kubernetes secret.
228+
oidc:
229+
domain: ## e.g. company.example
230+
app-name: ## e.g. airbyte
231+
clientIdSecretKey: client-id
232+
clientSecretSecretKey: client-secret
233+
```
234+
235+
236+
237+
4. You must configure the public facing URL of your Airbyte instance to your `values.yaml` file, under `global`:
238+
239+
```yaml
240+
airbyteUrl: # e.g. https://airbyte.company.example
241+
```
242+
243+
5. Verify the configuration of your `values.yml` so far. Ensure `license-key`, `instance-admin-email` and `instance-admin-password` are all available via Kubernetes Secrets (configured in [prerequisites](#creating-a-kubernetes-secret)). It should appear as follows:
208244

209-
# This must be set to the public facing URL of your Airbyte instance.
210-
airbyteUrl: #https://airbyte.company.example
245+
<details>
246+
<summary>Sample initial values.yml file</summary>
247+
248+
```yaml
249+
global:
250+
edition: enterprise
251+
airbyteUrl: # e.g. https://airbyte.company.example
252+
auth:
253+
instanceAdmin:
254+
firstName: ## First name of admin user.
255+
lastName: ## Last name of admin user.
256+
identityProvider:
257+
type: oidc
258+
secretName: airbyte-config-secrets ## Name of your Kubernetes secret.
259+
oidc:
260+
domain: ## e.g. company.example
261+
app-name: ## e.g. airbyte
262+
clientIdSecretKey: client-id
263+
clientSecretSecretKey: client-secret
211264
```
212265

213-
3. The following subsections help you customize your deployment to use an external database, log storage, dedicated ingress, and more. To skip this and deploy a minimal, local version of Self-Managed Enterprise, [jump to Step 3](#step-3-deploy-self-managed-enterprise).
266+
</details>
267+
268+
The following subsections help you customize your deployment to use an external database, log storage, dedicated ingress, and more. To skip this and deploy a minimal, local version of Self-Managed Enterprise, [jump to Step 3](#step-3-deploy-self-managed-enterprise).
214269

215270
#### Configuring the Airbyte Database
216271

@@ -361,22 +416,6 @@ secretsManager:
361416

362417
</details>
363418

364-
#### Configuring External OIDC Provider (Optional)
365-
366-
To enable SSO authentication, add [SSO auth details](/access-management/sso) to your `values.yaml` file.
367-
```yaml
368-
auth:
369-
identityProvider:
370-
type: oidc
371-
oidc:
372-
domain: #company.example
373-
app-name: #airbyte
374-
client-id: #e83bbc57-1991-417f-8203-3affb47636cf
375-
client-secret: #$OKTA_CLIENT_SECRET
376-
```
377-
378-
See the [following guide](/access-management/sso-providers/okta) on how to collect this information for Okta.
379-
380419
#### Configuring Ingress
381420

382421
To access the Airbyte UI, you will need to manually attach an ingress configuration to your deployment. The following is a skimmed down definition of an ingress resource you could use for Self-Managed Enterprise:

0 commit comments

Comments
 (0)