-
Notifications
You must be signed in to change notification settings - Fork 57
chore: update development environment docs #336
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
Closed
rick-a-lane-ii
wants to merge
1
commit into
akash-network:main
from
rick-a-lane-ii:rick/development-environment
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -1,10 +1,8 @@ | ||
| # Setting-up development environment | ||
|
|
||
| **Warning** | ||
| All links to the `provider` repo are referencing to the `gpu` branch. As soon as `gpu` is merged into `main` all links need update. | ||
|
|
||
| This page covers setting up development environment for both [node](https://github.com/akash-network/node) and [provider](https://github.com/akash-network/provider) repositories. | ||
| The provider repo elected as placeholder for all the scripts as it depends on the `node` repo (Better explanation?) | ||
| The provider repository hosts the shared development scripts because it depends on the `node` repository. | ||
| Should you already know what this guide is all about - feel free to explore [examples](#how-to-use-runbook) | ||
|
|
||
| ## Code | ||
|
|
@@ -16,8 +14,8 @@ Checkout below assumes `git` is set to use SSH connection to GitHub | |
|
|
||
| ```shell | ||
| cd ~/go/src/github.com/akash-network # all commands below assume this as current directory | ||
| git clone [email protected]:akash-netowrk/node | ||
| git clone [email protected]:akash-netowrk/provider | ||
| git clone [email protected]:akash-network/node | ||
| git clone [email protected]:akash-network/provider | ||
| ``` | ||
|
|
||
| ## Requirements | ||
|
|
@@ -42,20 +40,20 @@ Currently supported host platforms: | |
|
|
||
| ### General behaviour | ||
|
|
||
| All examples are located within [_run](https://github.com/akash-network/provider/blob/gpu/_run) directory. | ||
| All examples are located within the [_run](https://github.com/akash-network/provider/tree/main/_run) directory. | ||
| [Commands](#commands) are implemented as `make` targets. | ||
|
|
||
| There are three ways we use to set up the k8s cluster. | ||
|
|
||
| - kind | ||
| - minukube | ||
| - minikube | ||
| - ssh | ||
|
|
||
| Both `kind` and `minikube` are e2e, i.e. the configuration is capable of spinning up cluster and the local host, whereas `ssh` expects cluster to be configured before use. | ||
|
|
||
| ### Runbook | ||
|
|
||
| There are four configuration variants, each presented as directory within [_run](https://github.com/akash-network/provider/blob/gpu/_run). | ||
| There are four configuration variants, each presented as a directory within [_run](https://github.com/akash-network/provider/tree/main/_run). | ||
|
|
||
| - `kube` - uses `kind` to set up local cluster. It is widely used by e2e testing of the provider. Provider and the node run as host services. All operators run as kubernetes deployments. | ||
| - `single` - uses `kind` to set up local cluster. Main difference is both node and provider (and all operators) are running within k8s cluster as deployments. (at some point we will merge `single` | ||
|
|
@@ -92,8 +90,8 @@ TBD | |
|
|
||
| ##### Keys | ||
|
|
||
| Each configuration creates four [keys](https://github.com/akash-network/provider/blob/gpu/_run/common.mk#L40..L43): | ||
| They keys are assigned to the targets and under normal circumstances there is no need to alter it. However, it can be done with setting `KEY_NAME`: | ||
| Each configuration creates four [keys](https://github.com/akash-network/provider/blob/main/_run/common.mk#L38-L43): | ||
| The keys are assigned to the targets and under normal circumstances there is no need to alter them. However, it can be done by setting `KEY_NAME`: | ||
|
|
||
| ```shell | ||
| # create provider from **provider** key | ||
|
|
@@ -139,14 +137,14 @@ This runbook requires three terminals | |
|
|
||
| __t3 run__ | ||
| ```shell | ||
| make provider-create | ||
| make provider-run | ||
| ``` | ||
|
|
||
| 6. Start the provider | ||
| 6. Query the provider for its status | ||
|
|
||
| __t1 run__ | ||
| ```shell | ||
| make provider-create | ||
| make provider-status | ||
| ``` | ||
|
|
||
| 7. __t1__ Create a deployment. Check that the deployment was created. Take note of the `dseq` - deployment sequence: | ||
|
|
@@ -226,7 +224,7 @@ This runbook requires three terminals | |
|
|
||
| ##### Kube for e2e tests | ||
|
|
||
| This runbook requires two terminal | ||
| This runbook requires two terminals | ||
|
|
||
| 1. Open runbook | ||
|
|
||
|
|
@@ -240,11 +238,12 @@ This runbook requires two terminal | |
| __t1 run__ | ||
| ```shell | ||
| make kube-cluster-setup-e2e | ||
| ``` | ||
|
|
||
| 3. Run e2e tests | ||
|
|
||
| ```shell | ||
| make test-e2e-intergration | ||
| make test-e2e-integration | ||
| ``` | ||
|
|
||
| ##### Single | ||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.