Dev/orch dapp walkthrough documentation #1169
Conversation
Deploying documentation with
|
| Latest commit: |
5319631
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d0034bb0.documentation-7tp.pages.dev |
| Branch Preview URL: | https://dev-orch-dapp-walkthrough.documentation-7tp.pages.dev |
|
Cloudflare deployment logs are available here |
| ## Troubleshooting Docker | ||
| During setting up the environment, you may run into a few issues with docker. Here are two common setup requirements. | ||
|
|
||
| ### Disable Kubernetes |
There was a problem hiding this comment.
I thought we have to enable it, not disable it. That's what I had to do.
There was a problem hiding this comment.
Also, we should recommend somewhere to click the "reset k8s cluster" button before spinning it up
| <img src="../../assets/docker-kube.png" width="100%" /> | ||
|
|
||
| ### Increasing resources allocated to docker | ||
| From inside of "settings", navigate to the "Resources" section. By default docker doesn't optimize the resources allocated for running resource-intensive environments. For this environment, we want to ensure our `CPU limit`, `Memory Limit`, and `Swap` are all bumped up to 75% their max. You can always increase/decrease after you get everything setup, and determine how much resources are needed for your machine. |
There was a problem hiding this comment.
I think the % depends on your machine. For me, 10GB memory worked, while 8GB did not. My swap was at 1GB in both cases.
| **Check Agoric Daemon Status** | ||
| Verify that the Agoric daemon is running with the following command: | ||
| ```bash | ||
| agd status |
There was a problem hiding this comment.
Neither the agoric-sdk README nor anywhere here do we mention anything remotely related to setting up the agd CLI. I followed the steps in this doc to set it up
There was a problem hiding this comment.
@mujahidkay and I wrote it in this document after learning it firsthand from @Jovonni :-)
But you are right this needs to go somewhere. Maybe @mujahidkay can find an appropriate place in docs to insert this information, and then we can link it here?
| Run the following commands from the `agoric-sdk/multichain-testing/` directory: | ||
|
|
||
| ```bash | ||
| make override-chain-registry |
There was a problem hiding this comment.
I had to make the following change in the Makefile to make this command work. We need to update a few things in the README over at agoric-sdk/multichain-testing
| **Restart the Environment** | ||
| If you need to restart your environment for any reason, use the following command from `agoric-sdk/multichain-testing`: | ||
| ```bash | ||
| make teardown ; make stop; make stop-forward; make clean; make; make port-forward |
There was a problem hiding this comment.
a) targets are run sequentially afaik so we can use it like this
| make teardown ; make stop; make stop-forward; make clean; make; make port-forward | |
| make teardown stop stop-forward clean setup port-forward |
b) better yet, thoughts on adding a restart target in the Makefile helpers above?
| During setting up the environment, you may run into a few issues with docker. Here are two common setup requirements. | ||
|
|
||
| ### Enabling Kubernetes | ||
| Inside of "settings", navigate to the "kubernetes" section. Here, you want to ensure that you select the "Enable Kubernetes" checkbox. You will have to restart docker to make these changes take effect. This is something to keep this in mind if you have any containers that are currently running. |
There was a problem hiding this comment.
| Inside of "settings", navigate to the "kubernetes" section. Here, you want to ensure that you select the "Enable Kubernetes" checkbox. You will have to restart docker to make these changes take effect. This is something to keep this in mind if you have any containers that are currently running. | |
| Inside of "Settings", navigate to the "Kubernetes" section. Here, you want to ensure that you select the "Enable Kubernetes" checkbox. You will have to restart docker to make these changes take effect. This is something to keep in mind if you have any containers that are currently running. |
| <img src="../../assets/docker-kube.png" width="100%" /> | ||
|
|
||
| ### Increasing resources allocated to docker | ||
| From inside of "settings", navigate to the "Resources" section. By default docker doesn't optimize the resources allocated for running resource-intensive environments. For this environment, we want to ensure our `CPU limit`, `Memory Limit`, and `Swap` are all bumped up to 75% their max. You can always increase/decrease after you get everything setup, and determine how much resources are needed for your machine. |
There was a problem hiding this comment.
I also think this number will be different for different people. I had to bump up my memory to 15GB for the pods to be up and running under 15 minutes.
| From inside of "settings", navigate to the "Resources" section. By default docker doesn't optimize the resources allocated for running resource-intensive environments. For this environment, we want to ensure our `CPU limit`, `Memory Limit`, and `Swap` are all bumped up to 75% their max. You can always increase/decrease after you get everything setup, and determine how much resources are needed for your machine. | |
| From inside of "Settings", navigate to the "Resources" section. By default, docker doesn't optimize the resources allocated for running resource-intensive environments. For this environment, we want to ensure our `CPU limit`, `Memory Limit`, and `Swap` are all bumped up to 75% their max. You can always increase/decrease after you get everything setup, and determine how much resources are needed for your machine. |
| Before deploying the contract, we want to generate a new address using the keyring inside of the localchain environment. To add a new address to the keychain inside the Kubernetes pod, run the following command from the top-level directory: | ||
|
|
||
| ```bash | ||
| make add-address | ||
| ``` | ||
|
|
||
| Now, inside of `contract/`, paste the resulting `agoric1` prefixed address into the `Makefile` under the `ADDR`variable. |
There was a problem hiding this comment.
This is very confusing due to the last line. My initial thoughts were that we need to run Also, note that there is no make add-address in dapp-orchestration-basics root workspace but the absence of a Makefile there redirected me to consider agoric-sdk folder since it says top-level directory. But that's not the case either. We can make the following changes to clear up that confusion.ADDR variable in that Makefile - did you mean ACCT_ADDR?
Edit: I was using the wrong branch to test the setup.
| To now fund the account we just generated, we run the following command from the top-level directory. | ||
|
|
||
| ```bash | ||
| make fund | ||
| ``` |
There was a problem hiding this comment.
I am unable to proceed past this step. Which Makefile has this fund target? I can only see fund-wallet under multichain-testing and fund-acct under dapp-orchestration-basics/contract
Edit: I was using the wrong branch to test the setup. orca-v1 does have the targets, thanks @amessbee for unblocking!
There was a problem hiding this comment.
good q @mujahidkay , this is from dapp-orchestration-basics top-level directory:
https://github.com/Agoric/dapp-orchestration-basics/blob/d43ebe67012a85ac404d76687bf91f9571b10594/Makefile#L9
which is just calling:
yarn workspace dapp-agoric-orca-contract fundwhich then just calls the fund as convenience:
https://github.com/Agoric/dapp-orchestration-basics/blob/d43ebe67012a85ac404d76687bf91f9571b10594/contract/package.json#L26
| # Agoric Orchestration Basics Installation Guide | ||
| Here, we will walk through installing the Orchestration-Basics demo project onto your local machine. | ||
|
|
||
| ## Table of Contents |
There was a problem hiding this comment.
Probably, remove this table as there is a default one in the right side panel? What do you think?
| - an Osmosis node | ||
| - an Agoric <-> Gaia hermes relayer | ||
| - an Agoric <-> Osmosis hermes relayer | ||
|
|
There was a problem hiding this comment.
| - a Gaia <-> Osmosis hermes relayer | |
| - chain registry node |
| ``` | ||
|
|
||
| ## Multichain-Testing Makefile Helpers | ||
| To streamline your workflow, you can add the following commands to the bottom of your `multichain-testing/Makefile`: |
There was a problem hiding this comment.
Shouldn't this be a PR in agoric-sdk to update Makefile there rather than asking devs to do it locally?
There was a problem hiding this comment.
ideally yes. we did capture it in this issue here @amessbee:
Agoric/agoric-sdk#9856
| make teardown ; make stop; make stop-forward; make clean; make; make port-forward | ||
| ``` | ||
|
|
||
| ## Troubleshooting Docker |
There was a problem hiding this comment.
This is absolutely necessary - thanks for doing this!
There was a problem hiding this comment.
We can probably have a separate page for troubleshooting and not just for Docker, that can be updated more frequently than this page? What are your thoughts on this? @Jovonni
| <img src="../../assets/docker-resources.png" width="100%" /> | ||
|
|
||
|
|
||
| ## Adding a New Address |
There was a problem hiding this comment.
A line or two about the reasoning behind would be very appreciated by devs IMO. To answer questions like: why are we doing this? what/where is this new address needed for?
documentation for orchestration-basics walkthrough: