|
53 | 53 | - **Webhook validation** — admission webhook enforces minimum storage/memory requirements and immutable chain/network fields |
54 | 54 | - **Sidecars** — attach consensus-layer clients (e.g. Lighthouse for Ethereum) or any helper process |
55 | 55 |
|
| 56 | +## Quick Start |
| 57 | + |
| 58 | +### Prerequisites |
| 59 | + |
| 60 | +- Go 1.23+ |
| 61 | +- kubectl 1.25+ |
| 62 | +- Access to a Kubernetes cluster |
| 63 | + |
| 64 | +### Install via Helm |
| 65 | + |
| 66 | +```sh |
| 67 | +helm install chainplane charts/chainplane \ |
| 68 | + --namespace blockchain-nodes \ |
| 69 | + --create-namespace \ |
| 70 | + --set image.repository=ghcr.io/tazhate/chainplane \ |
| 71 | + --set image.tag=latest |
| 72 | +``` |
| 73 | + |
| 74 | +### Install CRDs manually |
| 75 | + |
| 76 | +```sh |
| 77 | +make install |
| 78 | +make deploy IMG=<your-registry>/chainplane:latest |
| 79 | +``` |
| 80 | + |
| 81 | +### Create Your First Node |
| 82 | + |
| 83 | +```yaml |
| 84 | +apiVersion: nodes.chainplane.io/v1alpha1 |
| 85 | +kind: BlockchainNode |
| 86 | +metadata: |
| 87 | + name: bitcoin-mainnet |
| 88 | + namespace: blockchain-nodes |
| 89 | +spec: |
| 90 | + chain: bitcoin |
| 91 | + network: mainnet |
| 92 | + nodeType: rpc |
| 93 | + nodeGroup: heavy |
| 94 | + storage: |
| 95 | + size: 600Gi |
| 96 | + storageClass: fast-nvme |
| 97 | + resources: |
| 98 | + requests: |
| 99 | + cpu: "2" |
| 100 | + memory: 8Gi |
| 101 | + limits: |
| 102 | + cpu: "4" |
| 103 | + memory: 16Gi |
| 104 | + rpc: |
| 105 | + enabled: true |
| 106 | + port: 8332 |
| 107 | +``` |
| 108 | + |
| 109 | +```sh |
| 110 | +kubectl apply -f bitcoin-node.yaml |
| 111 | +kubectl get blockchainnodes -w |
| 112 | +``` |
| 113 | + |
| 114 | +``` |
| 115 | +NAME CHAIN NETWORK TYPE PHASE HEIGHT PEERS SYNC ETA |
| 116 | +bitcoin-mainnet bitcoin mainnet rpc Syncing 830241 12 73.2% 14h22m |
| 117 | +``` |
| 118 | +
|
| 119 | +Sample manifests for all 102 chains are in [`config/samples/`](config/samples/). |
| 120 | +
|
56 | 121 | ## Architecture |
57 | 122 |
|
58 | 123 | ``` |
@@ -245,71 +310,6 @@ All Cosmos chains use `--home /data` for snapshot compatibility. |
245 | 310 | | `filecoin` | `filecoin/lotus:v1.35.0` | 1234 | | |
246 | 311 | | `fantom` | `fantomfoundation/go-opera:v1.1.3-txtracing` | 18545 | | |
247 | 312 |
|
248 | | -## Quick Start |
249 | | -
|
250 | | -### Prerequisites |
251 | | -
|
252 | | -- Go 1.23+ |
253 | | -- kubectl 1.25+ |
254 | | -- Access to a Kubernetes cluster |
255 | | -
|
256 | | -### Install via Helm |
257 | | -
|
258 | | -```sh |
259 | | -helm install chainplane charts/chainplane \ |
260 | | - --namespace blockchain-nodes \ |
261 | | - --create-namespace \ |
262 | | - --set image.repository=ghcr.io/tazhate/chainplane \ |
263 | | - --set image.tag=latest |
264 | | -``` |
265 | | - |
266 | | -### Install CRDs manually |
267 | | - |
268 | | -```sh |
269 | | -make install |
270 | | -make deploy IMG=<your-registry>/chainplane:latest |
271 | | -``` |
272 | | - |
273 | | -### Create Your First Node |
274 | | - |
275 | | -```yaml |
276 | | -apiVersion: nodes.chainplane.io/v1alpha1 |
277 | | -kind: BlockchainNode |
278 | | -metadata: |
279 | | - name: bitcoin-mainnet |
280 | | - namespace: blockchain-nodes |
281 | | -spec: |
282 | | - chain: bitcoin |
283 | | - network: mainnet |
284 | | - nodeType: rpc |
285 | | - nodeGroup: heavy |
286 | | - storage: |
287 | | - size: 600Gi |
288 | | - storageClass: fast-nvme |
289 | | - resources: |
290 | | - requests: |
291 | | - cpu: "2" |
292 | | - memory: 8Gi |
293 | | - limits: |
294 | | - cpu: "4" |
295 | | - memory: 16Gi |
296 | | - rpc: |
297 | | - enabled: true |
298 | | - port: 8332 |
299 | | -``` |
300 | | -
|
301 | | -```sh |
302 | | -kubectl apply -f bitcoin-node.yaml |
303 | | -kubectl get blockchainnodes -w |
304 | | -``` |
305 | | - |
306 | | -``` |
307 | | -NAME CHAIN NETWORK TYPE PHASE HEIGHT PEERS SYNC ETA |
308 | | -bitcoin-mainnet bitcoin mainnet rpc Syncing 830241 12 73.2% 14h22m |
309 | | -``` |
310 | | - |
311 | | -Sample manifests for all 102 chains are in [`config/samples/`](config/samples/). |
312 | | - |
313 | 313 | ## CRD Reference |
314 | 314 |
|
315 | 315 | ### Spec |
|
0 commit comments