Skip to content

Commit

Permalink
feat: add qovery cli port forward limitation informations
Browse files Browse the repository at this point in the history
  • Loading branch information
deimosfr committed Jan 22, 2025
1 parent 4a7e18c commit 2f05938
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
15 changes: 11 additions & 4 deletions website/docs/using-qovery/interface/cli.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_modified_on: "2025-01-17"
last_modified_on: "2025-01-22"
title: CLI
description: How to use the Qovery CLI (Command Line Interface)
---
Expand Down Expand Up @@ -482,9 +482,16 @@ The port-forward feature works with any `application`, `Cronjob`, `Lifecycle job

Im this example, you can now connect on `http://localhost:8000` to access your application.

<Alert type="info">
<Alert type="warning">

Qovery port-forward limitations:

* The connection time is limited to 30s of inactivity for the first message or the connection will be closed.
* The total connection time is limited to 1h of activity. After that, the connection will be closed.
* The maximum size of data transferred is 1GB. Above that size, the connection will be closed.

For `Managed database` instances on AWS, once the port-forwarded is activated, you must specify ~ `--tls` and `--tls-insecure` **in your database connection** command since localhost is not the valid hostname.
If you want to bypass those limitations, you need to have an access to the Kubernetes cluster directly. Then use [Kubernetes dedicated port-forward mechanism](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/)
(you can use `qovery cluster kubeconfig --cluster-id xxxx` to get your kubeconfig).

</Alert>

Expand All @@ -497,7 +504,7 @@ $ qovery port-forward -p 8000:80 -pod app-5f65fb5c4-frontend-5f65db5c4b-q4w11
```
NOTE: you can get the list of pods by running the `qovery list-pods` command.

### Port-forward a dedicated managed database
### Port-forward on a managed database

Before connecting to your database, it is important to review the requirements from the Cloud Provider's documentation. A common mistake is to overlook this documentation, which can lead to hours of troubleshooting.

Expand Down
13 changes: 10 additions & 3 deletions website/docs/using-qovery/interface/cli.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -317,9 +317,16 @@ The port-forward feature works with any `application`, `Cronjob`, `Lifecycle job

Im this example, you can now connect on `http://localhost:8000` to access your application.

<Alert type="info">
<Alert type="warning">

Qovery port-forward limitations:

* The connection time is limited to 30s of inactivity for the first message or the connection will be closed.
* The total connection time is limited to 1h of activity. After that, the connection will be closed.
* The maximum size of data transferred is 1GB. Above that size, the connection will be closed.

For `Managed database` instances on AWS, once the port-forwarded is activated, you must specify ~ `--tls` and `--tls-insecure` **in your database connection** command since localhost is not the valid hostname.
If you want to bypass those limitations, you need to have an access to the Kubernetes cluster directly. Then use [Kubernetes dedicated port-forward mechanism](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/)
(you can use `qovery cluster kubeconfig --cluster-id xxxx` to get your kubeconfig).

</Alert>

Expand All @@ -332,7 +339,7 @@ $ qovery port-forward -p 8000:80 -pod app-5f65fb5c4-frontend-5f65db5c4b-q4w11
```
NOTE: you can get the list of pods by running the `qovery list-pods` command.

### Port-forward a dedicated managed database
### Port-forward on a managed database

Before connecting to your database, it is important to review the requirements from the Cloud Provider's documentation. A common mistake is to overlook this documentation, which can lead to hours of troubleshooting.

Expand Down

0 comments on commit 2f05938

Please sign in to comment.