diff --git a/docs/dev-cluster/1-overview.md b/docs/dev-cluster/1-overview.md index d787e8c..1e52655 100644 --- a/docs/dev-cluster/1-overview.md +++ b/docs/dev-cluster/1-overview.md @@ -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. diff --git a/docs/dev-cluster/3-deploy-a-local-rollup.md b/docs/dev-cluster/2-deploy-a-local-rollup.md similarity index 98% rename from docs/dev-cluster/3-deploy-a-local-rollup.md rename to docs/dev-cluster/2-deploy-a-local-rollup.md index 14aeb41..618f760 100644 --- a/docs/dev-cluster/3-deploy-a-local-rollup.md +++ b/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 deleted file mode 100644 index a8babe4..0000000 --- a/docs/dev-cluster/2-run-dev-cluster-locally.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Running the Dev Cluster Locally - -:::tip -To deploy your own rollup on the Astria Dusknet devnet, check out the -[instructions here](/docs/running-a-rollup-on-astria-dusknet/overview/)! -::: - -## 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 -# create control plane cluster -just create-cluster -# ingress controller -just deploy-ingress-controller -# wait for ingress. -just wait-for-ingress-controller -# Deploys 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. - -Now that the sequencer and DA are running, the next step is to deploy a rollup. diff --git a/docs/dev-cluster/4-run-multiple-rollups-locally.md b/docs/dev-cluster/3-run-multiple-rollups-locally.md similarity index 99% rename from docs/dev-cluster/4-run-multiple-rollups-locally.md rename to docs/dev-cluster/3-run-multiple-rollups-locally.md index 5ab19eb..ea57ce6 100644 --- a/docs/dev-cluster/4-run-multiple-rollups-locally.md +++ b/docs/dev-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 b/docs/dev-cluster/4-shutdown.md similarity index 97% rename from docs/dev-cluster/5-shutdown.md rename to docs/dev-cluster/4-shutdown.md index 057aaf4..8b47759 100644 --- a/docs/dev-cluster/5-shutdown.md +++ b/docs/dev-cluster/4-shutdown.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 4 --- # Shutting Down the Cluster diff --git a/docs/running-a-rollup-on-astria-dusknet/1-overview.md b/docs/running-a-rollup-on-astria-dusknet/1-overview.md index dcf093c..ee4b78b 100644 --- a/docs/running-a-rollup-on-astria-dusknet/1-overview.md +++ b/docs/running-a-rollup-on-astria-dusknet/1-overview.md @@ -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: