Skip to content

Commit

Permalink
Merge pull request #382 from Qovery/chore/misc_updates_01_2024
Browse files Browse the repository at this point in the history
Update misc docs
  • Loading branch information
jul-dan authored Feb 14, 2024
2 parents 520eaf2 + e10b566 commit fb63f58
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 52 deletions.
8 changes: 7 additions & 1 deletion website/docs/using-qovery/configuration/application.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_modified_on: "2024-01-17"
last_modified_on: "2024-01-31"
title: "Application"
description: "Learn how to configure your Application on Qovery"
---
Expand Down Expand Up @@ -76,12 +76,18 @@ If you want to deploy an application from a Container Registry you will have to
- Image Entrypoint: the entrypoint to be used to launch your applicaiton (not mandatory)
- CMD Arguments: the arguments to be passed to launch your applicaiton (not mandatory). We expect the format to be an array. Example ["rails", "-h", "0.0.0.0", "-p", "8080", "string"]


<Alert type="info">

Make sure that the image tag used are unique (do not use "latest", "dev", "master" etc..), see [this section][docs.using-qovery.deployment.image-mirroring#why-unique-image-tags-are-necessary] for more information.

</Alert>

<Alert type="info">

If the base image in your Dockerfile is from a private registry, you just have to add the access to this registry before creating your application. See [Container Registry Management page][docs.using-qovery.configuration.organization.container-registry] for more information.

</Alert>

** Auto Deploy **

Expand Down
6 changes: 6 additions & 0 deletions website/docs/using-qovery/configuration/application.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,18 @@ If you want to deploy an application from a Container Registry you will have to
- Image Entrypoint: the entrypoint to be used to launch your applicaiton (not mandatory)
- CMD Arguments: the arguments to be passed to launch your applicaiton (not mandatory). We expect the format to be an array. Example ["rails", "-h", "0.0.0.0", "-p", "8080", "string"]


<Alert type="info">

Make sure that the image tag used are unique (do not use "latest", "dev", "master" etc..), see [this section][docs.using-qovery.deployment.image-mirroring#why-unique-image-tags-are-necessary] for more information.

</Alert>

<Alert type="info">

If the base image in your Dockerfile is from a private registry, you just have to add the access to this registry before creating your application. See [Container Registry Management page][docs.using-qovery.configuration.organization.container-registry] for more information.

</Alert>

** Auto Deploy **

Expand Down
26 changes: 1 addition & 25 deletions website/docs/using-qovery/configuration/helm.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_modified_on: "2024-01-17"
last_modified_on: "2024-01-31"
title: "Helm"
description: "Learn how to configure your Helm on Qovery"
---
Expand Down Expand Up @@ -119,30 +119,6 @@ Add a new variable by declaring:

</Alert>

</li>
<li>

You can now expose publicly one or more ports for your services defined in the helm chart by specifying:
- Service name: this is the kubernetes service name in your helm chart
- Namespace (only if Allow cluster-wide resources was enabled): this is the kubernetes namespace used by your helm chart to deploy the pods behind the chosen service
- Service port: this is the port exposed internally by your service
- Protocol: you can select the protocol used by your service. Today Qovery supports the following protocols:
- HTTPS (Select this protocol if you need to run Websockets)
- gRPC
- External port: it is the port that can be used to access this service over the internet (when exposed publicly). Note that for HTTP and gRPC the port is set by default to 443.
- Port Name: it is the name assigned to the port. When multiple ports are exposed publicly, its value is used to route the traffic to the right port based on the called subdomain (which will contain the port name value). Since each port is exposed on the port 443, having a different subdomain is the only way to have multiple ports exposed over the internet. If not set, the default value is `p<portNumber>` (see [Qovery Provided Domain section](#qovery-provided-domains) for more information)

By default services are accessible only from inside your namespace(s). You can expose them publicly, making them accessible over the public network via a dedicated public domain that will be assigned to your application by Qovery during the deployment (See the [Qovery Provided Domains section](#qovery-provided-domains)). Note that HTTPS/gRPC ports are always exposed over the port 443.

<p align="center">
<img src="/img/configuration/helm/helm_creation_port.png" alt="Helm Ports" />
</p>


**Important Informations**

- Connections on public ports are automatically closed after 60 seconds. If you want to implement long living connection (like for websockets) please make sure to use the rigth ingress timeouts in the [advanced settings section][docs.using-qovery.configuration.advanced-settings#network-settings]

</li>

<li>
Expand Down
24 changes: 0 additions & 24 deletions website/docs/using-qovery/configuration/helm.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -107,30 +107,6 @@ Add a new variable by declaring:

</Alert>

</li>
<li>

You can now expose publicly one or more ports for your services defined in the helm chart by specifying:
- Service name: this is the kubernetes service name in your helm chart
- Namespace (only if Allow cluster-wide resources was enabled): this is the kubernetes namespace used by your helm chart to deploy the pods behind the chosen service
- Service port: this is the port exposed internally by your service
- Protocol: you can select the protocol used by your service. Today Qovery supports the following protocols:
- HTTPS (Select this protocol if you need to run Websockets)
- gRPC
- External port: it is the port that can be used to access this service over the internet (when exposed publicly). Note that for HTTP and gRPC the port is set by default to 443.
- Port Name: it is the name assigned to the port. When multiple ports are exposed publicly, its value is used to route the traffic to the right port based on the called subdomain (which will contain the port name value). Since each port is exposed on the port 443, having a different subdomain is the only way to have multiple ports exposed over the internet. If not set, the default value is `p<portNumber>` (see [Qovery Provided Domain section](#qovery-provided-domains) for more information)

By default services are accessible only from inside your namespace(s). You can expose them publicly, making them accessible over the public network via a dedicated public domain that will be assigned to your application by Qovery during the deployment (See the [Qovery Provided Domains section](#qovery-provided-domains)). Note that HTTPS/gRPC ports are always exposed over the port 443.

<p align="center">
<img src="/img/configuration/helm/helm_creation_port.png" alt="Helm Ports" />
</p>


**Important Informations**

- Connections on public ports are automatically closed after 60 seconds. If you want to implement long living connection (like for websockets) please make sure to use the rigth ingress timeouts in the [advanced settings section][docs.using-qovery.configuration.advanced-settings#network-settings]

</li>

<li>
Expand Down
10 changes: 9 additions & 1 deletion website/docs/using-qovery/interface/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,7 @@ If you get a 424 error while trying to create new applications from one of your

Check out our [API documentation][urls.qovery_swagger]

## Managing services and environments
## Managing services, environments and projects
The CLI allows you to manage and deploy the environment and services within your organization

### application, container, lifecycle, cronjob
Expand Down Expand Up @@ -622,6 +622,14 @@ APPLICATION | API gateway
Environment is deploying!
```

### Projects

You can list the organization's projects by using the following command:

```bash
qovery project list
```

## Managing the Deployment Pipeline

In the following sections we will describe how to modify the Deployment Pipeline.
Expand Down
10 changes: 9 additions & 1 deletion website/docs/using-qovery/interface/cli.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ If you get a 424 error while trying to create new applications from one of your

Check out our [API documentation][urls.qovery_swagger]

## Managing services and environments
## Managing services, environments and projects
The CLI allows you to manage and deploy the environment and services within your organization

### application, container, lifecycle, cronjob
Expand Down Expand Up @@ -445,6 +445,14 @@ APPLICATION | API gateway
Environment is deploying!
```

### Projects

You can list the organization's projects by using the following command:

```bash
qovery project list
```

## Managing the Deployment Pipeline

In the following sections we will describe how to modify the Deployment Pipeline.
Expand Down

0 comments on commit fb63f58

Please sign in to comment.