Skip to content

Commit 0701fff

Browse files
authored
docs: using standard tools for interacting with airbyte installed by abctl (#44002)
1 parent 8c6e94c commit 0701fff

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/using-airbyte/getting-started/oss-quickstart.md

+10
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,16 @@ rm -rf ~/.airbyte/abctl
338338

339339
## Troubleshooting
340340

341+
### Using standard tools to interact with an Airbyte instance that was installed with `abctl`
342+
343+
`abctl` install Airbyte into a kind cluster on your local machine. If you'd like to interact directly with any of the underlying infrastructure, you can use standard tooling. You will need to make sure these tools are installed (or install them yourself). Any of these out of the box tools will work with an Airbyte instance installed with `abctl`.
344+
345+
If you want to interact with the pods or resources inside the cluster you can use [kubectl](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) and [helm](https://helm.sh/). Just make sure you are pointing at the correct K8s configuration e.g. `kubectl --kubeconfig ~/.airbyte/abctl/abctl.kubeconfig --namespace airbyte-abctl get pods`
346+
347+
[kind](https://kind.sigs.k8s.io/) is a tool for creating a K8s cluster using docker instead of having to install a local K8s cluster. You only need to think about kind if you want to make an adjustment to the cluster itself.
348+
349+
For more advanced interactions (e.g. loading custom docker containers), read more in [developing locally](../../contributing-to-airbyte/developing-locally#using-abctl-for-airbyte-development).
350+
341351
### Unable To Locate User Email
342352
:::note
343353
In `abctl` [v0.11.0](https://github.com/airbytehq/abctl/releases/tag/v0.11.0), support for basic-auth was removed (as basic-auth support was removed from the `Airbyte Platform` in [v0.63.11](https://github.com/airbytehq/airbyte-platform/releases/tag/v0.63.11), and replaced with a more secure randomly generated password. When logging into Airbyte, the email (provided during registration) should be automatically populated and the randomly generated password can be fetched by running `abctl local credentials`.

0 commit comments

Comments
 (0)