docs: auth in cloud + restructure deployment guides (#14457)
* docs: auth in cloud + restructure deployment guides * added details about enabling cloud auth * fix vale errors
This commit is contained in:
@@ -11,7 +11,7 @@ In this guide, you'll learn about deployments in Cloud, how they're created, and
|
||||
|
||||
## Deployments Overview
|
||||
|
||||
Each [environment](../environments/page.mdx) has at least one deployment, which is publicly accessible at the [environment's URL](#find-environments-url).
|
||||
Each [environment](../environments/page.mdx) has at least one deployment, which is publicly accessible at the [environment's URL](./access/page.mdx#find-environments-url).
|
||||
|
||||
A deployment is created from the latest source code of an [environment](../environments/page.mdx)'s branch. An environment can have only one live deployment at a time.
|
||||
|
||||
@@ -87,7 +87,6 @@ You'll find all deployments for the project's environments in the "Deployments"
|
||||
|
||||
---
|
||||
|
||||
|
||||
## Find Environment Deployments
|
||||
|
||||
You can find the deployments for an environment in the project and environment dashboards.
|
||||
@@ -148,63 +147,6 @@ This will change the view to the selected deployment and you'll see its details
|
||||
|
||||
---
|
||||
|
||||
## Access Live Deployment
|
||||
|
||||
You can only access a deployment once its status is "Live". You can access it through its environment's URL.
|
||||
|
||||
### Find Environment's URL
|
||||
|
||||
<Note>
|
||||
|
||||
For preview environments, refer to the [Preview Environments](../environments/preview/page.mdx#access-deployed-preview-environment) guide to find the URL of the preview environment.
|
||||
|
||||
</Note>
|
||||
|
||||
An environment's URL is in the format `<subdomain>.medusajs.app`, where `<subdomain>` is the subdomain you set either when [creating its project](../projects/page.mdx#create-a-project) or when [creating the environment](../environments/long-lived/page.mdx#create-a-long-lived-environment).
|
||||
|
||||
You can also find the URL of a deployment's environment through the Cloud dashboard:
|
||||
|
||||
1. Select a project from the [organization's dashboard](../organizations/page.mdx#organization-dashboard).
|
||||
2. In the project's dashboard, find the URL in the environment's card under its name. For example, find the production URL in the Production environment card.
|
||||
|
||||
<Note title="Why are there two URLs?">
|
||||
|
||||
Aside from the subdomain you set when [creating the environment](../environments/long-lived/page.mdx#create-a-long-lived-environment), Medusa also provides a unique, randomly generated URL for each environment. Both of these URLs point to the same deployment.
|
||||
|
||||
</Note>
|
||||
|
||||

|
||||
|
||||
3. You can also click on the environment's name to open its dashboard, where you'll find the URL under the environment's name.
|
||||
|
||||

|
||||
|
||||
### Access the Deployment's Medusa Admin
|
||||
|
||||
To access the Medusa Admin of a live deployment, click on [the environment's URL](#find-environments-url).
|
||||
|
||||
You can then log in using the email and password set either [during project creation](../projects/page.mdx#create-a-project) or [in the environment's variables](../environments/long-lived/page.mdx#create-medusa-admin-user-in-environment).
|
||||
|
||||
### Send Requests to the Deployment
|
||||
|
||||
You can send requests to a live deployment's API routes using its URL.
|
||||
|
||||
For example, to check the health of the live deployment, you can send a `GET` request to the `/health` endpoint:
|
||||
|
||||
```bash
|
||||
curl https://my-project.medusajs.app/health
|
||||
```
|
||||
|
||||
Where `my-project` is the subdomain you set either when [creating the project](../projects/page.mdx#create-a-project) or when [creating the environment](../environments/long-lived/page.mdx#create-a-long-lived-environment).
|
||||
|
||||
### Access Deployment's Server through SSH
|
||||
|
||||
Medusa doesn't support SSH access to the server instance of a deployment. However, you can still access the server's [runtime and build logs](../logs/page.mdx) to debug issues in your application.
|
||||
|
||||
If this isn't sufficient for your use case, you can contact support to discuss alternatives.
|
||||
|
||||
---
|
||||
|
||||
## Deployment Statuses and Lifecycle
|
||||
|
||||
A deployment can have one of the following statuses:
|
||||
@@ -300,6 +242,14 @@ If a deployment is stuck at a status like "Building" or "Deploying" for a long t
|
||||
|
||||
---
|
||||
|
||||
## Access Live Deployment
|
||||
|
||||
Once a deployment's status is "Live", you can access its Medusa Admin and send requests to its API routes.
|
||||
|
||||
Learn more in the [Access Live Deployment](./access/page.mdx) guide.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting Failed Deployments
|
||||
|
||||
### Troubleshooting Build Failures
|
||||
|
||||
Reference in New Issue
Block a user