You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/development-environment.md
+14-15Lines changed: 14 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,8 @@
1
1
# Setting-up development environment
2
2
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.
5
3
6
4
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.
8
6
Should you already know what this guide is all about - feel free to explore [examples](#how-to-use-runbook)
9
7
10
8
## Code
@@ -16,8 +14,8 @@ Checkout below assumes `git` is set to use SSH connection to GitHub
16
14
17
15
```shell
18
16
cd~/go/src/github.com/akash-network # all commands below assume this as current directory
@@ -42,20 +40,20 @@ Currently supported host platforms:
42
40
43
41
### General behaviour
44
42
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.
46
44
[Commands](#commands) are implemented as `make` targets.
47
45
48
46
There are three ways we use to set up the k8s cluster.
49
47
50
48
- kind
51
-
-minukube
49
+
-minikube
52
50
- ssh
53
51
54
52
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.
55
53
56
54
### Runbook
57
55
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).
59
57
60
58
-`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.
61
59
-`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
92
90
93
91
##### Keys
94
92
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`:
97
95
98
96
```shell
99
97
# create provider from **provider** key
@@ -139,14 +137,14 @@ This runbook requires three terminals
139
137
140
138
__t3 run__
141
139
```shell
142
-
make provider-create
140
+
make provider-run
143
141
```
144
142
145
-
6.Start the provider
143
+
6.Query the provider for its status
146
144
147
145
__t1 run__
148
146
```shell
149
-
make provider-create
147
+
make provider-status
150
148
```
151
149
152
150
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
226
224
227
225
##### Kube for e2e tests
228
226
229
-
This runbook requires two terminal
227
+
This runbook requires two terminals
230
228
231
229
1. Open runbook
232
230
@@ -240,11 +238,12 @@ This runbook requires two terminal
0 commit comments