Dev/orch dapp walkthrough documentation #1169
+1,474
−18
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -8,6 +8,9 @@ Here, we will walk through installing the Orchestration-Basics demo project onto | |||||
| - [Setting Up the Local Environment](#setting-up-the-local-environment) | ||||||
| - [Overriding the Chain Registry for use with `agoric-sdk/multichain-testing`](#overriding-the-chain-registry-for-use-with-agoric-sdkmultichain-testing) | ||||||
| - [Multichain-Testing Makefile Helpers](#multichain-testing-makefile-helpers) | ||||||
| - [Troubleshooting Docker](#troubleshooting-docker) | ||||||
| - [Disable Kubernetes](#disable-kubernetes) | ||||||
| - [Increasing resources allocated to docker](#increasing-resources-allocated-to-docker) | ||||||
| - [Adding a New Address](#adding-a-new-address) | ||||||
| - [Funding the Account](#funding-the-account) | ||||||
| - [Building \& Deploying the dApp](#building--deploying-the-dapp) | ||||||
|
|
@@ -106,6 +109,19 @@ If you need to restart your environment for any reason, use the following comman | |||||
| 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 |
||||||
| 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 |
||||||
| Inside of "settings", navigate to the "kubernetes" section. Here, you want to ensure that you deselect the "Enable Kubernetes" checkbox | ||||||
| <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. 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.
Suggested change
|
||||||
|
|
||||||
| <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? |
||||||
|
|
||||||
| 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: | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a) targets are run sequentially afaik so we can use it like this
b) better yet, thoughts on adding a restart target in the Makefile helpers above?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
makes sense to me.