Organization
Before you begin, this documentation assumes the following:
- You have a created an account.
An organization is a shared account where developers can collaborate across many projects at once. Owners and organization administrators can manage:
- cloud accounts.
- members access.
- the billing.
Creating an Organization
When signing up for Qovery, you need to create an organization. You can choose between 4 plans: Free, Professional, Business and Enterprise:
For more information, see our pricing page.
Once you have chosen a plan, you need to sign in through your Git provider (Github, Gitlab or Bitbucket). Your organization is then created.
To manage your organization settings from the Qovery Console, click the cogwheel icon on the top right of the screen:
In the General Information
tab:
- Company name: enter the name of your company.
- Description: enter a description of your organization.
- Website: enter the website of your company.
- Admin contact emails: enter one or several email adresses (separated by commas) on which you want to receive important communications from Qovery.
Don't forget to click Update
to save your organization information!
Managing your clusters
With Qovery, you can manage multiple clusters in your organizations settings. You can then deploy your project environments and services to the cluster of your choice.
In the settings of your organization, you can add, stop and delete a cluster, as well as update its settings.
For more information, see Clusters.
What is the default cluster?
The default cluster is the first cluster you installed in your organization.
When you create a new environment and leave the mode
and cluster
parameters set to the value Automatic
, your environment is deployed to:
- the cluster defined in one of your project rules,
- or to the default cluster if no project rule applies.
For more information on deployment rules, see Project.
Organization members
You can invite someone to join your organization by email. Then he will get access to your projects and will be able to contribute.
Roles
Four roles within an organization exist:
Action | Owner | Admin | Developer | Viewer |
---|---|---|---|---|
Read organization | yes | yes | no | no |
Edit organization | yes | yes | no | no |
Delete organization | yes | no | no | no |
Manage billing | yes | yes | no | no |
Invite members | yes | yes | no | no |
Connect to Kubernetes cluster | yes | yes | no | no |
Read project | yes | yes | yes | yes |
Edit project | yes | yes | yes | no |
Delete project | yes | yes | no | no |
Read environment | yes | yes | yes | yes |
Edit production environment | yes | yes | no | no |
Edit development environment | yes | yes | yes | no |
Stop production environment | yes | yes | no | no |
Stop development environment | yes | yes | yes | no |
Delete production environment | yes | yes | no | no |
Delete development environment | yes | yes | yes | no |
Read application | yes | yes | yes | yes |
Edit production application | yes | yes | no | no |
Edit development application | yes | yes | yes | no |
Delete production application | yes | yes | no | no |
Delete development application | yes | yes | yes | no |
Connect via SSH to an application | yes | yes | no | no |
Read database | yes | yes | yes | no |
Edit production database | yes | yes | no | no |
Edit development database | yes | yes | yes | no |
Delete production database | yes | yes | no | no |
Delete development database | yes | yes | yes | no |
Change an Organization
As a user, you can have access to one or many organizations. Use the dropdown in the top right navbar to change your organization.
Delete an Organization
To delete your organization, you need to go into the Danger Zone within your organization settings.
Managing Git Permissions Using the Qovery Github App
When you first sign into the Qovery Console, you need to provide your Git provider account credentials. This allows you to later take advantage of a Single Sign-On process through your Git provider. However, by default, Qovery is then allowed to access all the resources stored on your Git provider account.
For better control, as a Github user, you can install the Qovery Github App, and define which Github repositories Qovery can access.
Installing the Qovery Github App
To install the Qovery Github App:
Open your Qovery Console and access your organization settings:
test
In the
Organization settings
menu, clickGit Permission
:Below your Git provider account click
Install Github Application to manage permission
:A new window opens in your browser so you can install the Qovery Github App on your Github account.
Click the Github account on which you want to install the Qovery Github App:
Click
Only select repositories
and, in the dropdown menu, define which Github repositories you want to give Qovery access to:To confirm, click
Install & Authorize
:You are redirected to your Qovery Console, where the list of authorized Github repositories is updated.
Managing the Github permissions
To add or remove access to one of your repositories:
Open your Qovery Console and access your organization settings:
In the
Organization settings
menu, clickGit Permission
:Next to your Git provider account, click
Manage permission
:Click the Github account on which you want to manage the Qovery Github App access:
Add or remove the repositories you want to give Qovery access to:
Uninstalling the Qovery Github App
To uninstall the Qovery Github App:
Open your Qovery Console and access your organization settings:
In the
Organization settings
menu, clickGit Permission
:Next to your Git provider account, click
Disconnect
:The list of authorized Github repositories is updated, meaning Qovery now has access to all of your Github repositories again.
From your browser, access your Github account and open your
Settings
:In the navigation menu, click
Applications
:At the bottom of the page, click
Uninstall
:A confirmation pop-up window opens.
Click
OK
:The Qovery Github App is uninstalled.