New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bitcoin Node Maintainer #66

Open
cbeams opened this Issue Jan 9, 2018 · 13 comments

Comments

Projects
None yet
4 participants
@cbeams
Copy link
Member

cbeams commented Jan 9, 2018

This @bisq-network/btcnode-maintainers role is responsible for maintaining the shared configuration for @bisq-network's federation of @bitcoin nodes, as hard-coded in https://github.com/bisq-network/exchange/blob/master/core/src/main/java/io/bisq/core/btc/BitcoinNodes.java.

This role should maintain a shared bitcoin.conf file in this repository, and work with @bisq-network/btcnode-operators to make sure they run the same configuration there.

This role is responsible for responding in a timely fashion to GitHub issues added to this repository, questions asked in the #btcnode channel, and to ensure that monitoring notifications in #btcnode-monitoring get handled in a timely fashion.


Docs: none, other than the above
Team: @bisq-network/btcnode-maintainers
Primary owner: @sqrrm
Secondary: @ManfredKarrer (would like to hand over role)

cbeams added a commit that referenced this issue Jan 9, 2018

Add new "Bitcoin Node Maintainer" role (#66)
And link to new issue for "Bitcoin Node Operator" role (#39 => #67)

See bisq-network/dao#28

@cbeams cbeams removed the a:role label May 4, 2018

@sqrrm

This comment has been minimized.

Copy link
Member

sqrrm commented Jun 29, 2018

2018.06 report

Took over role as maintainer halfway through the month. Nothing to report on nodes.

@ManfredKarrer @cbeams Regarding maintaining the issue, is there a way for me to update the initial issue #66 (comment) to keep it relevant?

@sqrrm sqrrm referenced this issue Jun 29, 2018

Closed

For June 2018 #86

@cbeams

This comment has been minimized.

Copy link
Member

cbeams commented Jul 6, 2018

@sqrrm wrote:

Regarding maintaining the issue, is there a way for me to update the [issue description] to keep it relevant?

In short, yes, but it'll work a little differently than that. I'll have instructions for all role owners about this soon. Thanks.

@cbeams

This comment has been minimized.

Copy link
Member

cbeams commented Jul 17, 2018

@sqrrm, regarding keeping the description for this role (and the Tor Relay Operator role at #72) up to date, I mentioned above that I'd have instructions for all role owners on this soon, but what I'd actually like to do, if you're willing, is to have you try out the instructions first and provide feedback about it before I send out a broader request to have everyone do the same.

I'll provide a little context here, so that hopefully everything makes sense, but in the end, it should be a fairly simple task, one that will probably take 30 minutes or perhaps an hour for most roles.

First it's a good idea to read through the new Roles doc at https://docs.bisq.network/roles.html if you haven't already. It provides (hopefully) everything that contributors need to know about how roles work.

The relevant section of that doc that I want to focus on here is the Docs section at https://docs.bisq.network/roles.html#docs:

image

To follow those instructions for this role, you'd put together a pull request against the bisq-docs repository that adds a btcnode.adoc file. That file would include:

  • an Introduction section that explains what the Bisq federation of Bitcoin Core nodes is for, how it helps protect user privacy, etc.
  • an Infrastructure section that mentions the bisq-btcnode repository and btcnode slack channel.
  • a Roles section that details the Duties, Rights, GH Issue and GH Team for both the btcnode Maintainer and Operator roles.
  • if appropriate, a Processes section that details any processes involved with btcnodes, e.g. upgrades.

The Proposals doc at https://docs.bisq.network/proposals.html provides an example for what such a doc should look like; please treat it as a template.

You'll also want to add an entry to index.adoc to make sure that your new btcnode.adoc doc is discoverable. For right now, you can just put it at the bottom of the list in the Contributor Docs section. I plan to revise the index page soon to better accommodate these kinds of docs.

One of the effects of having these docs is that the descriptions in role issues like this one become simple, uniform, and largely unchanging. There's little need to "keep them up to date", and that avoids permissions problems like the one you had where you were unable to edit this issue (because I was the one who created it). The description ends up being as simple as this:

Docs: https://docs.bisq.network/btcnode.adoc#maintainer
Team: @bisq-network/btcnode-maintainers
Primary owner: @sqrrm

So, please let me know if it works for you to do this, and I'll look out for your PR. Thanks!

@sqrrm

This comment has been minimized.

Copy link
Member

sqrrm commented Jul 18, 2018

@cbeams I'll try to get that done, hopefully by the end of this week. Will let you know.

@sqrrm

This comment has been minimized.

Copy link
Member

sqrrm commented Jul 23, 2018

@cbeams I tried writing this up but three times I gave up. It's in principle not a hard task but I find administrative tasks energy draining so I just push it as long as I can. This is probably not the case for everyone but for me I would waste days of energy on something that, as you say, should take 30 minutes for someone with the inclination. The issues I face are:

  • I don't enjoy writing documentation and thus lack motivation but I don't mind the technical details of the role
  • There is process that needs to be followed and learned but the benefit seems small for the energy spent
  • The need to learn adoc notation to write a reasonable document

I think it would be better to get someone to write these docs up in a minimal fashion for the maintainers to fix if need be. I suspect someone might actually enjoy doing this whereas I and perhaps others with a similar aversion to administrative tasks would be turned off and even avoid taking on roles that could otherwise be taken.

@cbeams

This comment has been minimized.

Copy link
Member

cbeams commented Jul 23, 2018

Understood, @sqrrm, and it’s good feedback all the same. Thanks.

/cc @m52go

@m52go

This comment has been minimized.

Copy link
Member

m52go commented Jul 25, 2018

Yeah @sqrrm I don't blame you. I'm willing to write the doc if you're willing to provide the details.

But in order to start, I need basic details covering the required content. Let me know if that already exists somewhere.

Otherwise, we could proceed in 2 ways:

  • you produce quick written notes that cover the items @cbeams mentioned above. They don't need to be remotely well-formed or even readable (i.e., a "brain dump").
  • we have a quick 10-15 minute phone conversation where we talk through the content.

Let me know what you think, or if you've got any other suggestions.

@sqrrm

This comment has been minimized.

Copy link
Member

sqrrm commented Jul 30, 2018

2018.07 report

During the month there has been no noticeable events.

There is a new minor bitcoind version out but we have earlier decided to only try to move quickly to new major versions. There is also a question if we actually want to move to 0.17.x when it arrives, to be discussed separately when it's more relevant.

The process of moving to new role management and documentation has been slow, partially due to me and partially due to the process. I will try to get this done for the bitcoin nodes next month with the help of @m52go That should work as a template for the other roles.

@sqrrm sqrrm referenced this issue Jul 30, 2018

Closed

For July 2018 #97

@cbeams cbeams referenced this issue Jul 31, 2018

Closed

For July 2018 #101

@m52go m52go referenced this issue Jul 31, 2018

Closed

For July 2018 #103

@sqrrm

This comment has been minimized.

Copy link
Member

sqrrm commented Aug 31, 2018

2018.08 report

Nothing noticeable to report.

@sqrrm sqrrm referenced this issue Aug 31, 2018

Closed

For August 2018 #113

@sqrrm

This comment has been minimized.

Copy link
Member

sqrrm commented Sep 28, 2018

2018.09 report

This month there was a bug in bitcoind https://bitcoincore.org/en/2018/09/20/notice/ requiring urgent attention. All bisq bitcoin nodes were upgraded urgently.

@sqrrm

This comment has been minimized.

Copy link
Member

sqrrm commented Oct 29, 2018

2018.10 report

A new major version is out, 0.17.0. Some have upgraded and no issues have been seen so I think it's good if all node operators upgrade at this point.

@sqrrm

This comment has been minimized.

Copy link
Member

sqrrm commented Nov 29, 2018

2018.11 report

The documentation for bitcoin node is getting closer to completion, @m52go is working on it with my input.

There is a new minor bitcoind version, no need to upgrade but those that want to can do it.

bisq-network/compensation#173

@sqrrm

This comment has been minimized.

Copy link
Member

sqrrm commented Dec 25, 2018

2018.12 report

Bitcoin Core 0.17.1 has been released but I see no urgent need for nodes on 0.17.0+ to upgrade.

Nothing more to report for December

bisq-network/compensation#190

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment