Making single port 8000 default and update NetworkErrorBoundary (#3656)
* Making single port 8000 default and update NetworkErrorBoundary.tsx response code 502 * add .env files * Updating instructions in docs/deploying-airbyte/*
This commit is contained in:
committed by
GitHub
parent
b3756b1daf
commit
e4335b1d17
3
.env
3
.env
@@ -18,7 +18,6 @@ TRACKING_STRATEGY=segment
|
||||
# Issue: https://github.com/airbytehq/airbyte/issues/577
|
||||
HACK_LOCAL_ROOT_PARENT=/tmp
|
||||
WEBAPP_URL=http://localhost:8000/
|
||||
# todo - Migrate to a way to define a better default API_URL
|
||||
# API_URL=http://localhost:8001/api/v1/
|
||||
API_URL=/api/v1/
|
||||
TEMPORAL_HOST=airbyte-temporal:7233
|
||||
INTERNAL_API_HOST=airbyte-server:8001
|
||||
|
||||
2
.env.dev
2
.env.dev
@@ -18,5 +18,5 @@ TRACKING_STRATEGY=logging
|
||||
# Issue: https://github.com/airbytehq/airbyte/issues/577
|
||||
HACK_LOCAL_ROOT_PARENT=/tmp
|
||||
WEBAPP_URL=http://localhost:8000/
|
||||
API_URL=http://localhost:8001/api/v1/
|
||||
API_URL=/api/v1/
|
||||
INTERNAL_API_HOST=airbyte-server:8001
|
||||
|
||||
@@ -9,7 +9,7 @@ info:
|
||||
Here are some conventions that this API follows:
|
||||
* All endpoints are http POST methods.
|
||||
* All endpoints accept data via `application/json` request bodies. The API does not accept any data via query params.
|
||||
* The naming convention for endpoints is: localhost:8001/{VERSION}/{METHOD_FAMILY}/{METHOD_NAME} e.g. `localhost:8001/v1/connections/create`.
|
||||
* The naming convention for endpoints is: localhost:8000/{VERSION}/{METHOD_FAMILY}/{METHOD_NAME} e.g. `localhost:8000/v1/connections/create`.
|
||||
* For all `update` method, the whole object must be passed in, even the fields that did not change.
|
||||
|
||||
Change Management:
|
||||
@@ -30,7 +30,7 @@ externalDocs:
|
||||
description: Find out more about Airbyte
|
||||
url: "https://airbyte.io"
|
||||
servers:
|
||||
- url: "http://localhost:8001/api"
|
||||
- url: "http://localhost:8000/api"
|
||||
tags:
|
||||
- name: workspace
|
||||
description: Workspace related resources.
|
||||
|
||||
@@ -110,7 +110,7 @@ docker-compose up -d
|
||||
For security reasons, we strongly recommend to not expose Airbyte on Internet available ports. Future versions will add support for SSL & Authentication.
|
||||
{% endhint %}
|
||||
|
||||
* Create ssh tunnels for port 8000 \(the static web server\) and port 8001 \(the api server\)
|
||||
* Create ssh tunnel for port 8000
|
||||
|
||||
{% hint style="info" %}
|
||||
If you want to use different ports you will need to modify `API_URL` in your `.env` file and restart Airbyte.
|
||||
@@ -118,7 +118,7 @@ If you want to use different ports you will need to modify `API_URL` in your `.e
|
||||
|
||||
```bash
|
||||
# In your workstation terminal
|
||||
ssh -i $SSH_KEY -L 8000:localhost:8000 -L 8001:localhost:8001 -N -f ec2-user@$INSTANCE_IP
|
||||
ssh -i $SSH_KEY -L 8000:localhost:8000 -N -f ec2-user@$INSTANCE_IP
|
||||
```
|
||||
|
||||
* Just visit [http://localhost:8000](http://localhost:8000) in your browser and start moving some data!
|
||||
|
||||
@@ -121,13 +121,13 @@ For security reasons, we strongly recommend to not expose Airbyte on Internet av
|
||||
This part assumes that you have access to a terminal on your workstation
|
||||
{% endhint %}
|
||||
|
||||
* Create ssh tunnels for port 8000 \(the static web server\) and port 8001 \(the api server\)
|
||||
* Create ssh tunnel for port 8000
|
||||
|
||||
```bash
|
||||
# Inside your workstation terminal
|
||||
# 1. Replace $SSH_KEY with private key path downloaded from earlier steps
|
||||
# 2. Replace $INSTANCE_IP with publicIpAddress noted from earlier steps
|
||||
ssh -i $SSH_KEY -L 8000:localhost:8000 -L 8001:localhost:8001 -N -f byteuser@$INSTANCE_IP
|
||||
ssh -i $SSH_KEY -L 8000:localhost:8000 -N -f byteuser@$INSTANCE_IP
|
||||
```
|
||||
|
||||
* Just visit [http://localhost:8000](http://localhost:8000) in your browser and start moving some data!
|
||||
|
||||
@@ -124,7 +124,7 @@ For security reasons, we strongly recommend to not expose Airbyte publicly. Futu
|
||||
|
||||
```bash
|
||||
# In your workstation terminal
|
||||
gcloud --project=$PROJECT_ID beta compute ssh airbyte -- -L 8000:localhost:8000 -L 8001:localhost:8001 -N -f
|
||||
gcloud --project=$PROJECT_ID beta compute ssh airbyte -- -L 8000:localhost:8000 -N -f
|
||||
```
|
||||
|
||||
* Just visit [http://localhost:8000](http://localhost:8000) in your browser and start moving some data!
|
||||
|
||||
@@ -28,7 +28,7 @@ All commands should be run from the root Airbyte source directory.
|
||||
* Latest stable version
|
||||
1. Apply with `kubectl apply -k kube/overlays/stable`
|
||||
3. Wait for pods to be "Running" on `kubectl get pods | grep airbyte`
|
||||
4. Run `kubectl port-forward svc/airbyte-server-svc 8001:8001` in a new terminal window.
|
||||
4. Run `kubectl port-forward svc/airbyte-server-svc 8000:8000` in a new terminal window.
|
||||
* This exposes `airbyte-server`, the Airbyte api server.
|
||||
* If you redeploy `airbyte-server`, you will need to re-run this process.
|
||||
5. Run `kubectl port-forward svc/airbyte-webapp-svc 8000:80` in a new terminal window.
|
||||
|
||||
@@ -92,19 +92,19 @@ If you prefer to import and export your data via API instead the UI, follow thes
|
||||
1. Instead of Step 3 above use the following curl command to export the archive:
|
||||
|
||||
```bash
|
||||
curl -H "Content-Type: application/json" -X POST localhost:8001/api/v1/deployment/export --output /tmp/airbyte_archive.tar.gz
|
||||
curl -H "Content-Type: application/json" -X POST localhost:8000/api/v1/deployment/export --output /tmp/airbyte_archive.tar.gz
|
||||
```
|
||||
|
||||
2. Instead of Step X above user the following curl command to import the migrated archive:
|
||||
|
||||
```bash
|
||||
curl -H "Content-Type: application/x-gzip" -X POST localhost:8001/api/v1/deployment/import --data-binary @<path to arhive>
|
||||
curl -H "Content-Type: application/x-gzip" -X POST localhost:8000/api/v1/deployment/import --data-binary @<path to arhive>
|
||||
```
|
||||
|
||||
Here is an example of what this request might look like assuming that the migrated archive is called `airbyte_archive_migrated.tar.gz` and is in the `/tmp` directory.
|
||||
|
||||
```bash
|
||||
curl -H "Content-Type: application/x-gzip" -X POST localhost:8001/api/v1/deployment/import --data-binary @/tmp/airbyte_archive_migrated.tar.gz
|
||||
curl -H "Content-Type: application/x-gzip" -X POST localhost:8000/api/v1/deployment/import --data-binary @/tmp/airbyte_archive_migrated.tar.gz
|
||||
```
|
||||
|
||||
## Upgrading \(K8s\)
|
||||
|
||||
@@ -8,7 +8,7 @@ WORKSPACE_ROOT=/workspace
|
||||
DATA_DOCKER_MOUNT=airbyte_data
|
||||
DB_DOCKER_MOUNT=airbyte_db
|
||||
WORKSPACE_DOCKER_MOUNT=airbyte_workspace
|
||||
API_URL=
|
||||
API_URL=/api/v1/
|
||||
WEBAPP_URL=airbyte-webapp-svc:80
|
||||
TRACKING_STRATEGY=logging
|
||||
WORKER_ENVIRONMENT=kubernetes
|
||||
|
||||
@@ -8,7 +8,7 @@ WORKSPACE_ROOT=/workspace
|
||||
DATA_DOCKER_MOUNT=airbyte_data
|
||||
DB_DOCKER_MOUNT=airbyte_db
|
||||
WORKSPACE_DOCKER_MOUNT=airbyte_workspace
|
||||
API_URL=
|
||||
API_URL=/api/v1/
|
||||
WEBAPP_URL=airbyte-webapp-svc:80
|
||||
TRACKING_STRATEGY=segment
|
||||
WORKER_ENVIRONMENT=kubernetes
|
||||
|
||||
Reference in New Issue
Block a user