add kind custom connector troubleshooting to quickstart (#45207)

airbytehq · Sep 7, 2024 · 22b8ce8 · 22b8ce8
1 parent 5cb6c6f
commit 22b8ce8
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 0 deletions.
diff --git a/docs/operator-guides/assets/custom-connector-error1.png b/docs/operator-guides/assets/custom-connector-error1.png
diff --git a/docs/operator-guides/assets/custom-connector-error2.png b/docs/operator-guides/assets/custom-connector-error2.png
diff --git a/docs/operator-guides/using-custom-connectors.md b/docs/operator-guides/using-custom-connectors.md
@@ -110,3 +110,22 @@ You can pull your connector image from your private registry to validate the pre
    This documentation will be linked in your connector setting's page.
 
 5. `Add` the connector to save the configuration. You can now select your new connector when setting up a new connection!
+
+
+# Troubleshooting
+
+## Loading connector docker containers into kind
+If you are running Airbyte in kind (kubernetes in docker -- this is the default method for abctl), you must load the docker image of that connector into the cluster. If you are seeing the following error, it likely means that the docker image has not been properly loaded into the cluster.
+
+![Screenshot of UI error when custom connector container is not loaded in the cluster](./assets/custom-connector-error1.png)
+
+![Screenshot of K8s error when custom connector container is not loaded in the cluster](./assets/custom-connector-error2.png)
+
+A connector container can be loaded using the following command:
+```
+kind load docker-image <image-name>:<image-tag> -n airbyte-abctl
+```
+For the example above, the command would be:
+```
+kind load docker-image airbyte/source-custom:1 -n airbyte-abctl
+```
diff --git a/docs/using-airbyte/getting-started/oss-quickstart.md b/docs/using-airbyte/getting-started/oss-quickstart.md
@@ -379,6 +379,14 @@ abctl local credentials --email <[email protected]>
 
 The password for this user can be retrieved by running `abctl local credentials`.
 
+### Using Custom Connectors
+In order to run a custom connector with an Airbyte instance that is running in kind, you must load the docker image of that connector into the cluster. A connector container can be loaded using the following command:
+```
+kind load docker-image <image-name>:<image-tag> -n airbyte-abctl
+```
+
+For more troubleshooting information review the troubleshooting section in [Uploading Customer Connectors](../../operator-guides/using-custom-connectors#troubleshooting)
+
 ### Additional Resources
 
 There are several channels for community support of local setup and deployment.