Merge branch 'main' into sb/rollout-changes

astriaorg · Oct 18, 2023 · 3078372 · 3078372
2 parents d430c84 + 59cbbe5
commit 3078372
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 53 deletions.
diff --git a/docs/dev-cluster/1-overview.md b/docs/dev-cluster/1-overview.md
@@ -27,3 +27,39 @@ section](/docs/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.
diff --git a/docs/dev-cluster/3-deploy-a-local-rollup.md → docs/dev-cluster/2-deploy-a-local-rollup.md b/docs/dev-cluster/3-deploy-a-local-rollup.md → docs/dev-cluster/2-deploy-a-local-rollup.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 2
 ---
 
 # Running a Local Rollup

diff --git a/docs/dev-cluster/2-run-dev-cluster-locally.md b/docs/dev-cluster/2-run-dev-cluster-locally.md
diff --git a/...cluster/4-run-multiple-rollups-locally.md → ...cluster/3-run-multiple-rollups-locally.md b/...cluster/4-run-multiple-rollups-locally.md → ...cluster/3-run-multiple-rollups-locally.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 3
 ---
 
 # Run Multiple Rollups Locally

diff --git a/docs/dev-cluster/5-shutdown.md → docs/dev-cluster/4-shutdown.md b/docs/dev-cluster/5-shutdown.md → docs/dev-cluster/4-shutdown.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 4
 ---
 
 # Shutting Down the Cluster