up icon indicating copy to clipboard operation
up copied to clipboard

Walkthrough for common things

Open egonelbre opened this issue 3 years ago • 1 comments

Let's create a guide on how to use storj-up and how to do the most common tasks people need to do. Each of these can be converted into a separate issue for tracking purposes.

  • [ ] Walkthrough: Basic Docker setup
  • [ ] Walkthrough: Basic Nomad setup
  • [ ] Walkthrough: Basic Native setup
  • [ ] Walkthrough: Running the system and doing exploratory testing on frontend and with uplink.
  • [ ] Walkthrough: Running a system based on gerrit / github commit.
  • [ ] Walkthrough: Customizing the system for your needs
    • [ ] use different (older versions without build)
    • [ ] scale up to 50 storagenodes with different versions
    • [ ] find configuration parameters + change them
  • [ ] Walkthrough: Starting up system with simulated data
  • [ ] Walkthrough: Fixing an uplink issue and testing against the storj-up
  • [ ] Walkthrough: Fixing a satellite bug
  • [ ] Walkthrough: Fixing satellite frontend issue (with backend) https://github.com/storj/up/issues/54
  • [ ] Walkthrough: Fixing a storagenode bug
  • [ ] Walkthrough: Fixing storagenode frontend (with backend)
  • [ ] Walkthrough: Fixing a gateway issue
  • [ ] Walkthrough: Fixing a multinode issue
  • [ ] Walkthrough: Saving the state of the system to reproduce an issue on another system.
  • [ ] Walkthrough: debug one of the components from local environment
  • [ ] Walkthrough: use admin API

Also, figure out whether there's something missing from this list.

This can be done as documentation or as a video per bullet-point. Also, avoid creating videos for things that are still not complete.

egonelbre avatar Nov 09 '22 15:11 egonelbre

Suggestions:

  • Walkthrough: Customizing the system for your needs. e.g. 50 storagenodes with different versions

Change it to:

  • Walkthrough: Customizing the system for your needs.
    • use different (older versions without build)
    • scale up to 50 storagenodes with different versions
    • find configuration parameters + change them

More:

  • Walkthrough: debug one of the components from local environment
  • Walkthrough: use admin API (requested earlier offline)

elek avatar Nov 11 '22 11:11 elek