Skip to content

Commit

Permalink
Merge pull request #2229 from strapi/cloud/multi-env
Browse files Browse the repository at this point in the history
Strapi Cloud: Multi-Environments documentation & updates
  • Loading branch information
meganelacheny committed Sep 25, 2024
2 parents e4f9dd0 + 3e1948f commit 1fa9e6d
Show file tree
Hide file tree
Showing 45 changed files with 306 additions and 199 deletions.
8 changes: 0 additions & 8 deletions docusaurus/docs/cloud/advanced/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,6 @@ To ensure a smooth deployment, it is recommended to not change the names of the

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.

<ThemedImage
alt="Deployment"
sources={{
light: '/img/assets/cloud/deploy-logs.png',
dark: '/img/assets/cloud/deploy-logs_DARK.png',
}}
/>

Once the application finishes building, the project will use the external database.

## Reverting to the default database
Expand Down
17 changes: 13 additions & 4 deletions docusaurus/docs/cloud/getting-started/usage-billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Strapi Cloud offers a free 14 days trial for all new accounts, and 3 paid plans:

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

:::strapi Additional information on usage and features
- General features & usage:
Expand All @@ -44,14 +45,22 @@ Strapi Cloud offers a free 14 days trial for all new accounts, and 3 paid plans:
- 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).
- 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).
- 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))
- 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).
- Cloud specific feature:
- Backups refers to the automatic backups of Strapi Cloud projects (see [Backups documentation](/cloud/projects/settings#backups) for more information on the feature).
- 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).
:::

## Environments management

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.

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.

## Seats management

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

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)).
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)).

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

Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/cloud/projects/collaboration.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ From the *Share [project name]* dialog accessible by clicking on the **Share** b
<ThemedImage
alt="Share button and avatar"
sources={{
light: '/img/assets/cloud/collaboration-dialog.png',
dark: '/img/assets/cloud/collaboration-dialog_DARK.png',
light: '/img/assets/cloud/collaboration-dialog2.png',
dark: '/img/assets/cloud/collaboration-dialog2_DARK.png',
}}
/>

Expand Down
29 changes: 14 additions & 15 deletions docusaurus/docs/cloud/projects/deploys-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ tags:

# Deploy history and logs

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.
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.

## Viewing deploy history

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

<ThemedImage
alt="Project deploys"
sources={{
light: '/img/assets/cloud/deploys.png',
dark: '/img/assets/cloud/deploys_DARK.png',
light: '/img/assets/cloud/overview.png',
dark: '/img/assets/cloud/overview_DARK.png',
}}
/>

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

## Accessing deployment details & logs

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.
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.

<ThemedImage
alt="Deployment details"
sources={{
light: '/img/assets/cloud/deploy-logs.png',
dark: '/img/assets/cloud/deploy-logs_DARK.png',
light: '/img/assets/cloud/deploy_logs.png',
dark: '/img/assets/cloud/deploy_logs_DARK.png',
}}
/>

In the *Deploy details* section of the *Log details* page is displayed the following information:
- *Status*, which can be *Building*, *Deploying*, *Done*, *Cancelled*, *Build failed*, or *Deploy failed*
- *Maintenance*: when the deployment occured
- *Deployed in*: the amount of time the deployment took
- *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
- *Branch*: the branch used for this deployment

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.
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.

:::tip
Click the ![Copy button](/img/assets/icons/duplicate.svg) **Copy to clipboard** button to copy the log contents.
:::

In the right side of the *Deployment details* page is also displayed the following information:
- *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
- *Status*, which can be *Building*, *Deploying*, *Done*, *Cancelled*, *Build failed*, or *Deploy failed*
- *Source*: the branch and commit message for this deployment
- *Duration*: the amount of time the deployment took and when it occured
8 changes: 4 additions & 4 deletions docusaurus/docs/cloud/projects/deploys.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Ongoing deployments can also be [manually cancelled](#cancelling-a-deployment) i

## Triggering a new deployment

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)).
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)).

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

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

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

:::tip
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.
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.
:::

<ThemedImage
Expand Down
45 changes: 22 additions & 23 deletions docusaurus/docs/cloud/projects/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ tags:
pagination_next: cloud/projects/settings
---

import ScreenshotNumberReference from '/src/components/ScreenshotNumberReference.jsx';

# Projects overview

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

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

## Accessing a project's overview

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.

:::strapi Navigating Strapi Cloud projects dashboards
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:
## Accessing a project's dashboard

- 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)
- 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))
- the **Trigger deploy** button to trigger a new deployment of your project
- the **Visit app** button to access your application
:::
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.

<ThemedImage
alt="Project overview"
sources={{
light: '/img/assets/cloud/overview.png',
dark: '/img/assets/cloud/overview_DARK.png',
light: '/img/assets/cloud/overview2.png',
dark: '/img/assets/cloud/overview2_DARK.png',
}}
/>

From the *Overview* tab, you can:
- view a recap of the main settings of your project, such as:
- the link to the source repository
- the name of the branch
- the name of the base directory
- the URL and link to the application
- view your project's usage (see [Usage](/cloud/getting-started/usage-billing) for more information)
- view your project's latest deploys (see [Deploys](/cloud/projects/deploys) for more information)
From the dashboard's header of a chosen project, you can:
- 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" />,
- 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" />,
- choose which environment to visualise for the project <ScreenshotNumberReference number="3" />,
- trigger a new deployment (see [Deployments management](/cloud/projects/deploys)) and visit your application <ScreenshotNumberReference number="4" />.

Your project's dashboard also displays:
- 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" />
- the project and environment details in a box on the right of the interface <ScreenshotNumberReference number="6" />, including:
- the number of API calls and database entries,
- the current usage for assets bandwidth and storage,
- 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)),
- the name of the base directory,
- the Strapi version number.

4 changes: 1 addition & 3 deletions docusaurus/docs/cloud/projects/runtime-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@ import NotV5 from '/docs/snippets/_not-updated-to-v5.md'

# Runtime logs

<NotV5/>

From a chosen project's dashboard, the *Runtime logs* tab, located in the header, displays the live logs of the project.
From a chosen project's dashboard, the *Runtime logs* tab displays the live logs of the project.

:::note
The *Runtime logs* are only accessible once the project is successfully deployed.
Expand Down
Loading

0 comments on commit 1fa9e6d

Please sign in to comment.