Skip to content

Commit

Permalink
add todos for cli updates and grafana dashboard img
Browse files Browse the repository at this point in the history
  • Loading branch information
dghelm committed Oct 31, 2024
1 parent 23c746e commit cc4ba7d
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 21 deletions.
4 changes: 4 additions & 0 deletions src/content/docs/en/sdk/guides/aws-deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ Ensure you have the following tools installed on your local machine:
- [scroll-sdk-cli](https://www.npmjs.com/package/scroll-sdk-cli)
- [k9s](https://k9scli.io/topics/install/) (optional, but recommended for cluster management)

{/* TODO: Replace with new cli url */}

Make sure to follow the installation instructions for each tool on their respective websites. For `kubectl`, you can refer to the detailed installation steps provided in the [Amazon EKS documentation](https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html).

To install the scroll-sdk-cli, run:
Expand All @@ -53,6 +55,8 @@ To install the scroll-sdk-cli, run:
npm install -g scroll-sdk-cli
```

{/* TODO: Replace with new command */}

Verify your setup by running:

```bash
Expand Down
46 changes: 26 additions & 20 deletions src/content/docs/en/sdk/guides/devnet-deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ You can enable it in the `values.yaml` file if wanting to locally test external
- `helm version`
- `node -v`
- `scrollsdk`
- Or, in one step: `scrollsdk test dependencies`
- Or, in one step: `scrollsdk test dependencies --dev`

{/* TODO: Update the cli command to use the new `scrollsdk` install command */}

</Steps>
</Fragment>
Expand Down Expand Up @@ -123,6 +125,7 @@ You can enable it in the `values.yaml` file if wanting to locally test external
nvm install 20
npm install -g scroll-sdk-cli
```
{/* TODO: Update the cli command to use the new `scrollsdk` install command */}

7. You should now be able to open a terminal and run the following:
- `docker -v`
Expand All @@ -131,7 +134,7 @@ You can enable it in the `values.yaml` file if wanting to locally test external
- `helm version`
- `node -v`
- `scrollsdk`
- Or, in one step: `scrollsdk test dependencies`
- Or, in one step: `scrollsdk test dependencies --dev`
</Steps>
</Fragment>
</TabsContent>
Expand Down Expand Up @@ -253,17 +256,19 @@ Running `kubectl get ingress` should show all the domains setup within the clust

```
➜ scroll-sdk git:(develop) ✗ kubectl get ingress
NAME CLASS HOSTS ADDRESS PORTS AGE
admin-system-dashboard nginx admin-system-dashboard.scrollsdk 192.168.49.2 80 5h3m
blockscout nginx blockscout.scrollsdk 192.168.49.2 80 5h3m
bridge-history-api nginx bridge-history-api.scrollsdk 192.168.49.2 80 5h3m
frontends nginx frontends.scrollsdk 192.168.49.2 80 5h3m
grafana nginx grafana.scrollsdk 192.168.49.2 80 5h3m
l1-devnet nginx l1-devnet.scrollsdk 192.168.49.2 80 5h3m
l1-explorer nginx l1-devnet-explorer.scrollsdk 192.168.49.2 80 5h3m
l2-rpc nginx l2-rpc.scrollsdk 192.168.49.2 80 5h3m
l2-rpc-websocket nginx l2-rpc-ws.scrollsdk 192.168.49.2 80 5h3m
rollup-explorer-backend nginx rollup-explorer-backend.scrollsdk 192.168.49.2 80 5h3m
NAME CLASS HOSTS ADDRESS PORTS AGE
admin-system-dashboard nginx admin-system-dashboard.scrollsdk 192.168.49.2 80 5h3m
blockscout-backend-ingress nginx blockscout-backend.scrollsdk 192.168.49.2 80 5h3m
blockscout-frontend-ingress nginx blockscout.scrollsdk 192.168.49.2 80 5h3m
bridge-history-api nginx bridge-history-api.scrollsdk 192.168.49.2 80 5h3m
frontends nginx frontends.scrollsdk 192.168.49.2 80 5h3m
grafana nginx grafana.scrollsdk 192.168.49.2 80 5h3m
l1-devnet nginx l1-devnet.scrollsdk 192.168.49.2 80 5h3m
l1-explorer-blockscout-ingress nginx l1-explorer-backend.scrollsdk 192.168.49.2 80 5h3m
l1-explorer-frontend-ingress nginx l1-explorer.scrollsdk 192.168.49.2 80 5h3m
l2-rpc nginx l2-rpc.scrollsdk 192.168.49.2 80 5h3m
l2-rpc-websocket nginx l2-rpc-ws.scrollsdk 192.168.49.2 80 5h3m
rollup-explorer-backend nginx rollup-explorer-backend.scrollsdk 192.168.49.2 80 5h3m
```

<TabsContent sharedStore="os" client:visible>
Expand Down Expand Up @@ -330,17 +335,18 @@ To resolve the ingress domains, we need to add the minikube IP and our service h
3. Add the following entries to the file, replacing `192.168.49.2` with your minikube IP if different:
```
192.168.49.2 l1-devnet.scrollsdk
192.168.49.2 bridge-history.scrollsdk
192.168.49.2 admin-system-dashboard.scrollsdk
192.168.49.2 blockscout-backend.scrollsdk
192.168.49.2 blockscout.scrollsdk
192.168.49.2 bridge-history-api.scrollsdk
192.168.49.2 frontends.scrollsdk
192.168.49.2 grafana.scrollsdk
192.168.49.2 l1-devnet-explorer.scrollsdk
192.168.49.2 l1-devnet.scrollsdk
192.168.49.2 l1-explorer-backend.scrollsdk
192.168.49.2 l1-explorer.scrollsdk
192.168.49.2 l2-rpc.scrollsdk
192.168.49.2 blockscout.scrollsdk
192.168.49.2 bridge-history-api.scrollsdk
192.168.49.2 rollup-explorer-backend.scrollsdk
192.168.49.2 l2-rpc-ws.scrollsdk
192.168.49.2 admin-system-dashboard.scrollsdk
192.168.49.2 rollup-explorer-backend.scrollsdk
```
4. Save the file by pressing `Ctrl+X`, then `Y`, then `Enter`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Scroll SDK is still in development, so certain pieces of guides may see breaking
- doctl *(optional)*
- k9s *(optional)*

{/* TODO: Update URL to use new package name and command below */}

To install the scroll-sdk-cli, run `npm install -g scroll-sdk-cli`

Then, run `scrollsdk test dependencies` to test that the tool works and to check the required dependencies listed above.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion src/content/docs/en/sdk/operation/monitoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import Aside from "../../../../../components/Aside.astro"
import ClickToZoom from "../../../../../components/ClickToZoom.astro";
import AdminSystemDashboard from "./_images/admin-system-dashboard-batch-view.png"
import Alertmanager from "./_images/alertmanager.png"
import Grafana from "./_images/grafana.png"

Scroll SDK provides a comprehensive monitoring system to ensure the health and performance of the network. This section provides an overview of the monitoring tools and best practices for using them.

Expand All @@ -31,7 +32,7 @@ We've build and made available a few Grafana dashboards for Scroll SDK chains. T

You can access these from the `scroll-sdk` repo [here](https://github.com/scroll-tech/scroll-sdk/tree/develop/charts/scroll-monitor/grafana/scroll-dashboards).

{/* TODO: Add a screenshot of a service dashboard. */}
<ClickToZoom src={Grafana} alt="Rollup Node Dashboard" />
{/* <Aside type="caution">
Although these are configured to work out-of-the-box with the devnet deployment, you may need to make modifications if you're using your own Prometheus or Grafana configurations.
</Aside> */}
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/en/sdk/technical-stack/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ excerpt: "Information on configuring and customizing a Scroll SDK deployment."
import Aside from "../../../../../components/Aside.astro"

Initial change configuration is made by modifying `config.toml`. All other config files are auto-generated from this file. For automating changes to your configuration for production deployments, see the [scroll-sdk-cli](/en/sdk/technical-stack/scroll-sdk-cli) tool.
{/* TODO: Fix CLI URL to point to github repo */}

For new production deployments, we recommend using the [example template](https://github.com/scroll-tech/scroll-sdk/blob/develop/examples/config.toml.example), which the `scroll-sdk-cli` tool is designed to work with. You can reference the default devnet configuration [here](https://github.com/scroll-tech/scroll-sdk/blob/develop/charts/scroll-sdk/config.toml).

Expand Down

0 comments on commit cc4ba7d

Please sign in to comment.