Skip to content

Replica doc fix#2597

Closed
qbzzt wants to merge 2 commits intodevelopfrom
20220523-replica-doc-fix
Closed

Replica doc fix#2597
qbzzt wants to merge 2 commits intodevelopfrom
20220523-replica-doc-fix

Conversation

@qbzzt
Copy link
Copy Markdown
Contributor

@qbzzt qbzzt commented May 23, 2022

Description

Clearer instructions and somewhat easier configuration

@qbzzt qbzzt requested a review from optimisticben May 23, 2022 19:42
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented May 23, 2022

⚠️ No Changeset found

Latest commit: ccec064

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

| HC_IMAGE_TAG | Health check version | latest (see below)
| SHARED_ENV_PATH          | Path to a directory containing env files                 | [a directory under .../op-replica](https://github.com/ethereum-optimism/optimism/tree/develop/infra/op-replica/envs)
| GCMODE | [Whether to run l2geth as an `archive` or `full` node](https://www.quicknode.com/guides/infrastructure/ethereum-full-node-vs-archive-node) | archive
| L2GETH_IMAGE_TAG         | L2geth version                                           | [Go here](https://hub.docker.com/r/ethereumoptimism/l2geth/tags) and find the latest version. At writing this is 0.5.19 (1).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really don't like the idea of setting a manual tag version in the README. It updates too often and this change is missed.

We should have a way to publish the current versions supported and let user's choose from the list.

This README should point to that list.

| SHARED_ENV_PATH          | Path to a directory containing env files                 | [a directory under .../op-replica](https://github.com/ethereum-optimism/optimism/tree/develop/infra/op-replica/envs)
| GCMODE | [Whether to run l2geth as an `archive` or `full` node](https://www.quicknode.com/guides/infrastructure/ethereum-full-node-vs-archive-node) | archive
| L2GETH_IMAGE_TAG         | L2geth version                                           | [Go here](https://hub.docker.com/r/ethereumoptimism/l2geth/tags) and find the latest version. At writing this is 0.5.19 (1).
| DTL_IMAGE_TAG            | Data transport layer version                             | [Go here](https://hub.docker.com/r/ethereumoptimism/data-transport-layer/tags) and find the latest version. At writing this is 0.5.30 (1).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same with these tags

- .env
volumes:
- dtl:/db
- /var/replica/dtl:/db
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine adding README on how to preserve the data from the replica.
But, this change will clobber whatever the user has on their locale system at the /var/replica path.

If you feel strongly that we should default to host paths instead of docker volumes, the paths should be set in the .env file for the user to review before it makes changes to their system.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jun 7, 2022

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.

@github-actions github-actions bot added the Stale label Jun 7, 2022
@github-actions github-actions bot closed this Jun 12, 2022
@qbzzt qbzzt deleted the 20220523-replica-doc-fix branch July 22, 2022 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants