Skip to content

Commit bc2183e

Browse files
authored
fix sso auth block (#36038)
1 parent 4e0118b commit bc2183e

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

docs/enterprise-setup/implementation-guide.md

+17-19
Original file line numberDiff line numberDiff line change
@@ -235,29 +235,14 @@ license-key: # license key provided by Airbyte team
235235

236236
4. Add your Airbyte Self-Managed Enterprise license key to your `airbyte.yml` in the `license-key` field.
237237

238-
### Step 3: Configure your Deployment
239-
240-
1. Inside your `airbyte` directory, create an empty `values.yml` file.
241-
242-
2. Paste the following into your newly created `values.yml` file. This is required to deploy Airbyte Self-Managed Enterprise:
243-
244-
```yml
245-
global:
246-
edition: enterprise
247-
```
248-
249-
3. The following subsections help you customize your deployment to use SSO, an external database, log storage, and more. To skip this and deploy a minimal, local version of Self-Managed Enterprise, [jump to Step 4](#step-4-deploy-self-managed-enterprise).
250-
251-
#### Configure User Authentication
252-
253-
To enable SSO authentication, add [SSO auth details](/access-management/sso) to your `values.yml` file.
238+
5. To enable SSO authentication, add [SSO auth details](/access-management/sso) to your `airbyte.yml` file.
254239

255240
<details>
256-
<summary>Configuring auth in your values.yml file</summary>
241+
<summary>Configuring auth in your airbyte.yml file</summary>
257242

258243
<Tabs>
259244
<TabItem value="Okta" label="Okta">
260-
To configure SSO with Okta, add the following at the end of your `values.yml` file:
245+
To configure SSO with Okta, add the following at the end of your `airbyte.yml` file:
261246

262247
```yaml
263248
auth:
@@ -293,10 +278,23 @@ See the [following guide](/access-management/sso-providers/azure-entra-id) on ho
293278

294279
To modify auth configurations on an existing deployment (after Airbyte has been installed at least once), you will need to `helm upgrade` Airbyte with the additional environment variable `--set keycloak-setup.env_vars.KEYCLOAK_RESET_REALM=true`. As this also resets the list of Airbyte users and permissions, please use this with caution.
295280

296-
To deploy Self-Managed Enterprise without SSO, exclude the entire `auth:` section from your values.yml config file. You will authenticate with the instance admin user and password included in your `values.yml`. Without SSO, you cannot currently have unique logins for multiple users.
281+
To deploy Self-Managed Enterprise without SSO, exclude the entire `auth:` section from your values.yml config file. You will authenticate with the instance admin user and password included in your `airbyte.yml`. Without SSO, you cannot currently have unique logins for multiple users.
297282

298283
</details>
299284

285+
### Step 3: Configure your Deployment
286+
287+
1. Inside your `airbyte` directory, create an empty `values.yml` file.
288+
289+
2. Paste the following into your newly created `values.yml` file. This is required to deploy Airbyte Self-Managed Enterprise:
290+
291+
```yml
292+
global:
293+
edition: enterprise
294+
```
295+
296+
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 4](#step-4-deploy-self-managed-enterprise).
297+
300298
#### Configuring the Airbyte Database
301299

302300
For Self-Managed Enterprise deployments, we recommend using a dedicated database instance for better reliability, and backups (such as AWS RDS or GCP Cloud SQL) instead of the default internal Postgres database (`airbyte/db`) that Airbyte spins up within the Kubernetes cluster.

0 commit comments

Comments
 (0)