Skip to content
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.

Sign up for GitHub

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

Add experimental GCS option to DAS guides #2018

Merged
merged 3 commits into from
Jan 28, 2025
Merged

Add experimental GCS option to DAS guides #2018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
798b86e
Add experimental GCS option to DAS guides
TucksonDev Jan 28, 2025
a690ab8
Update arbitrum-docs/node-running/how-tos/data-availability-committee…
pete-vielhaber Jan 28, 2025
b511fdd
Merge branch 'master' into add-experimental-google-cloud-option
anegg0 Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions ...ing/how-tos/data-availability-committee/partials/parameters/_gcs-parameters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
| Parameter | Description |
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| --data-availability.google-cloud-storage.enable | Enables storage/retrieval of sequencer batch data from a Google Cloud Storage bucket |
| --data-availability.google-cloud-storage.access-token | Google Cloud Storage access token |
| --data-availability.google-cloud-storage.bucket | Google Cloud Storage bucket |
| --data-availability.google-cloud-storage.object-prefix | Prefix to add to Google Cloud Storage objects |
| --data-availability.google-cloud-storage.enable-expiry | Enable expiry of batches (setting it to false, activates the "archive" mode) |
| --data-availability.google-cloud-storage.max-retention | Store requests with expiry times farther in the future than max-retention will be rejected |
11 changes: 11 additions & 0 deletions arbitrum-docs/run-arbitrum-node/data-availability-committees/02-deploy-das.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,15 @@ A DAS can be configured to use one or more of four storage backends:

- [AWS S3](https://aws.amazon.com/s3/) bucket
- Files on local disk
- (**EXPERIMENTAL**) [Google Cloud Storage](https://cloud.google.com/storage) bucket
- (**DEPRECATED**) [Badger](https://dgraph.io/docs/badger/) database on local disk

::::warning Google Cloud Storage is experimental

The Google Cloud Storage option (set with `google-cloud-storage`) is experimental and hasn't been tested thoroughly. It is recommended to not rely solely on this storage option and to use it alongside other storage options.

::::

::::warning Local Badger database deprecated

The local Badger DB storage option (set with `local-db-storage`) has been deprecated and should be replaced with the local files storage option (set with `local-file-storage`).
Expand Down Expand Up @@ -152,6 +159,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import S3Parameters from '../../node-running/how-tos/data-availability-committee/partials/parameters/_s3-parameters.mdx';
import LocalFilesParameters from '../../node-running/how-tos/data-availability-committee/partials/parameters/_local-files-parameters.mdx';
import GoogleCloudStorageParameters from '../../node-running/how-tos/data-availability-committee/partials/parameters/_gcs-parameters.mdx';
import LocalBadgerDBParameters from '../../node-running/how-tos/data-availability-committee/partials/parameters/_local-badger-db-parameters.mdx';

<div className="dynamic-content-tabs">
Expand All @@ -162,6 +170,9 @@ import LocalBadgerDBParameters from '../../node-running/how-tos/data-availabilit
<TabItem value="local-files" label="Local files">
<LocalFilesParameters />
</TabItem>
<TabItem value="gcs-bucket" label="(Experimental) Google Cloud Storage">
<GoogleCloudStorageParameters />
</TabItem>
<TabItem value="badger-db" label="(Deprecated) Local Badger database">
<LocalBadgerDBParameters />
</TabItem>
Expand Down
4 changes: 4 additions & 0 deletions ...um-docs/run-arbitrum-node/data-availability-committees/03-deploy-mirror-das.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import S3Parameters from '../../node-running/how-tos/data-availability-committee/partials/parameters/_s3-parameters.mdx';
import LocalFilesParameters from '../../node-running/how-tos/data-availability-committee/partials/parameters/_local-files-parameters.mdx';
import GoogleCloudStorageParameters from '../../node-running/how-tos/data-availability-committee/partials/parameters/_gcs-parameters.mdx';
import LocalBadgerDBParameters from '../../node-running/how-tos/data-availability-committee/partials/parameters/_local-badger-db-parameters.mdx';

<div className="dynamic-content-tabs">
Expand All @@ -129,6 +130,9 @@ import LocalBadgerDBParameters from '../../node-running/how-tos/data-availabilit
<TabItem value="local-files" label="Local files">
<LocalFilesParameters />
</TabItem>
<TabItem value="gcs-bucket" label="(Experimental) Google Cloud Storage">
<GoogleCloudStorageParameters />
</TabItem>
<TabItem value="badger-db" label="(Deprecated) Local Badger database">
<LocalBadgerDBParameters />
</TabItem>
Expand Down