Skip to content

Commit

Permalink
Cloud docs (saleor#1294)
Browse files Browse the repository at this point in the history
* Create folder

* Add draft

* Fix links

* Remove features
  • Loading branch information
timuric authored Aug 22, 2024
1 parent 9d99b43 commit 51c4ec5
Show file tree
Hide file tree
Showing 9 changed files with 86 additions and 65 deletions.
58 changes: 0 additions & 58 deletions docs/cloud.mdx

This file was deleted.

41 changes: 41 additions & 0 deletions docs/cloud/environment.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Environment Management
---
### Production vs Sandbox

Unlike _Sandboxes_, the _Production_ environment doesn't have limitations on _rate limiting_ and resource usage, such as orders, API requests, products, etc.

The limits imposed on sandboxes are displayed in the Cloud Console.

### Snapshots

Database snapshots can be created and replicated from any sandbox or production environment, allowing staging environments to be created.

This feature enables productive workflows for development and testing, for example:

- Replicating the latest production data to a staging environment.
- Creating integration tests. You can create snapshots that would be used as a starting point for integration tests.
- Migration scripts. During the development of migration scripts, it might be desirable to do it in steps, where each successful step can be saved and reverted during the development of the next step.

Follow the quickstart guide to learn [how to use snapshots](/quickstart/cloud.mdx).

### Version upgrades

Saleor versions can be upgraded on demand via the console. Sequential upgrades (from one minor to the next minor) are backward compatible and do not require downtime. Thus, upgrades are never disruptive.

Each environment has independent version management, thus making it possible to test new features before production upgrades.

:::note
Projects without a production environment (aka free projects) automatically upgrade to the latest version. To disable automatic version upgrades of sandboxes, you would need to have a production instance in the same project.
:::


### Access Control

To control `Trusted client origins` and `Allowed API origins`, see the guide for [API access restriction](/cloud/restricting-api-access.mdx).


### Subdomain Management

Subdomains of your environments (e.g., `[your_subdomain].saleor.cloud`) can be changed of your instance on demand via console.

38 changes: 38 additions & 0 deletions docs/cloud/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Cloud Overview
sidebar_title: Overview
---

### Creating an Account

Saleor cloud provides free developer accounts for experimentation and development purposes.

Signup at [cloud.saleor.io](https://cloud.saleor.io/) to get started for free.

Sandboxes can be later promoted to production by adding credit card details.

### Organizations

Organizations allow to create multiple projects under the same billing account and invite staff members across all projects.
If you are not invited to an existing organization, open the [Saleor Cloud dashboard](https://cloud.saleor.io/) after registration. As every user must be assigned to an organization, you should see the organization creation form right away.

Access to organization and projects can be configured via SSO.

### Projects

Projects contains backend instances and have staff access control. Each project can have a single production environment and multiple developer environments called sandboxes.
Projects are meant to be treated as individual shops, where backup data and snapshots are meant to be interchangeable between environments. For example, you can create [snapshot](/cloud/environment.mdx#snapshots) of your production environment and restore it to the staging sandbox environment.

Each project is bound to a single AWS region.

### Environments

Environments aka backend can be either production (one per project) or sandboxes meant for development purposes. Learn more about [environments](/cloud/environment.mdx).


## Related Resources

- Cloud [Quickstart](/quickstart/cloud.mdx).
- Environment [management](/cloud/environment.mdx).

Have questions? Contact [our team](mailto:[email protected]).
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/developer/app-store/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This feature requires Saleor version **3.12**.

:::

Saleor App Store is a [Saleor Cloud](cloud.mdx) feature that provides an instantly installable collection of [apps](developer/app-store/apps/overview.mdx). Each app brings new functionality to Saleor, often by integrating with third-party services.
Saleor App Store is a [Saleor Cloud](/cloud/overview.mdx) feature that provides an instantly installable collection of [apps](developer/app-store/apps/overview.mdx). Each app brings new functionality to Saleor, often by integrating with third-party services.

You can find Saleor App Store under the _Apps_ tab in the Dashboard menu.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ If you haven't installed Saleor CLI, please head over to the [Saleor CLI documen

Before starting the development, please make sure you are logged in to your Saleor Cloud account.

If you have not set up your Saleor Cloud account yet, we suggest following the [Getting started](cloud.mdx#getting-started) guide.
If you have not set up your Saleor Cloud account yet, we suggest following the [Getting started](/quickstart/cloud.mdx) guide.
2 changes: 1 addition & 1 deletion docs/setup/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Explore the quickest ways to get started with Saleor.

Before you continue, make sure you went through:

- [Setting up your Saleor Cloud account](/cloud.mdx#getting-started)
- [Setting up your Saleor Cloud account](/quickstart/cloud.mdx)
- [Installing Saleor CLI](/cli/overview.mdx#installing-the-cli)

### Storefront
Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ module.exports = {
},

title("Product"),
ref("cloud", "Cloud", "cloud"),
ref("cloud/overview", "Cloud", "cloud"),
ref("developer/index", "Core Concepts", "guides"),

title("API"),
Expand Down
6 changes: 3 additions & 3 deletions sidebars/cloud.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
const { chapterTitle, hr } = require("./utils");

export const cloudSidebar = [
chapterTitle("cloud", "Cloud", "cloud"),
chapterTitle("cloud/overview", "Cloud overview", "cloud"),
hr(),
{ type: "ref", id: "quickstart/cloud" },
"restricting-api-access",
"cloud/environment",
"cloud/restricting-api-access",
];

0 comments on commit 51c4ec5

Please sign in to comment.