private/testplanet: document env variables

Change-Id: I122d56b90af3df1f1b17716a31ddca7c115fca7c

private/testplanet/doc.go

@@ -0,0 +1,36 @@
+// Copyright (C) 2021 Storj Labs, Inc.
+// See LICENSE for copying information
+
+// Package testplanet implements full network wiring for testing.
+//
+// testplanet provides access to most of the internals of satellites,
+// storagenodes and uplinks.
+//
+//
+// Database
+//
+// It does require setting two variables for the databases:
+//
+//    STORJ_TEST_POSTGRES=postgres://storj:storj-pass@test-postgres/teststorj?sslmode=disable
+//    STORJ_TEST_COCKROACH=cockroach://root@localhost:26257/master?sslmode=disable
+//
+// When you wish to entirely omit either of them from the test output, it's possible to use:
+//
+//    STORJ_TEST_POSTGRES=omit
+//    STORJ_TEST_COCKROACH=omit
+//
+//
+// Debugging
+//
+// For debugging, it's possible to set STORJ_TEST_MONKIT to get a trace per test.
+//
+//    STORJ_TEST_MONKIT=svg
+//    STORJ_TEST_MONKIT=json
+//
+// By default, it saves the output the same folder as the test. However, if you wish
+// to specify a separate folder, you can specify an absolute directory:
+//
+//    STORJ_TEST_MONKIT=svg,dir=/home/user/debug/trace
+//
+// Note, due to how go tests work, it's not possible to specify a relative directory.
+package testplanet

private/testplanet/planet.go

@@ -1,7 +1,6 @@
 // Copyright (C) 2019 Storj Labs, Inc.
 // See LICENSE for copying information
 
-// Package testplanet implements the full network wiring for testing
 package testplanet
 
 import (