<@U04S8PLJWMT> How to install Airbyte locally ? Se...
# airbyte-agents-ask-ai
p
@kapa.ai How to install Airbyte locally ? Seems like docker compose support is deprecated.. I am using Rancher locally for testing applications on kubernetes... could you help me with steps...
k
Yes, Docker Compose is deprecated [Migrating from Docker Compose]. Depending on your local setup, you have two main ways to install Airbyte locally: Option 1: Deploy to an Existing Local Kubernetes Cluster (Rancher / K8s) via Helm Because you are using Rancher and already have a local Kubernetes cluster running, you should use the official Helm Chart. (
abctl
only manages its own internal
kind
cluster and cannot deploy to an existing cluster) [abctl Overview]. 1. Add the Airbyte Helm Repository Ensure you have the Helm client installed, then add and update the repository:
Copy code
helm repo add airbyte https://airbytehq.github.io/charts  
helm repo update
[Installation Guide] 2. Create a Namespace Create a dedicated namespace for Airbyte:
Copy code
kubectl create namespace airbyte
[Installation Guide] 3. Create a values.yaml File Create a
values.yaml
file to customize your deployment configurations (for example, setting the URL or external integrations):
Copy code
global:  
  airbyteUrl: http://localhost:8000
[Installation Guide] 4. Find the Chart Version and Install Airbyte Check available versions:
Copy code
helm search repo airbyte --versions
Deploy the chart to your cluster (replace the
--version
flag with the chart version you wish to install):
Copy code
helm install airbyte airbyte/airbyte \  
  --namespace airbyte \  
  --values ./values.yaml \  
  --version 2.0.18
[Installing Airbyte] Option 2: Use abctl (Airbyte's CLI for Docker) If you prefer an automated single-command setup that manages its own local Kubernetes-in-Docker environment without manually configuring Helm in Rancher, use `abctl`: 1. Install
abctl
:curl -LsfS https://get.airbyte.com | bash - brew tap airbytehq/tap brew install abctl ◦ Mac/Linux (curl): ◦ Homebrew (Mac/Linux): ◦ Windows: Download the latest release binary from GitHub and add it to your PATH [Install abctl]. 1. Run Airbyte: Make sure Docker Desktop or Docker Engine is running, then run:abctl local install Airbyte will deploy and become available at
http://localhost:8000
[Run Airbyte]. 2. Get Initial Credentials:abctl local credentials [Install and manage local Airbyte instances] 👍 0 button 👎 0 button ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups or DM the app for 1-to-1 help.
p
@kapa.ai how tos etup authentication ? I installed airbyte...but not able to login
k
Airbyte comes with built-in authentication enabled by default, which requires an email and a password [Authentication]. Depending on how you deployed Airbyte (via Helm on Kubernetes/Rancher or via
abctl
), follow the steps below to retrieve, set, or troubleshoot your login credentials: If You Deployed via Helm (Rancher / Kubernetes) 1. Retrieve the Default Generated Password Airbyte automatically creates a Kubernetes Secret named
airbyte-auth-secrets
. You can inspect the secret using `kubectl`:
Copy code
kubectl get secret airbyte-auth-secrets -n <YOUR_NAMESPACE> -o yaml
The output contains base64-encoded values for
instance-admin-password
. To decode it:
Copy code
echo '<BASE64_ENCODED_PASSWORD>' | base64 -d
[Authentication] 2. Set Your Own Password via a Secret To define a custom password, create a
secret.yaml
file:
Copy code
apiVersion: v1
kind: Secret
metadata:
  name: airbyte-auth-secrets
type: Opaque
stringData:
  instance-admin-password: "YourStrongPassword"
Apply it to your namespace and restart the
airbyte-server
pod:
Copy code
kubectl apply -f secret.yaml -n <YOUR_NAMESPACE>
[Authentication] If You Deployed via abctl 1. Retrieve Your Credentials Run the following command in your terminal to see the email and generated password:
Copy code
abctl local credentials
[Authentication; Set up authentication] 2. Update Your Email or Password You can update your credentials at any time using:
Copy code
abctl local credentials --email your_email@example.com --password YourStrongPassword
[Install and manage local Airbyte instances; FAQ] Common Login Issues & Troubleshooting Insecure Cookies Error (Deploying over HTTP) If you access Airbyte over HTTP (non-HTTPS) on a custom domain/IP, the browser may block secure session cookies. • Using Helm: Add the following to your
values.yaml
and re-deployglobal auth: security: cookieSecureSetting: "false"[Disabling Secure Cookies] • Using `abctl`: Reinstall with the
--insecure-cookies
flag:abctl local install --insecure-cookies[Run Airbyte] Disabling Authentication Completely If you are running in an isolated environment or behind a secure SSO proxy, you can disable Airbyte's authentication by setting this in your `values.yaml`:
Copy code
global:
  auth:
    enabled: false
Apply it using
helm upgrade
or
abctl local install --values ./values.yaml
[Turning Off Authentication]. 👍 0 button 👎 0 button ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups or DM the app for 1-to-1 help.
p
@kapa.ai In one of my job.. I am getting this error:
Setting attempt to FAILED because the workflow for this connection was restarted, and existing job state was cleaned.
How to fix this ? Can I manaully goa dn change some value in DB to update thi ?
k
Why This Error Happens This error occurs when a platform-level event causes the orchestration workflow (managed by Temporal) to restart entirely [Sync Jobs; Forum Post: Failed to sync...]. When the workflow restarts: 1. All in-progress jobs for the connection are marked as terminally failed [Sync Jobs]. 2. The existing attempt is marked as
FAILED
, and the in-memory job state is cleaned [Sync Jobs; Forum Post: Failed to sync...]. 3. No automatic retry occurs within that same execution—the connection waits for the next scheduled run or requires a manual sync [Sync Jobs]. Common causes for the workflow restarting mid-sync include: • Worker or Temporal pod evictions/restarts: (e.g., Kubernetes node scale-downs, OOM kills, resource pressure) killing the workflow task mid-flight [Airbyte 2.1.0 - MySQL CDC sync jobs fail...>]. • Activity heartbeat timeouts: If an activity takes too long or stops responding, Temporal marks it failed and triggers a workflow restart [Heartbeats; ConnectionManagerWorkflow continues retrying...]. How to Fix It 1. Trigger a Manual Sync: Since the workflow clean-up marks the job terminally failed, retry counters reset. For scheduled syncs, the next scheduled run will create a fresh job. If the connection has no schedule or you need it immediately, manually trigger a new sync in the UI [Sync Jobs]. 2. Check Infrastructure & Resource Allocation: If the issue repeats across scheduled runs, verify whether your Kubernetes/Rancher pods (especially
temporal
,
airbyte-worker
, or
workload-api-server
) are restarting or being evicted mid-sync [Sync Jobs; Airbyte 2.1.0 - MySQL CDC sync jobs fail...>]. Ensure sufficient CPU/memory resources are allocated to prevent worker crashes. 3. Reset Connector State (if corrupt): If the job failed during an incremental or CDC sync and subsequent attempts fail due to inconsistent/broken state, reset the connection from the UI or clear/update the connector state via the Airbyte API [CDC Replication Error...; Forum Post: Connector state appears to be doubled up]. Can You Manually Change Values in the Database? The knowledge sources do not provide instructions or recommend manually modifying the database tables (such as
jobs
or
attempts
) to revive a failed sync. Airbyte tracks job lifecycle and state transitions directly in the database (
jobs
and
attempts
tables) while relying on Temporal for active workflow orchestration [Jobs Database]. Manually changing a status in the database will not resume the interrupted orchestration workflow. Instead, trigger a fresh sync from the UI/API or reset the connection state [Sync Jobs; Forum Post: Connector state appears to be doubled up]. 👍 0 button 👎 0 button ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups or DM the app for 1-to-1 help.
p
@kapa.ai How to onboard new user in Airbyte ? Seems like can't do it via UI ?
k
Whether you can onboard new users via the UI depends on the version and edition of Airbyte you are running: Airbyte Open Source / Community Edition I'm sorry, but there's no information about multi-user management or inviting additional users via the UI in Airbyte Open Source / Community Edition. In self-hosted Open Source deployments: • Airbyte comes with a single administrative account configured via local secrets (
airbyte-auth-secrets
) or
abctl
credentials [Authentication]. • Multi-user RBAC and organization user management are not available in the free Open Source edition [Users; Manage workspaces]. Airbyte Cloud & AI-Agents (Team, Pro, Custom, Enterprise Plans) If you are on an edition/plan that supports organization and user management (such as Team, Pro, Custom, or Enterprise Flex), you can onboard users through the following methods: 1. Inviting Users via the UI Organization administrators can invite new members directly: 1. Open Users from the sidebar [Users]. 2. Click Invite Users [Users]. 3. Enter one or more email addresses (separated by commas, semicolons, or spaces) [Users]. 4. Click Send invites [Users]. Once invited, the user receives an invitation email and their status changes to Active upon signing in [Users]. 2. Adding Users to Specific Workspaces To grant users access to specific workspaces: 1. Navigate to the desired workspace [Manage workspaces]. 2. Go to Workspace settings > Members [Manage workspaces]. 3. Click New member, search for the user by name or email, assign their role, and click Add new member [Manage workspaces]. 3. Identity Provider (SCIM) Provisioning For organizations using SSO and SCIM (e.g., via Okta or Microsoft Entra ID), users are automatically provisioned and managed directly from your identity provider rather than invited through the Airbyte UI [SCIM provisioning]. 👍 0 button 👎 0 button ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups or DM the app for 1-to-1 help.
p
@kapa.ai can we implement SSO login feature in Airbyte open source edition ?
k
No, native Single Sign-On (SSO / OIDC) integration is not available in the Airbyte Open Source (Community) edition [Github Issue (open): Existing keycloak integration with airbyte OSS; Single sign on (SSO)]. Key Details: • Enterprise Only: Native SSO and OIDC identity-provider integrations (such as Keycloak, Okta, and Microsoft Entra ID) require a valid Airbyte Self-Managed Enterprise license key or a supported Airbyte Cloud plan [Github Issue (open): Existing keycloak integration with airbyte OSS; Single sign on (SSO)]. Even if Helm chart values related to
generic-oidc
or identity providers are visible, they do not function without an Enterprise license [Github Issue (open): Existing keycloak integration with airbyte OSS]. • Open Source Authentication: Airbyte Open Source only provides single-account built-in basic authentication (configured via instance email and password) [Authentication]. Workaround for Airbyte Open Source If you must protect an Airbyte Open Source instance with your organization's SSO, the standard approach is to: 1. Deploy Airbyte behind a reverse proxy (such as Nginx, OAuth2-Proxy, or a cloud provider's Identity-Aware Proxy) that handles the authentication and OIDC/SSO verification before routing traffic to Airbyte [Securing Airbyte Open Source]. 2. Disable Airbyte's internal authentication in your `values.yaml`global auth: enabled: false[Turning Off Authentication] 👍 0 button 👎 0 button ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups or DM the app for 1-to-1 help.