Skip to content

Rename staging to sandbox #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/api/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The DANDI Archive provides a RESTful API that allows programmatic access to the
The DANDI API is available at:

- Production: [https://api.dandiarchive.org/](https://api.dandiarchive.org/)
- Staging: [https://api-staging.dandiarchive.org/](https://api-staging.dandiarchive.org/)
- Sandbox: [https://api-sandbox.dandiarchive.org/](https://api-sandbox.dandiarchive.org/)

## API Documentation

Expand All @@ -16,7 +16,7 @@ The API documentation is available in three formats:
### Swagger UI

- Production: [https://api.dandiarchive.org/swagger/](https://api.dandiarchive.org/swagger/)
- Staging: [https://api-staging.dandiarchive.org/swagger/](https://api-staging.dandiarchive.org/swagger/)
- Sandbox: [https://api-sandbox.dandiarchive.org/swagger/](https://api-sandbox.dandiarchive.org/swagger/)

The Swagger UI allows you to:

Expand All @@ -28,7 +28,7 @@ The Swagger UI allows you to:
### ReDoc

- Production: [https://api.dandiarchive.org/redoc/](https://api.dandiarchive.org/redoc/)
- Staging: [https://api-staging.dandiarchive.org/redoc/](https://api-staging.dandiarchive.org/redoc/)
- Sandbox: [https://api-sandbox.dandiarchive.org/redoc/](https://api-sandbox.dandiarchive.org/redoc/)

The ReDoc interface provides:

Expand Down
4 changes: 2 additions & 2 deletions docs/developer-guide/creating-dandi-instance/dandi-archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ The only other major initial setup step for the DANDI Archive frontend is regard

## API Deployment with GitHub CI/CD

Within the DANDI Archive repository, GitHub actions workflows exist for deployments to [production](https://github.com/dandi/dandi-archive/blob/master/.github/workflows/backend-production-deploy.yml) and [staging](https://github.com/dandi/dandi-archive/blob/master/.github/workflows/backend-staging-deploy.yml) environments
Within the DANDI Archive repository, GitHub actions workflows exist for deployments to [production](https://github.com/dandi/dandi-archive/blob/master/.github/workflows/backend-production-deploy.yml) and [sandbox](https://github.com/dandi/dandi-archive/blob/master/.github/workflows/backend-staging-deploy.yml) environments

- **Staging**: by default, releases are manual via the `workflow_dispatch` clause in the workflow
- **Sandbox**: by default, releases are manual via the `workflow_dispatch` clause in the workflow

To invoke the pipeline, proceed to the `Actions` tab in GitHub and find the pipeline name in the column on the left

Expand Down
8 changes: 4 additions & 4 deletions docs/developer-guide/creating-dandi-instance/dandi-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ known_instances = {
"https://dandiarchive.org",
"https://api.dandiarchive.org/api",
),
"dandi-staging": DandiInstance(
"dandi-staging",
"https://gui-staging.<your-domain>.org",
"https://api-staging.<your-domain>.org/api",
"dandi-sandbox": DandiInstance(
"dandi-sandbox",
"https://sandbox.<your-domain>.org",
"https://api-sandbox.<your-domain>.org/api",
),
"dandi-api-local-docker-tests": DandiInstance(
"dandi-api-local-docker-tests",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,12 +189,12 @@ style="width: 60%; height: auto; display: block; margin-left: auto; margin-righ

Populate the value in the [appropriate account ID reference](https://github.com/dandi/dandi-infrastructure/blob/master/terraform/main.tf#L14) in the `main.tf` template.

### Staging vs. Production
### Sandbox vs. Production

For staging, you can modify and apply the [staging_bucket.tf](https://github.com/dandi/dandi-infrastructure/blob/master/terraform/staging_bucket.tf)
For sandbox, you can modify and apply the [staging_bucket.tf](https://github.com/dandi/dandi-infrastructure/blob/master/terraform/staging_bucket.tf)
and [staging_pipeline.tf](https://github.com/dandi/dandi-infrastructure/blob/master/terraform/staging_pipeline.tf).

Setting up staging will require unique AWS Route 53 Domains, as well a different Heroku app with different compute.
Setting up sandbox will require unique AWS Route 53 Domains, as well a different Heroku app with different compute.

**Note -- ensure you review your `web/netlify.toml` file in DANDI Archive -- this will define different environment variables that correspond with staging vs. production**

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-guide/system-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Provisions the servers, worker processes, and the database for the API.
* **Frontend server**: Serves a static build of the DANDI Archive frontend (Vue.js).
* **Autodeployment**: On each push or merge to `main` (or whichever branch is configured), Netlify automatically builds and deploys.
* **Configuration**:
- **`netlify.toml`**: Describes build commands, environment variables for staging vs. production.
- **`netlify.toml`**: Describes build commands, environment variables for sandbox vs. production.
- **`.env.production`**: Holds the environment variables for the Vue-based app at runtime (e.g. `VITE_API_URL`, `VITE_SENTRY_DSN`).

### 4. Terraform Infrastructure
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/creating-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ With an account, users can create and edit Dandisets, and use the DANDI Hub to a
DANDI provides two servers:

- **Main server**: [https://dandiarchive.org/](https://dandiarchive.org/) - This is the primary platform for most users.
- **Staging server**: [https://gui-staging.dandiarchive.org/](https://gui-staging.dandiarchive.org/) - Ideal for training and testing purposes.
- **Sandbox server**: [https://sandbox.dandiarchive.org/](https://sandbox.dandiarchive.org/) - Ideal for training and testing purposes.

Accounts are independently managed on each server, allowing users to register on one or both, depending on their testing and deployment needs.

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide-sharing/creating-dandiset.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Before creating a Dandiset, you should:
1. **Register for DANDI and obtain an API key.** To create a new Dandiset, you need to have a DANDI account.
* If you do not already have an account, see [Create a DANDI Account](../getting-started/creating-account.md) page for instructions.
* Once you are logged in, copy your API key by clicking on your user initials in the top-right corner after logging in.
* Production (https://dandiarchive.org) and staging (https://gui-staging.dandiarchive.org) servers have different API keys and different logins.
* Production (https://dandiarchive.org) and sandbox (https://sandbox.dandiarchive.org) servers have different API keys and different logins.

2. **Choose a server.**
* **Production server**: https://dandiarchive.org. This is the main server for DANDI and should be used for sharing neuroscience data.
When you create a Dandiset, a permanent ID is automatically assigned to it.
This Dandiset can be fully public or embargoed according to NIH policy.
All data are uploaded as draft and can be adjusted before publishing on the production server.
* **Development server**: https://gui-staging.dandiarchive.org. This server is for testing and learning how to use DANDI.
* **Development server**: https://sandbox.dandiarchive.org. This server is for testing and learning how to use DANDI.
It is not recommended for sharing data, but is recommended for testing the DANDI CLI and GUI or as a testing platform for developers.
Note that the development server should not be used to stage your data.

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide-sharing/uploading-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ For command-line users or those with larger datasets, the DANDI CLI provides a p
```
To upload to the development server, use:
```bash
dandi upload -i dandi-staging
dandi upload -i dandi-sandbox
```

## Storing Access Credentials
Expand Down