Merge latest docs from private operator docs #107
Conversation
ravenac95
force-pushed
the
ravenac95/merge-operator-docs
branch
from
4d049a4 to
9428add
Compare
| db: | ||
| backend: boltdb | ||
| debug: | ||
| addr_book_lenient: False |
There was a problem hiding this comment.
this is default (could be skipped)
| external_address: tcp://{{ external_address }}:26656 | ||
|
|
||
| db: | ||
| backend: boltdb |
There was a problem hiding this comment.
this is default (could be skipped).
There are actually many more defaults in this block (everything besides external_address & num_kept) - i'm fine with either specifying the defaults or skipping them
| ## THESE NEXT 3 LINES ARE TEMPORARY YOU SHOULD NOT EXPOSE THIS PORT IN ANY WAY | ||
| grpc: | ||
| debug: | ||
| port: "42261" |
There was a problem hiding this comment.
not 100% sure why is this needed (cannot the unix socket be used?)
There was a problem hiding this comment.
if it's due to the "Port forwarding" step (at least on linux port forwarding to a unix domain socket should work), otherwise some magic with socat might be needed
There was a problem hiding this comment.
Ya I was mostly worried about a permissions issue on the sshing user to the unix socket... the port would lead to less questions from people using the doc... was the thought
| $ oasis-node registry entity list -a /serverdir/node/internal.sock | ||
| ``` | ||
|
|
||
| If this command fails, you'll receive a non-zero exit code and there's a high |
There was a problem hiding this comment.
not connected to the network
(e.g. node could still be syncing - which can be checked with is-synced command (although might be better if the operator can figure this out by checking the logs)
| backend: boltdb | ||
| debug: | ||
| addr_book_lenient: False | ||
| seeds: "{{ seed_node_address }}" |
There was a problem hiding this comment.
as of oasisprotocol/oasis-core#2300 this is a list, so should be:
seed:
- "{{ seed_node_address }}"
(should probably not fixed until the pr is merged)
Made some minor grammar changes, and added a caveat to the first paragraph.
We are preparing to have these docs merged in for tomorrow. The docs have been reviewed by @david-yan and myself.
Feel free to suggest any more adjustments