Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix technical inaccuracies in Local JSON destination documentation #55808

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

devin-ai-integration[bot]
Copy link
Contributor

This PR fixes technical inaccuracies in the Local JSON destination documentation, particularly regarding the default data write location and the LOCAL_ROOT environment variable. It updates the documentation to reflect Airbyte's current deployment architecture using abctl instead of docker-compose.

Link to Devin run: https://app.devin.ai/sessions/69d164d256f8438f80b5c11a52242fcf
Requested by: [email protected]

Copy link
Contributor Author

🤖 Devin AI Engineer

Original prompt from [email protected]:

@Devin Look at the documentation for the local JSON destination, located here: <https://docs.airbyte.com/integrations/destinations/local-json>. Compare it with the source code for this connector, which is located here: <https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/destination-local-json>

Please identify any of the following issues: documentation that is technically incorrect, confusing or otherwise hard to understand. Can you propose any updates? I'd specifically like you to evaluate the default location where data is written and where the LOCAL_ROOT environment variable should be set. But if you notice anything else that seems like it might be wrong, think about how you can improve that as well.

If you see a problem but don't know how to fix it, please say so too.

Preview of a link: https://docs.airbyte.com/integrations/destinations/local-json
> # docs.airbyte.com
> ## [Local JSON | Airbyte Documentation](https://docs.airbyte.com/integrations/destinations/local-json)
> This destination is meant to be used on a local workstation and won't work on Kubernetes

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link

vercel bot commented Mar 17, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 18, 2025 11:06pm

3. **Access Data After Sync Completion**
- For completed pods where the data is stored in the persistent volume:
```
kubectl --kubeconfig ~/.airbyte/abctl/abctl.kubeconfig --namespace airbyte-abctl run file-access --image=busybox --restart=Never -it --rm --volumes=local-json-data:/data -- /bin/sh -c "ls -la /data"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is incorrect. kubectl run does not support --volumes directly. You need to define a volume using a pod or deployment spec instead.

```
- To view file contents directly:
```
kubectl --kubeconfig ~/.airbyte/abctl/abctl.kubeconfig --namespace airbyte-abctl exec -it file-access -- cat /data/your_stream_name/*.jsonl
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the expected location of this file? My terminal tells me no matches are found.

- In the Airbyte UI, create or edit your connection to use this destination
- **Important**: You must configure the destination pod to mount the PVC during sync:
```
kubectl --kubeconfig ~/.airbyte/abctl/abctl.kubeconfig --namespace airbyte-abctl patch deployment airbyte-abctl-destination -p '{"spec":{"template":{"spec":{"volumes":[{"name":"data-volume","persistentVolumeClaim":{"claimName":"local-json-data"}}],"containers":[{"name":"airbyte-abctl-destination","volumeMounts":[{"name":"data-volume","mountPath":"/local"}]}]}}}}'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check this. I get: Error from server (NotFound): deployments.apps "airbyte-abctl-destination" not found

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

2 participants