Skip to content

Commit

Permalink
add more kind readme, added example values for optimism goerli, updat…
Browse files Browse the repository at this point in the history
…e version for helm
  • Loading branch information
taempark committed Apr 19, 2023
1 parent ddb74e3 commit 2011ae2
Show file tree
Hide file tree
Showing 12 changed files with 83 additions and 13 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,13 @@ This repository contains helm charts for Optimism and Ethereum infrastructure.
- You can build an OP Stack chain with a few lines of configurations.
- You can run Optimism network node easily.

## Why are you building this?
Because you probably need your own rollup at the end of the day and building on OP Stack is the best answer.
## How can I add your repository?
```shell
helm repo add op-charts https://testinprod-io.github.io/op-charts/
```

We just want to help you to onboard on the OP Stack :)
## Why are you building this?
We want to help you to onboard on the OP Stack!

## Thanks
Thanks for OP Labs, Optimism Foundation, and Ethereum Foundation for building and open-sourcing this amazing collective and technology.
Expand Down
2 changes: 1 addition & 1 deletion charts/erigon/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ apiVersion: v2
name: erigon
description: A Helm chart for Ethereum Execution Engine for efficiency frontier, erigon.
type: application
version: 0.0.3
version: 0.0.4
appVersion: v1.10.26
6 changes: 4 additions & 2 deletions charts/erigon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
Erigon is an efficiency frontier execution engine for EVM network. This is a Erigon Helm Chart packaged by Test in Prod.

## Introduction
You can use this chart for any EVM network including Optimism ;)
You can use this chart for any EVM network including Optimism.

Please refer to the example values for Optimism Goerli [here.](example-values/optimism-goerli.yaml)

## LFG
`helm install erigon-release . -f values.yaml`
`helm install erigon-release op-charts/erigon -f values.yaml`

## Requirements
1. K8s 1.8+
Expand Down
23 changes: 23 additions & 0 deletions charts/erigon/example-values/optimism-goerli.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Settings for Optimism Goerli
image:
repository: testinprod/op-erigon
tag: latest

importTarURL: https://op-erigon-backup.goerli.testinprod.io
maxPeers: 0
networkID: 420

# op-erigon specific
args: ["--rollup.historicalrpc=https://goerli.optimism.io",
"--rollup.sequencerhttp=https://goerli-sequencer.optimism.io",
"--nodiscover", "--externalcl"]

authrpc:
jwtSecret:
file: # TODO: generate a jwtSecret for the EngineAPI with the following command: `openssl rand -hex 32`.

persistence:
size: 100Gi
predefinedNetwork:

resources: {"requests": {"cpu": 2, "memory": "4Gi"}}
2 changes: 1 addition & 1 deletion charts/erigon/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ dataPath: /data
# if you want to import the chain data, use this thing.
importTarURL:

predefinedNetwork: mainnet # Put either `mainnet`, `optimism-goerli`, `goerli`, or `sepolia` for pre-defined settings.
predefinedNetwork: mainnet # Put either `mainnet`, `goerli`, or `sepolia` for pre-defined settings.
networkID: 1

optimism-img:
Expand Down
2 changes: 1 addition & 1 deletion charts/geth/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ apiVersion: v2
name: geth
description: A Helm chart for Ethereum Execution Engine, geth.
type: application
version: 0.0.2
version: 0.0.3
appVersion: v1.10.26
6 changes: 4 additions & 2 deletions charts/geth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
Geth is an execution engine for EVM network. This is a Geth Helm Chart packaged by Test in Prod.

## Introduction
You can use this chart for any EVM network including Optimism ;)
You can use this chart for any EVM network including Optimism.

Please refer to the example values for Optimism Goerli [here.](example-values/optimism-goerli.yaml)

## LFG
`helm install geth-release . -f values.yaml`
`helm install geth-release op-charts/geth -f values.yaml`

## Requirements
1. K8s 1.8+
Expand Down
23 changes: 23 additions & 0 deletions charts/geth/example-values/optimism-goerli.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# optimism goerli
image:
repository: ethereumoptimism/op-geth
tag: latest

importTarURL: https://storage.googleapis.com/oplabs-goerli-data/goerli-bedrock.tar
syncMode: full
maxPeers: 0
networkID:

# op-geth specific
args: ["--rollup.disabletxpoolgossip=true", "--rollup.sequencerhttp=https://goerli-sequencer.optimism.io",
"--nodiscover", "--allow-insecure-unlock"]

authrpc:
jwtSecret:
file: # TODO: generate a jwtSecret for the EngineAPI with the following command: `openssl rand -hex 32`.

persistence:
size: 300Gi
predefinedNetwork:

resources: {"requests": {"cpu": 2, "memory": "4Gi"}}
2 changes: 1 addition & 1 deletion charts/op-node/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ apiVersion: v2
name: op-node
description: A consensus engine for OP Stack. You can build a new OP Stack chain or connect to an existing one.
type: application
version: 0.0.1
version: 0.0.2
appVersion: "v0.10.13"
4 changes: 3 additions & 1 deletion charts/op-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ OP Node is a consensus engine for OP Stack. This is a OP Node Helm Chart package
## Introduction
You can build a new OP Stack chain or connect to an existing one. You need an OP execution engine that works along with OP Node.

Please refer to the example values for Optimism Goerli [here.](example-values/optimism-goerli.yaml)

## LFG
`helm install op-node-release . -f values.yaml`
`helm install op-node-release op-charts/op-node -f values.yaml`

## Requirements
1. K8s 1.8+
Expand Down
15 changes: 15 additions & 0 deletions charts/op-node/example-values/optimism-goerli.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
l2:
rpcAddr: # TODO: place your execution client's RPC address including https:// or wss://
jwtSecret:
file: # TODO: place your execution client's jwtSecret here

p2p:
priv:
file: # TODO: generate your private key for p2p communication with other clients with the following command: `openssl rand -hex 32`.

l1:
rpcAddr: # TODO: place the L1 RPC address including https:// or wss://

resources: {"requests": {"cpu": 2, "memory": "4Gi"}}

args: ["--p2p.sync.req-resp"] # This is an experimental p2p sync feature. It helps blazing-fast node sync.
2 changes: 1 addition & 1 deletion charts/op-node/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ image:
repository: us-docker.pkg.dev/oplabs-tools-artifacts/images/op-node
pullPolicy: IfNotPresent
# Overrides the image tag whose default is the chart appVersion.
tag:
tag: latest

nameOverride: ""
fullnameOverride: ""
Expand Down

0 comments on commit 2011ae2

Please sign in to comment.