Skip to content

Commit 166897f

Browse files
chore: update development environment docs
1 parent 6dbe971 commit 166897f

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

_docs/development-environment.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# Setting-up development environment
22

3-
**Warning**
4-
All links to the `provider` repo are referencing to the `gpu` branch. As soon as `gpu` is merged into `main` all links need update.
53

64
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.
7-
The provider repo elected as placeholder for all the scripts as it depends on the `node` repo (Better explanation?)
5+
The provider repository hosts the shared development scripts because it depends on the `node` repository.
86
Should you already know what this guide is all about - feel free to explore [examples](#how-to-use-runbook)
97

108
## Code
@@ -16,8 +14,8 @@ Checkout below assumes `git` is set to use SSH connection to GitHub
1614

1715
```shell
1816
cd ~/go/src/github.com/akash-network # all commands below assume this as current directory
19-
git clone [email protected]:akash-netowrk/node
20-
git clone [email protected]:akash-netowrk/provider
17+
git clone [email protected]:akash-network/node
18+
git clone [email protected]:akash-network/provider
2119
```
2220

2321
## Requirements
@@ -42,20 +40,20 @@ Currently supported host platforms:
4240

4341
### General behaviour
4442

45-
All examples are located within [_run](https://github.com/akash-network/provider/blob/gpu/_run) directory.
43+
All examples are located within the [_run](https://github.com/akash-network/provider/tree/main/_run) directory.
4644
[Commands](#commands) are implemented as `make` targets.
4745

4846
There are three ways we use to set up the k8s cluster.
4947

5048
- kind
51-
- minukube
49+
- minikube
5250
- ssh
5351

5452
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.
5553

5654
### Runbook
5755

58-
There are four configuration variants, each presented as directory within [_run](https://github.com/akash-network/provider/blob/gpu/_run).
56+
There are four configuration variants, each presented as a directory within [_run](https://github.com/akash-network/provider/tree/main/_run).
5957

6058
- `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.
6159
- `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
9290

9391
##### Keys
9492

95-
Each configuration creates four [keys](https://github.com/akash-network/provider/blob/gpu/_run/common.mk#L40..L43):
96-
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`:
93+
Each configuration creates four [keys](https://github.com/akash-network/provider/blob/main/_run/common.mk#L38-L43):
94+
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`:
9795

9896
```shell
9997
# create provider from **provider** key
@@ -139,14 +137,14 @@ This runbook requires three terminals
139137

140138
__t3 run__
141139
```shell
142-
make provider-create
140+
make provider-run
143141
```
144142

145-
6. Start the provider
143+
6. Query the provider for its status
146144

147145
__t1 run__
148146
```shell
149-
make provider-create
147+
make provider-status
150148
```
151149

152150
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
226224

227225
##### Kube for e2e tests
228226

229-
This runbook requires two terminal
227+
This runbook requires two terminals
230228

231229
1. Open runbook
232230

@@ -240,11 +238,12 @@ This runbook requires two terminal
240238
__t1 run__
241239
```shell
242240
make kube-cluster-setup-e2e
241+
```
243242

244243
3. Run e2e tests
245244

246245
```shell
247-
make test-e2e-intergration
246+
make test-e2e-integration
248247
```
249248

250249
##### Single

0 commit comments

Comments
 (0)