Add docs to clone a new DANDI instance #104
Conversation
Build out docs for Linc clone
Include more specific deployment token
Trivial env change
|
@aaronkanzer Why do the instructions say to create an account on PyPI? That should only be done if you're planning to release packages on PyPI, which has nothing to do with interacting with DANDI. |
Hi @jwodder, These instructions are meant for the developers of the data archive and associated tools, especially for developing a new DANDI-like ecosystem which we are doing for the LINC project. Since the DANDI CLI and Python API are a method of interacting with the archive, Aaron added instructions here for releasing the Python package to PyPI. Hope this helps to answer your question. |
Hi @jwodder, we are releasing a clone of the |
| You'll be prompted with the following form -- see the example values populated in this screenshot -- more to come in other sections for where these values might be populated: | ||
|
|
||
| <br/><br/> | ||
| <img |
There was a problem hiding this comment.
We (EMBER) ended up needing to change these to the following to get auth working:
- Homepage URL: https://<your-awesome-subdomain-if-applicable>.<your-awesome-domain>.org
- Authorization callback URL: https://<your-awesome-domain>.org
rather than the existing:
|
|
||
| ### Creating "Sites" and "Social App" Objects | ||
|
|
||
| **In order to complete this step, you will need to have deployed an initial DANDI Archive API**. See [Creating the DANDI Archive API](../64_dandi_archive) for more details. |
There was a problem hiding this comment.
Recommendation: Consider re-ordering the pages for Authentication, CLI, Infrastructure, and Archive.
We (EMBER) roughly did things in the following order:
- Infrastructure
- Archive
- Authentication
- CLI
Of course there was a little back and forth but in general this order seemed to work well
| ### Heroku Dyno Sizes | ||
|
|
||
| `dandi-infrastructure` defines "dyno" (a.k.a process) sizes for each service being run. For specific reference, | ||
| [see here in api.tf](https://github.com/dandi/dandi-infrastructure/blob/master/terraform/api.tf#L14-L18). | ||
|
|
||
| While your DANDI Archive clone may differ in traffic and activity, the defaults set in `dandi-infrastructure` rarely | ||
| exceed 75% usage. | ||
|
|
||
| Keep in mind the different [pricing structures](https://www.heroku.com/pricing) that come with choosing different Heroku dyno sizes | ||
|
|
||
| ### Heroku Add-Ons | ||
|
|
||
| In addition to the Heroku 'dynos' that are added for compute, multiple Heroku 'add-ons' are included | ||
|
|
||
| - [CloudAMQP](https://elements.heroku.com/addons/cloudamqp) -- **Use Case**: Message Broker | ||
| - [Postgres](https://elements.heroku.com/addons/heroku-postgresql) -- **Use Case**: Database | ||
| - [Papertrail](https://elements.heroku.com/addons/papertrail) -- **Use Case**: Log Management | ||
|
|
There was a problem hiding this comment.
Should we move these topics to the Understanding the DANDI Infrastructure section in this page?
There was a problem hiding this comment.
I believe they are already in that section? Unless you had something else in mind?
There was a problem hiding this comment.
I think they are currently in the Domain Management section, but its not a big deal.
kabilar
changed the title
There was a problem hiding this comment.
Thank you, @aaronkanzer. I am sure this took a huge effort. Great work.
There are just a few remaining suggestions above.
Co-authored-by: Yaroslav Halchenko <[email protected]>
Co-authored-by: Yaroslav Halchenko <[email protected]>
There was a problem hiding this comment.
Thank you, @aaronkanzer.
After discussion with Aaron, we will proceed with the merge here and he will be submitting a subsequent pull request for the few unresolved suggestions.
Looking for review for now, no need to merge
These documents provide a step-by-step process if another user would like to launch their own Dandi-like ecosystem
please see here if you'd like to observe a live link: https://aquamarine-profiterole-e20e84.netlify.app/
or specifically:
https://lincbrain.github.io/handbook/40_initialization/