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.

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

Updates to intro sections and just commands for cluster deploys #6

Merged
merged 7 commits into from
Oct 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 36 additions & 0 deletions docs/dev-cluster/1-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,39 @@ section](/docs/running-a-rollup-on-astria-dusknet/local-rollup-deployment/).
:::

See the [dev-cluster repo here.](https://github.com/astriaorg/dev-cluster)

## Running the Dev Cluster Locally

### Installation
You will need to pull both the [dev-cluster](https://github.com/astriaorg/dev-cluster) and [astria-web3](https://github.com/astriaorg/astria-web3) repos from our github.

Install the necessary dependencies and tools listed for each repo:

* docker - https://docs.docker.com/get-docker/
* kubectl - https://kubernetes.io/docs/tasks/tools/
* helm - https://helm.sh/docs/intro/install/
* kind - https://kind.sigs.k8s.io/docs/user/quick-start/#installation
* just - https://just.systems/man/en/chapter_4.html

For contract deployment:

* Forge (part of Foundry) - https://book.getfoundry.sh/getting-started/installation

### Deployment

:::tip
Make sure that Docker is running before deploying with `just`.
:::

To deploy the Astria Sequencer and a local DA, open a terminal in the dev-cluster directory and run the commands:
```bash
# Deploys ingress + Sequencer + local DA
just deploy-astria-local
```

This may take a minute or two if this the first time you are deploying as quite
a few containers need to be downloaded. Once the command completes, all elements
of the dev-cluster will be up and running. This does not run a rollup, block
explorer, or faucet.

You can now deploy a rollup.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 2
---

# Running a Local Rollup
Expand Down
50 changes: 0 additions & 50 deletions docs/dev-cluster/2-run-dev-cluster-locally.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 3
---

# Run Multiple Rollups Locally
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 4
---

# Shutting Down the Cluster
Expand Down
9 changes: 1 addition & 8 deletions docs/running-a-rollup-on-astria-dusknet/1-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,7 @@ sidebar_position: 1

# Overview

After running the Astria stack locally, the next step is to run a rollup against
the remote Astria network.

The primary difference between running a local rollup and one that targets the
remote devnet, is the configuration of the rollup and creating an account for
the Sequencer.

As before with running a local dev-cluster, you will need to have the
To deploy a remote Rollup on Dusknet, you will need to have the
[dev-cluster](https://github.com/astriaorg/dev-cluster/tree/main) and the main
[astria repo](https://github.com/astriaorg/astria) cloned and on your machine,
and also have the following dependencies installed:
Expand Down