Skip to content

Commit

Permalink
cleanup some uncessary tasks; add helpful info (#42)
Browse files Browse the repository at this point in the history
## Description
<!-- Describe your changes in detail -->
- Remove unnecessary dev-cluster cloning step from Digital Ocean guide
- Add a step to the astria-cli installation to move the binary into the
shell path
- Add a note for required cluster node sizing (for celestia pod)
- Add a note for rollup name length limitations
- K8s label names are limited to 63 chars. One of the labels concats the
rollup name with `-celestia-node-light-mocha-4-token-service`
effectively limiting the current max length of a rollup name to 21
chars.

## Motivation and Context
<!-- Why is this change required? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here. -->
This will help users follow the guide while avoiding pitfalls and errors

## Types of changes
<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [x] Edits to existing documentation
- [ ] Changing documentation structure (relocating existing files,
ensure redirects exist)
- [ ] Stylistic changes (provide screenshots above)
  • Loading branch information
mycodecrafting committed Mar 4, 2024
1 parent 6e19924 commit 3895bea
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
8 changes: 6 additions & 2 deletions docs/cloud-rollup/digital-ocean.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ a Kubernetes cluster on Digital Ocean which uses the Astria shared sequencer net

## Local Dependencies

### Install the latest Astria cli
import RemoteCli from '../components/_cli-cloud.mdx';

<RemoteCli />
Expand All @@ -29,6 +28,11 @@ Install and configure `doctl`: [https://docs.digitalocean.com/reference/doctl/ho
Follow the instructions in Digital Ocean's [Quick Start Guide](https://docs.digitalocean.com/products/kubernetes/getting-started/)
to create a new cluster in the region of your choosing.

:::tip
The celestia pod has a minimum requirement of 1vCPU and 4GB RAM and will not start if the
cluster has no nodes that meet those requirements. You will need a node with >1vCPU and >4GB RAM.
:::

## Configure `kubectl` with `doctl`

Once your k8s cluster is created configure `kubectl`.
Expand Down Expand Up @@ -132,7 +136,7 @@ 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_ROLLUP_NAME>` | String | The name of your rollup. This must be alphanumeric, `-` is allowed, this will be included in URLs. Must not be more than 21 characters.|
| `<YOUR_NETWORK_ID>` | u64 | The id of your network. Pick a > 6 digit number (eg. `123456`) |
| `<YOUR_HOSTNAME>` | String | The chosen hostname for your network (eg. `astria.org`) |

Expand Down
9 changes: 3 additions & 6 deletions docs/components/_astria-cli-install.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
### Clone the Astria [dev-cluster](https://github.com/astriaorg/dev-cluster/tree/main)

```bash
git clone --branch dusk-3 https://github.com/astriaorg/dev-cluster.git
```

### Install the latest [astria cli](https://github.com/astriaorg/astria/releases/tag/cli-v0.2.2)

import Tabs from '@theme/Tabs';
Expand All @@ -15,6 +9,7 @@ import TabItem from '@theme/TabItem';
```bash
curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.3.1/astria-cli-aarch64-apple-darwin.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
mv astria-cli /usr/local/bin/
```

</TabItem>
Expand All @@ -23,6 +18,7 @@ import TabItem from '@theme/TabItem';
```bash
curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.3.1/astria-cli-x86_64-apple-darwin.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
mv astria-cli /usr/local/bin/
```

</TabItem>
Expand All @@ -31,6 +27,7 @@ import TabItem from '@theme/TabItem';
```bash
curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.3.1/astria-cli-x86_64-unknown-linux-gnu.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
mv astria-cli /usr/local/bin/
```

</TabItem>
Expand Down
7 changes: 6 additions & 1 deletion docs/local-rollup/1-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@ If you would like to deploy a rollup on a remote Kubernetes cluster,
This guide has been tested on MacOS and Linux but not Windows
:::

### Install the latest Astria cli
### Clone the Astria [dev-cluster](https://github.com/astriaorg/dev-cluster/tree/main)

```bash
git clone --branch dusk-3 https://github.com/astriaorg/dev-cluster.git
```

import LocalCli from '../components/_cli-local.mdx';

<LocalCli />
Expand Down

0 comments on commit 3895bea

Please sign in to comment.