You have created a Project.
Create an environment
The first time you create a project, you need to add your first environment manually.
Give a name to your environment that is easily recognizable by anyone from your team.
When you start using Qovery heavily, your environment list can look like this
An Environment can be automatically created when you create Pull Requests, and Git Branches. See the Deployment Rule section below.
Use Preview Environment to get early feedback on your application changes.
The purpose of an Environment is to manage a bunch of applications that are working all together. Your production environment runs 24/7, where your other environments may not need to run all day long. E.g. you may need to run Environments to get early feedback on your application changes before the changes are merged into production. This is what we call Preview Environment.
Creating a Preview Environment is similar to create a casual Environment.
Build and Deployment logs
Sometimes, you need to have a closer look on what is going on while an operation (see statuses below) is in progress.
Click on the
show logs button to watch your deployment logs in real-time.
Cloning an environment is possible if you want to create an Environment from another one.
Environment clone is convenient for those use cases:
- Make a demo without impacting the original Environment.
- Validating a feature that needs to reflect the original Environment.
Types of environment
Two modes are possible for an Environment -
development. The difference between the
development modes are the permissions. Read more.
|production||this environment mode protects from destructive actions and get access to sensitive information - only possible by an admin|
|development||this environment mode makes it easy to destroy an environment - possible by an admin and developer|
To know more about the permissions - go to the Organization configuration.
Here is the mode you should set depending on your Environment.
|environment type||recommended mode||why|
|production||production||Production environment should not be stopped or deleted by anyone - so to protect it we recommend using |
|staging||production||Staging environment reflects how things work and is sometimes as critical as production for companies. Using |
|feature||development||Feature environment is a working environment that could be stopped and deleted by anyone. It is not "business critical" and can be set in |
|fix||development||Fix environment is similar to a Feature environment. It is not "business critical" and can be set in |
It is possible to go beyond than the basic configuration for an Environment. Here is a list of advanced features available for your environments.
An Environment is a machine-state. Here is a list of the different statuses that your Environment can get.
|READY||Your environment has been initialized and is ready to received its first applications|
|QUEUED||A deployment task has been received and your environment is about deploying it. The task has been queued and can take some times to be processed.|
|BUILDING||The build of one or several application(s) of your environment is in progress|
|BUILD_ERROR||Something goes wrong during the build of your applications or databases|
|BUILT||One or several application(s) of your environment are built|
|DEPLOYING||The deployment of one or several application(s) of your environment is in progress|
|DEPLOYMENT_ERROR||Something goes wrong during the deployment of your applications or databases|
|DEPLOYED||One or several application(s) of your environment are deployed|
|STOPPING||The shutdown of one or several application(s) of your environment is in progress|
|STOP_ERROR||Something goes wrong during the shutdown of your applications or databases|
|STOPPED||One or several application(s) of your environment are stopped|
|DELETING||The deletion of one or several application(s) of your environment is in progress|
|DELETE_ERROR||Something goes wrong during the deletion of your applications or databases|
|DELETED||One or several application(s) of your environment are deleted|
|RUNNING||Your applications and databases are running|
|RUNNING_ERROR||Something goes wrong during the run of your applications|
The Deployment Rules lets you configure the lifecycle of your Environments.
Refer to the Deployment Rule documentation to know more.
Delete an environment
To delete your environment, you must go in the
general and delete your Environment.