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

update docs for local deployment of rollup #22

Merged
merged 8 commits into from
Nov 28, 2023
Merged
Changes from 7 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
14 changes: 5 additions & 9 deletions docs/dusknet/2-local-rollup-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,14 @@ dev-cluster](https://github.com/astriaorg/dev-cluster) to setup a local
Kubernetes (k8s) cluster where we will deploy our local rollup.

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

In the __dev-cluster repo__, run:

```sh
git clone [email protected]:astriaorg/dev-cluster.git
cd dev-cluster
just create-cluster
just deploy-ingress-controller
just wait-for-ingress-controller
```

This gives us a local environment compatible with our helm charts.
Expand Down Expand Up @@ -69,11 +66,10 @@ export ROLLUP_GENESIS_ACCOUNTS=<ADDRESS_1>:<BALANCE_1>,<ADDRESS_2>:<BALANCE_2>

## Install the `astria-cli`

Clone the [Astria repo](https://github.com/astriaorg/astria/tree/main) and build
a new config using the `astria-cli`.
Navigate to your [Astria repo](https://github.com/astriaorg/astria/tree/main)
and install the `astria-cli`.
camiinthisthang marked this conversation as resolved.
Show resolved Hide resolved

```bash
git clone [email protected]:astriaorg/astria.git
cd astria
just install-cli
```
Expand All @@ -84,8 +80,8 @@ Replace the tags in the commands and env vars below, as follows:

| Var Name | Var Type | Description |
|-----|-----|-----|
| `<YOUR_ROLLUP_NAME>` | String | The name of your rollup. This must be alphanumeric, `-` is allowed, this will be included in URLs|
| `<YOUR_NETWORK_ID>` | u64 | The id of your network. Pick a > 6 digit number (eg. `123456`) |
| `<YOUR_ROLLUP_NAME>` | String | The name of your rollup. This must be lowercase alphanumeric, `-` is allowed, this will be included in your rollup's URLs.|
| `<YOUR_NETWORK_ID>` | u64 | The id of your network. Pick a >= 6 digit number (eg. `123456`) |
camiinthisthang marked this conversation as resolved.
Show resolved Hide resolved

You can use environment variables to set the configuration for the rollup
config creation. Replace all the `<>` tags with their corresponding values.
Expand Down