docs: add cluter deployment info
continuous-integration/drone/push Build is failing Details

This commit is contained in:
William Luke 2022-03-16 09:18:29 +03:00
parent 0fcf2eb3bc
commit 941b9e6b65
2 changed files with 35 additions and 7 deletions

View File

@ -9,10 +9,35 @@ token deployments.
pip install --extra-index-url https://pip.grassrootseconomics.net cic[eth]
```
## Setup
### Importing a wallet from metamask
- Export the accounts private key [Instructions](https://metamask.zendesk.com/hc/en-us/articles/360015289632-How-to-Export-an-Account-Private-Key)
- Save the private key to a file
- Run `eth-keyfile -k <file> > ~/.config/cic/keystore/keyfile.json`
### Requirements
- Install [poetry](https://python-poetry.org/docs/#installation)
<details>
<summary>Install Kubectl</summary>
```bash
sudo apt-get update
sudo apt-get install -y apt-transport-https ca-certificates curl
sudo curl -fsSLo /usr/share/keyrings/kubernetes-archive-keyring.gpg https://packages.cloud.google.com/apt/doc/apt-key.gpg
echo "deb [signed-by=/usr/share/keyrings/kubernetes-archive-keyring.gpg] https://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee /etc/apt/sources.list.d/kubernetes.list
sudo apt-get update
sudo apt-get install -y kubectl
```
</details>
### Deploy to the testnet
- Download testnet cluster config from https://cloud.digitalocean.com/kubernetes/clusters
- Move the config to `$HOME/.kube/`
- Run `kubectl -n grassroots --kubeconfig=$HOME/.kube/<config_file_name>.yaml get pods`
- Copy the name of the meta pod (e.g `cic-meta-server-67dc7c6468-8rhdq`)
- Port foward the meta pod to the local machine using `kubectl port-forward pods/<name_of_meta_pod> 6700:8000 -n grassroots --kubeconfig=$HOME/.kube/<config_file_name>.yaml`
- Clone this repository to your local machine
- Run `poetry install -E eth` in the repo root
- Open `./config/testnet/config.ini` and change
- [auth]keyfile_path
- [wallet]key_file
- Open a new terminal and run `poetry run cic wizard -c ./config/testnet ./somewhere`
## Usage
### Using the wizard
@ -51,8 +76,7 @@ state of the package contains interface to EVM only. Thus, the examples
below are limited to the context of the EVM.
## Development
### Requirements
- [poetry](https://python-poetry.org/docs/#installation)
### Setup
```
@ -68,6 +92,10 @@ below are limited to the context of the EVM.
```bash
poetry run cic wizard ./somewhere -c ./config/docker
```
### Importing a wallet from metamask
- Export the accounts private key [Instructions](https://metamask.zendesk.com/hc/en-us/articles/360015289632-How-to-Export-an-Account-Private-Key)
- Save the private key to a file
- Run `eth-keyfile -k <file> > ~/.config/cic/keystore/keyfile.json`
### Tests

View File

@ -48,7 +48,7 @@ chainlib = "~0.0.17"
cbor2 = "5.4.1"
chainlib-eth = { version = "~0.0.25", optional = true }
eth-token-index = { version = "0.2.4", optional = true }
eth-token-index = { version = "~0.2.4", optional = true }
eth-address-index = { version = "~0.2.4", optional = true }
okota = { version = "~0.2.5", optional = true }
cic_eth_registry = { version = "~0.6.6", optional = true }