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

Making single port 8000 default and update NetworkErrorBoundary #3656

Merged
merged 5 commits into from
Jun 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .env
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion .env.dev
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions airbyte-api/src/main/openapi/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/deploying-airbyte/on-aws-ec2.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,15 +110,15 @@ 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.
{% endhint %}

```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!
Expand Down
4 changes: 2 additions & 2 deletions docs/deploying-airbyte/on-azure-vm-cloud-shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
2 changes: 1 addition & 1 deletion docs/deploying-airbyte/on-gcp-compute-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
2 changes: 1 addition & 1 deletion docs/deploying-airbyte/on-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/upgrading-airbyte.md
Original file line number Diff line number Diff line change
Expand Up @@ -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\)
Expand Down
2 changes: 1 addition & 1 deletion kube/overlays/dev/.env
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion kube/overlays/stable/.env
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down