d0zingcat/deploy
1
0
Fork 0
mirror of https://github.com/d0zingcat/deploy.git synced 2026-05-23 15:10:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

multiple gateway WIP

Browse Source
This commit is contained in:
Michael Feng
2023-04-05 16:13:54 -07:00
parent 6bcdff4a3d
commit ae0c0d1977
4 changed files with 218 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

237
multiple_hummingbot_gateway_compose/README.md
View File

@@ -1,61 +1,210 @@
# Deploy Hummingbot and Gateway Instances
# Deploy Multiple Hummingbot Instances Linked to Gateway
## How to use it
This installs two [Hummingbot](https://github.com/hummingbot/hummingbot) instances, linked to a single [Hummingbot Gateway](https://github.com/hummingbot/gateway) instance.
You will need to have the certificates for the gateway and hummingbot under the folder hummingbot_files/certs. If you don't have it, don't worry, you can generate them with the client by doing the following:
## Prerequisites
- Make sure you have docker and docker-compose installed.
- Run the following command in the terminal:
This configuration requires [Docker Compose](https://docs.docker.com/compose/), a tool for defining and running multi-container Docker applications. The recommended way to get Docker Compose is to install [Docker Desktop](https://www.docker.com/products/docker-desktop/), which includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.
```
docker-compose up -d
```
Docker Desktop is available on:
- You will see that the gateway failed to start because you don't have the certificates
- Attach the instance of the bot by running:
* [Linux](https://docs.docker.com/desktop/install/linux-install/)
* [Mac](https://docs.docker.com/desktop/install/mac-install/)
* [Windows](https://docs.docker.com/desktop/install/windows-install/)
```
docker attach hummingbot_gateway_compose-bot-1
```
- Create the password
- Run the following command in the client:
## Apple M1/M2 and other ARM machines
```
gateway generate-certs
```
If you have a recent Mac that uses Apple Silicon (M1/M2) chipset or another ARM-based machine, you need to change the image tag to ensure that you pull a container that is optimized for your chip architecture.
- When prompted enter the passphrase that you want. Is important that you change the docker-compose.yml on line 18 to the passphrase that you entered (the current passphrase is `a`).
- Exit the client and run the following command in the terminal:
Use an IDE like [VSCode](https://code.visualstudio.com/) to edit the `docker-compose.yml` file. Change the tag for **both** the Hummingbot and Gateway images from `latest` to `latest-arm` to pull the images built for ARM-based machines.
```
docker-compose down
```
You can also comment out the each line that contains `latest` and uncomment each line that contains `latest-arm`:
```
# image: hummingbot/hummingbot:latest
image: hummingbot/hummingbot:latest-arm
- You will see that inside the hummingbot_files/certs folder you have the certificates.
- We are ready to deploy the gateway and hummingbot, run the following command in the terminal:
# image: hummingbot/gateway:latest
image: hummingbot/gateway:latest-arm
```
```
docker-compose up -d
```
Afterwards, save the file and proceed to the next step.
- If you attach the terminal of the gateway you will see that it is running.
If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-based machine, you don't need to make any changes before deploying a container.
```
docker attach hummingbot_gateway_compose-gateway-1
```
## Getting Started
- If you attach the terminal of the bot you will see that it is running and the gateway is ONLINE.
If you have installed Docker Compose successfully, the `docker-compose` command should be available in Terminal/Bash:
```
docker-compose
```
```
docker attach hummingbot_gateway_compose-bot-1
```
- If you attach the terminal of the bot2 you will see that it is running and the gateway is ONLINE.
```
docker attach hummingbot_gateway_compose-bot2-1
```
## IMPORTANT
You should see a response that start with:
```
Usage: docker compose [OPTIONS] COMMAND
```
To simplify the example, we are sharing the folder of hummingbot_files between the two bots. You should have one folder for each bot,
but the certs folder that you are sharing between the gateway and the bots should be the same.
Clone this repo or copy the `docker-compose.yml` file to a directory on your machine where you want to store your Hummingbot files. This is where your encrypted keys, scripts, trades, configs, logs, and other files related to your bots will be saved.
To link the Hummingbot and Gateway instances, you first have to generate certificates within Hummingbot and set the `GATEWAY_PASSPHRASE` variable in the YAML file.
### 1. Generate certs
Pull the latest Hummingbot and Gateway images and start instances with the following command:
```
docker-compose up -d
```
After the images have been downloaded, you should see the following output:
```
[+] Running 4/4
⠿ Network hummingbot_gateway_compose_default Created
⠿ Container hummingbot_gateway_compose-bot-1 Started
⠿ Container docker attach hummingbot_gateway_compose-bot2-1 Started
⠿ Container hummingbot_gateway_compose-gateway-1 Started
```
Attach to the `bot1` Hummingbot instance:
```
docker attach hummingbot_gateway_compose-bot-1
```
You should see the Hummingbot welcome screen:
![welcome screen](../welcome.png)
Set your [password](https://docs.hummingbot.org/operation/password/), which will be used to encrypt any keys you store with Hummingbot. This is the `CONFIG_PASSWORD` environment variable in your `docker-compose.yml` file used by `bot2`.
Afterwards, run the following command to generate Gateway certificates:
```
gateway generate-certs
```
You'll be prompted for a passphrase used to generate the certificates. This is the `GATEWAY_PASSPHRASE` environment variable in your `docker-compose.yml` file.
Afterwards, Hummingbot will use the passphrase to generate the certificates and save them in the `hummingbot_files/certs` folder, where the Gateway instance will look for the certificates it needs.
Now, run `exit` to exit the client.
### 2. Remove network
Once you're back in Bash/Terminal, run the following command to remove the Compose network:
```
docker-compose down
```
You should see the following output:
```
[+] Running 4/4 ⠿ Container hummingbot_gateway_compose-gateway-1 Removed
⠿ Container hummingbot_gateway_compose-bot-1 Removed
⠿ Container docker attach hummingbot_gateway_compose-bot2-1 Removed
⠿ Network hummingbot_gateway_compose_default Removed
```
### 3. Modify YAML file
Now, use an IDE like [VSCode](https://code.visualstudio.com/) to edit the `docker-compose.yml` file.
We'll edit the section that defines the following environment variables:
```yaml
bot2:
# environment:
# - CONFIG_PASSWORD=[password]
gateway:
# environment:
# - GATEWAY_PASSPHRASE=[passphrase]
```
Remove the '#' to uncomment out:
* The two `environment:` lines
* The `CONFIG_PASSWORD` line: add your Hummingbot password
* The `GATEWAY_PASSPHRASE` line: add the passphrase you used to generate the certificates
The final `environment` section of the YAML file should look like this:
```yaml
bot2:
environment:
- CONFIG_PASSWORD=[password]
gateway:
environment:
- GATEWAY_PASSPHRASE=[passphrase]
```
Afterwards, save the file.
### 4. Recreate network
Now, recreate the Compose network:
```
docker-compose up -d
```
Attach to the `bot` Hummingbot instance:
```
docker attach hummingbot_gateway_compose-bot-1
```
Attach to the `bot2` Hummingbot instance:
```
docker attach hummingbot_gateway_compose-bot2-1
```
Open a new Terminal/Bash window. In it, attach to the Gateway instance to see its logs:
```
docker attach hummingbot_gateway_compose-gateway-1
```
See [Gateway](https://docs.hummingbot.org/gateway/) for more details on how to configure it for use with Hummingbot.
## Useful Docker Commands
Use the commands below or use the Docker Desktop application to manage your Hummingbot and Gateway container:
### Create/Launch Compose network
```
docker-compose up -d
```
### Remove the Compose network
```
docker-compose down
```
### Update the Compose network for the latest images
```
docker-compose up --force-recreate --build -d
```
### Attach to the Hummingbot containers
```
docker attach hummingbot_gateway_compose-bot-1
docker attach hummingbot_gateway_compose-bot2-1
```
### Attach to the Gateway container
```
docker attach hummingbot_gateway_compose-gateway-1
```
### Detach from the container and return to command line
* Press keys <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd>
### List all containers
```
docker ps -a
```
### Stop a container
```
docker stop <instance-name>
```
### Remove a container
```
docker rm <instance-name>
```
## Notes
To simplify the example, we are sharing the local `hummingbot_files` files between the two bots. Ideally, you should have a separate folder for each bot. However, the `certs` folder should be shared between all bots.

11
multiple_hummingbot_gateway_compose/docker-compose.yml
View File

@@ -2,6 +2,7 @@ version: "3.9"
services:
bot:
image: hummingbot/hummingbot:latest
# image: hummingbot/hummingbot:latest-arm
volumes:
- "./hummingbot_files/conf:/conf"
- "./hummingbot_files/conf/connectors:/conf/connectors"
@@ -21,6 +22,7 @@ services:
bot2:
image: hummingbot/hummingbot:latest
# image: hummingbot/hummingbot:latest-arm
volumes:
- "./hummingbot_files/conf:/conf"
- "./hummingbot_files/conf/connectors:/conf/connectors"
@@ -29,8 +31,8 @@ services:
- "./hummingbot_files/data:/data"
- "./hummingbot_files/scripts:/scripts"
- "./hummingbot_files/certs:/certs"
environment:
- CONFIG_PASSWORD=a
# environment:
# - CONFIG_PASSWORD=[password]
logging:
driver: "json-file"
options:
@@ -42,6 +44,7 @@ services:
gateway:
image: hummingbot/gateway:latest
# image: hummingbot/gateway:latest-arm
ports:
- "15888:15888"
- "8080:8080"
@@ -49,5 +52,5 @@ services:
- "./gateway_files/conf:/usr/src/app/conf"
- "./gateway_files/logs:/usr/src/app/logs"
- "./hummingbot_files/certs:/usr/src/app/certs"
environment:
- GATEWAY_PASSPHRASE=a
# environment:
# - GATEWAY_PASSPHRASE=[passphrase]