-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e6398a1
commit a3d65cc
Showing
21 changed files
with
1,781 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
values.hab.yaml | ||
# Various IDEs | ||
.project | ||
.idea/ | ||
.vscode | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Patterns to ignore when building packages. | ||
# This supports shell glob matching, relative path matching, and | ||
# negation (prefixed with !). Only one pattern per line. | ||
.DS_Store | ||
# Common VCS dirs | ||
.git/ | ||
.gitignore | ||
.bzr/ | ||
.bzrignore | ||
.hg/ | ||
.hgignore | ||
.svn/ | ||
# Common backup files | ||
*.swp | ||
*.bak | ||
*.tmp | ||
*.orig | ||
*~ | ||
# Various IDEs | ||
.project | ||
.idea/ | ||
*.tmproj | ||
.vscode/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
apiVersion: v2 | ||
name: hab | ||
description: A Helm chart for a high availability bitcoin node | ||
type: application | ||
version: 1.0.0 | ||
appVersion: "22.0" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2022 GildedPleb | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# High Availability Bitcoin Node - Helm Chart | ||
|
||
This is a rudimentary Helm Chart for a simple Highly Available Bitcoin node. At | ||
present it supports multiple bitcoin implementations (bitcoind, btcd, bcoin), | ||
architectures (arm64, amd64), deployment environments (cloud, bare-metal), and | ||
networks (prod, test, simnet, etc). | ||
|
||
## Why? | ||
|
||
Bitcoin, at a macro level, is a fundamentally highly available system: though | ||
one node might fail, the incentives in the system ensure that there are many | ||
nodes still available. So why make a highly available node? Bitcoin is not, | ||
however, highly available at the micro node level: a single node may experience | ||
all kinds of individual down time, disruptions, and failures. | ||
|
||
## Install | ||
|
||
### Requirements | ||
|
||
| | | | ||
| ---------- | ----- | | ||
| Kubernetes | >1.23 | | ||
| Helm | >3.8 | | ||
| Longhorn | >1.2 | | ||
|
||
> You may want to design a 3+ host Kubernetes Cluster with this chart in mind | ||
> Additionally, having host names will be helpful. | ||
``` | ||
helm repo add gildedpled/hab | ||
helm repo update | ||
helm show values gildedpled/hab > values.hab.yml | ||
``` | ||
|
||
Edit `values.hab.yml` according to [configuration](./configuration.md) options. | ||
And [examples](./examples.md) for examples. | ||
|
||
``` | ||
helm install hab gildedpled/hab -f values.hab.yaml | ||
``` | ||
|
||
## Roadmap Feature list | ||
|
||
- Build images from repo locally, and automatically, and push to remote, via: | ||
https://flavio.castelli.me/2020/09/16/build-multi-architecture-container-images-using-kubernetes/ | ||
- Store images locally in a registry like docker registry | ||
- Mirror source code repos locally | ||
- Make all officially supported repos interoperable, aka, the same RPC calls | ||
return the same data, in the same format, no matter if the load balancer | ||
directs you to a bcoin node or a bitcoind node. | ||
- Would probably mean it needs to be a bitcoin controller, more here: | ||
https://leftasexercise.com/2019/10/14/building-a-bitcoin-controller-part-vi-managing-secrets-and-creating-events/ | ||
- Might even need a front end | ||
- Integrate with higher layers, like lightning, block explorers, coinjoins, | ||
etc. | ||
- Diversify out of Longhorn | ||
- Full tor integration, like tor services, or ingress | ||
- Add autoscaling... probably infeasible due to resource constraints | ||
- Reduce log pollution | ||
|
||
## Contributors | ||
|
||
gildedpleb | ||
|
||
--- | ||
|
||
Be a Gilded Pleb. Run a HAB node. |
Oops, something went wrong.