daostack / daostack/subgraph

document the deployment procedure please please please

Open
#262 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
44
Forks
30
PR merge metrics
No merged PRs in 30d

Description

We need tod ocument the deployment procudere because:

1. Every second deployment fails because of some human error
2. Only oren really knows how it works

So we need step-by-step documentation on:

- how to add a new dao to an existing subgraph version
- how to deploy a new subraph version

These steps involve:

- copy an exiting directory or git checkout (?)
- edit docker-compose and assign new ports
- star the dcker cotnainers
- editing the necessary files for subgraph deploymnet
- npm run deploy
- check if server is done indexing
- configure nginx and reload it

We can document this in the https://github.com/daostack/devops/ repo so it will not be public.

-----------------------------
the procedure is quite complex, perhaps more than necessary.

My impression is that deployment (of a new rinkeby or mainnet subgraph version) has become very cmplex, with file changes (apparently) in these files that influence the results:

* the `.env` file
* the `daos/` directory
* the `ops/mappings.json`
* the `ops/mapping.json` container
* the migration.json from `daostack/migration`
* the docker-compose file

If that is really the case, perhaps it is also a good idea to reorganize this

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing the deployment procedure in the devops repository and reviewing the named .env file, daos/ directory, ops/mappings.json, ops/mapping.json container, migration.json, and docker-compose file. Document adding a DAO, deploying a subgraph version, running npm run deploy, checking indexing, and configuring nginx; done means a newcomer can follow and verify the full procedure.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, git, nginx, typescript
Domain
blockchain, devops, documentation, infrastructure
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.