You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
client-id: ## e.g. e83bbc57-1991-417f-8203-3affb47636cf
171
+
client-secret: ## e.g. wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
172
+
165
173
# GCP Secrets
166
174
gcp.json: <CREDENTIALS_JSON_BLOB>
167
175
```
@@ -202,15 +210,62 @@ Follow these instructions to add the Airbyte helm repository:
202
210
203
211
2. Paste the following into your newly created `values.yaml` file. This is required to deploy Airbyte Self-Managed Enterprise:
204
212
205
-
```yml
213
+
```yaml
206
214
global:
207
215
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:
208
244
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
211
264
```
212
265
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).
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
-
380
419
#### Configuring Ingress
381
420
382
421
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