Skip to content

Commit 1fa9e6d

Browse files
Merge pull request #2229 from strapi/cloud/multi-env
Strapi Cloud: Multi-Environments documentation & updates
2 parents e4f9dd0 + 3e1948f commit 1fa9e6d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+306
-199
lines changed

docusaurus/docs/cloud/advanced/database.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,6 @@ To ensure a smooth deployment, it is recommended to not change the names of the
6262

6363
To deploy the project and utilize the external database, push the changes from earlier. This will trigger a rebuild and new deployment of the Strapi Cloud project.
6464

65-
<ThemedImage
66-
alt="Deployment"
67-
sources={{
68-
light: '/img/assets/cloud/deploy-logs.png',
69-
dark: '/img/assets/cloud/deploy-logs_DARK.png',
70-
}}
71-
/>
72-
7365
Once the application finishes building, the project will use the external database.
7466

7567
## Reverting to the default database

docusaurus/docs/cloud/getting-started/usage-billing.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Strapi Cloud offers a free 14 days trial for all new accounts, and 3 paid plans:
1919

2020
| Feature | Free Trial | Developer | Pro | Team |
2121
| --- | --- | --- | --- | --- |
22-
| **Seats** | 10 | 1 | 5 | 10 |
22+
| **Seats** | 10 (up to 10 extra) | 1 (up to 3 extra) | 5 (up to 20 extra) | 10 (up to 50 extra) |
2323
| **Database Entries** | 1,000 | 1,000 | 100,000 | 1,000,000 |
2424
| **Assets Storage** | 5GB | 15GB | 150GB | 500GB |
2525
| **Assets Bandwidth** | 50GB | 50GB per month | 500GB per month | 1,000GB per month |
@@ -30,7 +30,8 @@ Strapi Cloud offers a free 14 days trial for all new accounts, and 3 paid plans:
3030
| **Review Workflows** | up to 2 | N/A | N/A | up to 2 |
3131
| **Content History** | 14 days retention | N/A | 14 days retention | 90 days retention |
3232
| | | | | |
33-
| **Backups** | N/A | N/A | Weekly | Weekly |
33+
| **Backups** | N/A | N/A | Weekly | Daily |
34+
| **Environments** | N/A | N/A | 0 included (up to 99 extra) | 1 included (up to 99 extra) |
3435

3536
:::strapi Additional information on usage and features
3637
- General features & usage:
@@ -44,14 +45,22 @@ Strapi Cloud offers a free 14 days trial for all new accounts, and 3 paid plans:
4445
- Releases refers to the maximum number of pending releases that can be created (see [Releases in User Guide](/user-docs/releases/introduction) for more information).
4546
- Review Workflows refers to the maximum number of workflows that can be created and used (see [Review Workflows in User Guide](/user-docs/settings/review-workflows) for more information).
4647
- Content History refers to the maximum numbers of days kept in history (see [Content History in User Guide](/user-docs/content-manager/working-with-content-history))
47-
- Cloud specific feature: Backups refers to the automatic backups of Strapi Cloud projects (see [dedicated page in Cloud documentation](/cloud/projects/settings#backups) for more information).
48+
- Cloud specific feature:
49+
- Backups refers to the automatic backups of Strapi Cloud projects (see [Backups documentation](/cloud/projects/settings#backups) for more information on the feature).
50+
- Environments refers to the number of environments included in the plan on top of the default production environment (see [Environments](/cloud/projects/settings#environments--) documentation for more information on the feature).
4851
:::
4952

53+
## Environments management
54+
55+
Environments are isolated instances of your Strapi Cloud project. All projects have a default production environment, but other additional environments can be configured for projects on a Pro or Team plan, from the *Environments* tab of a project's settings (see [Environments](/cloud/projects/settings#environments--)). There is no limit to the number of additional environments that can be configured for a Strapi Cloud project.
56+
57+
The usage limits of additional environments are the same as for the project's production environment (e.g. an additional environment on the Pro plan will be limited at 150GB for assets storage, and overages will be charged the same way as for the production environment). Note however that the assets bandwidth and API calls are project-based, not environment-based, so these usage limits do not change even with additional environments.
58+
5059
## Seats management
5160

5261
Seats represent the maximum number of users that can access the Strapi admin panel. Each plan comes with a default number of seats.
5362

54-
You can add more seats either by upgrading to a higher plan, or manually adding individual seats as desired. Seats can be added from the **Billing & Usage** tab of a project's settings (see [Managing project's number of seats](/cloud/projects/settings#managing-projects-number-of-seats)).
63+
You can add more seats either by upgrading to a higher plan, or manually adding individual seats as desired. Seats can be added from the ![Billing & Usage icon](/img/assets/icons/CreditCard.svg) *Billing & Usage* tab of a project's settings (see [Managing project's number of seats](/cloud/projects/settings#managing-projects-number-of-seats)).
5564

5665
There is however a maximum number of seats that can be added per plan:
5766

docusaurus/docs/cloud/projects/collaboration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ From the *Share [project name]* dialog accessible by clicking on the **Share** b
5353
<ThemedImage
5454
alt="Share button and avatar"
5555
sources={{
56-
light: '/img/assets/cloud/collaboration-dialog.png',
57-
dark: '/img/assets/cloud/collaboration-dialog_DARK.png',
56+
light: '/img/assets/cloud/collaboration-dialog2.png',
57+
dark: '/img/assets/cloud/collaboration-dialog2_DARK.png',
5858
}}
5959
/>
6060

docusaurus/docs/cloud/projects/deploys-history.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ tags:
1414

1515
# Deploy history and logs
1616

17-
For each Strapi Cloud project, you can access the history of all deployments that occured and their details including build and deploy logs. This information is available in the *Deploys* tab, located in the header of any chosen project.
17+
For each Strapi Cloud project, you can access the history of all deployments that occured and their details including build and deploy logs. This information is available in the *Deployments* tab.
1818

1919
## Viewing deploy history
2020

21-
In the *Deploys* tab is displayed a chronological list of cards with the details of all historical deployments for your project.
21+
In the *Deployments* tab is displayed a chronological list of cards with the details of all historical deployments for your project.
2222

2323
<ThemedImage
2424
alt="Project deploys"
2525
sources={{
26-
light: '/img/assets/cloud/deploys.png',
27-
dark: '/img/assets/cloud/deploys_DARK.png',
26+
light: '/img/assets/cloud/overview.png',
27+
dark: '/img/assets/cloud/overview_DARK.png',
2828
}}
2929
/>
3030

@@ -41,25 +41,24 @@ Each card displays the following information:
4141

4242
## Accessing deployment details & logs
4343

44-
From the *Deploys* tab, you can click on the ![See logs button](/img/assets/icons/Eye.svg) **See logs** button of any chosen deployment card to be redirected to the *Log details*. It contains the deployment's details logs.
44+
From the *Deployments* tab, you can hover a deployment card to make the ![See logs button](/img/assets/icons/Eye.svg) **Show details** button appear. Clicking on this button will redirect you to the *Deployment details* page which contains the deployment's detailed logs.
4545

4646
<ThemedImage
4747
alt="Deployment details"
4848
sources={{
49-
light: '/img/assets/cloud/deploy-logs.png',
50-
dark: '/img/assets/cloud/deploy-logs_DARK.png',
49+
light: '/img/assets/cloud/deploy_logs.png',
50+
dark: '/img/assets/cloud/deploy_logs_DARK.png',
5151
}}
5252
/>
5353

54-
In the *Deploy details* section of the *Log details* page is displayed the following information:
55-
- *Status*, which can be *Building*, *Deploying*, *Done*, *Cancelled*, *Build failed*, or *Deploy failed*
56-
- *Maintenance*: when the deployment occured
57-
- *Deployed in*: the amount of time the deployment took
58-
- *Commit*: the commit SHA <Annotation>💡 The commit SHA (or hash) is the unique ID of your commit, which refers to a specific change that was made at a specific time.</Annotation>, with a direct link to your git provider, and commit message used for this deployment
59-
- *Branch*: the branch used for this deployment
60-
61-
In the *Logs* section of the *Log details* page you can click on the arrow buttons ![Down arrow](/img/assets/icons/ONHOLDCarretDown.svg) ![Up arrow](/img/assets/icons/ONHOLDCarretUp.svg) to show or hide the build and deploy logs of the deployment.
54+
In the *Build logs* and *Deployment logs* sections of the page you can click on the arrow buttons ![Down arrow](/img/assets/icons/ONHOLDCarretDown.svg) ![Up arrow](/img/assets/icons/ONHOLDCarretUp.svg) to show or hide the build and deployment logs of the deployment.
6255

6356
:::tip
6457
Click the ![Copy button](/img/assets/icons/duplicate.svg) **Copy to clipboard** button to copy the log contents.
6558
:::
59+
60+
In the right side of the *Deployment details* page is also displayed the following information:
61+
- *Commit*: the commit SHA <Annotation>💡 The commit SHA (or hash) is the unique ID of your commit, which refers to a specific change that was made at a specific time.</Annotation>, with a direct link to your git provider, and commit message used for this deployment
62+
- *Status*, which can be *Building*, *Deploying*, *Done*, *Cancelled*, *Build failed*, or *Deploy failed*
63+
- *Source*: the branch and commit message for this deployment
64+
- *Duration*: the amount of time the deployment took and when it occured

docusaurus/docs/cloud/projects/deploys.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Ongoing deployments can also be [manually cancelled](#cancelling-a-deployment) i
2424

2525
## Triggering a new deployment
2626

27-
To manually trigger a new deployment for your project, click on the **Trigger deploy** button always displayed in the right corner of a project dashboard's header. This action will add a new card in the *Deploys* tab, where you can monitor the status and view the deployment logs live (see [Deploy history and logs](/cloud/projects/deploys-history)).
27+
To manually trigger a new deployment for your project, click on the **Trigger deployment** button always displayed in the right corner of a project dashboard's header. This action will add a new card in the *Deployments* tab, where you can monitor the status and view the deployment logs live (see [Deploy history and logs](/cloud/projects/deploys-history)).
2828

2929
<ThemedImage
3030
alt="Triggering new deploy"
@@ -38,11 +38,11 @@ To manually trigger a new deployment for your project, click on the **Trigger de
3838

3939
If for any reason you want to cancel an ongoing and unfinished deployment:
4040

41-
1. Go to the *Log details* page of the deployment (see [Accessing log details](/cloud/projects/deploys-history#accessing-deployment-details--logs)).
42-
2. Click on the **Cancel deploy** button in the top right corner. The status of the deployment will automatically change to *Cancelled*.
41+
1. Go to the *Deployment details* page of the latest triggered deployment (see [Accessing log details](/cloud/projects/deploys-history#accessing-deployment-details--logs)).
42+
2. Click on the **Cancel deployment** button in the top right corner. The status of the deployment will automatically change to *Cancelled*.
4343

4444
:::tip
45-
You can also cancel a deployment from the *Deploys* tab which lists the deployments history. The card of ongoing deployment with the *Building* status will display a **Cancel deploy** button.
45+
You can also cancel a deployment from the *Deployments* tab which lists the deployments history. The card of ongoing deployment with the *Building* status will display a ![Cancel button](/img/assets/icons/clear.svg) button for cancelling the deployment.
4646
:::
4747

4848
<ThemedImage

docusaurus/docs/cloud/projects/overview.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ tags:
1010
pagination_next: cloud/projects/settings
1111
---
1212

13+
import ScreenshotNumberReference from '/src/components/ScreenshotNumberReference.jsx';
14+
1315
# Projects overview
1416

1517
The *Projects* page displays a list of all your Strapi Cloud projects. From here you can manage your projects and access the corresponding applications.
@@ -29,39 +31,36 @@ Each project card displays the following information:
2931
* *Disconnected*, if the project repository is not connected to Strapi Cloud
3032
* *Suspended*, if the project has been suspended (refer to [Project suspension](/cloud/getting-started/usage-billing#project-suspension) to reactivate the project)
3133
* *Incompatible version*, if the project is using a Strapi version that is not compatible with Strapi Cloud
32-
* the last deployment date
3334

3435
Each project card also displays a ![Menu icon](/img/assets/icons/more.svg) menu icon to access the following options:
3536
* **Visit App**: to be redirected to the application
36-
* **Go to Deploys**: to be redirected to the [*Deploys*](/cloud/projects/deploys) page
37+
* **Go to Deployments**: to be redirected to the [*Deploys*](/cloud/projects/deploys) page
3738
* **Go to Settings**: to be redirected to the [*Settings*](/cloud/projects/settings) page
3839

39-
## Accessing a project's overview
40-
41-
From the *Projects* page, click on any project card to access the *Overview* of your project. It displays all details such as usage and status information and gives access to deployment history and available settings.
42-
43-
:::strapi Navigating Strapi Cloud projects dashboards
44-
Once you click on a project page, you access the dedicated dashboard for your chosen project. It is by default that you land on the *Overview* tab, however the header of the project's dashboard doesn't change and always offers the following options:
40+
## Accessing a project's dashboard
4541

46-
- links to the other available tabs for the project: *Overview*, [*Deploys*](/cloud/projects/deploys), [*Runtime Logs*](/cloud/projects/runtime-logs) and [*Settings*](/cloud/projects/settings)
47-
- the **Share** button to invite a new maintainer to collaborate on your project — and if the project is already shared: avatars of the maintainers (see [Collaboration](/cloud/projects/collaboration))
48-
- the **Trigger deploy** button to trigger a new deployment of your project
49-
- the **Visit app** button to access your application
50-
:::
42+
From the *Projects* page, click on any project card to access is dashboard. It displays the project and environment details and gives access to the deployment history and all available settings.
5143

5244
<ThemedImage
5345
alt="Project overview"
5446
sources={{
55-
light: '/img/assets/cloud/overview.png',
56-
dark: '/img/assets/cloud/overview_DARK.png',
47+
light: '/img/assets/cloud/overview2.png',
48+
dark: '/img/assets/cloud/overview2_DARK.png',
5749
}}
5850
/>
5951

60-
From the *Overview* tab, you can:
61-
- view a recap of the main settings of your project, such as:
62-
- the link to the source repository
63-
- the name of the branch
64-
- the name of the base directory
65-
- the URL and link to the application
66-
- view your project's usage (see [Usage](/cloud/getting-started/usage-billing) for more information)
67-
- view your project's latest deploys (see [Deploys](/cloud/projects/deploys) for more information)
52+
From the dashboard's header of a chosen project, you can:
53+
- use the **Share** button to invite users to collaborate on the project (see [Collaboration](/cloud/projects/collaboration)) and see the icons of those who have already been invited <ScreenshotNumberReference number="1" />,
54+
- use the ![Settings icon](/img/assets/icons/settings.svg) **Settings** button to access the settings of the project and its existing environments <ScreenshotNumberReference number="2" />,
55+
- choose which environment to visualise for the project <ScreenshotNumberReference number="3" />,
56+
- trigger a new deployment (see [Deployments management](/cloud/projects/deploys)) and visit your application <ScreenshotNumberReference number="4" />.
57+
58+
Your project's dashboard also displays:
59+
- the *Deployments* and *Runtime logs* tabs, to see the deployments history (more details in [Deploy history and logs](/cloud/projects/deploys-history)) and the runtime logs of the project (see [dedicated documentation page](/cloud/projects/runtime-logs)) <ScreenshotNumberReference number="5" />
60+
- the project and environment details in a box on the right of the interface <ScreenshotNumberReference number="6" />, including:
61+
- the number of API calls and database entries,
62+
- the current usage for assets bandwidth and storage,
63+
- the name of the branch and a **Manage** button to be redirect to the branch settings (see [Modifying git repository & branch](/cloud/projects/settings#modifying-git-repository--branch)),
64+
- the name of the base directory,
65+
- the Strapi version number.
66+

docusaurus/docs/cloud/projects/runtime-logs.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ import NotV5 from '/docs/snippets/_not-updated-to-v5.md'
1313

1414
# Runtime logs
1515

16-
<NotV5/>
17-
18-
From a chosen project's dashboard, the *Runtime logs* tab, located in the header, displays the live logs of the project.
16+
From a chosen project's dashboard, the *Runtime logs* tab displays the live logs of the project.
1917

2018
:::note
2119
The *Runtime logs* are only accessible once the project is successfully deployed.

0 commit comments

Comments
 (0)