Skip to content
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

Release 0.4.0 #31

Merged
merged 22 commits into from
May 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/push-docker-release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Deploy dev images to GHCR

on:
push:
branches:
- 'release_*'

jobs:
push-store-image:
runs-on: ubuntu-latest
steps:
- name: 'Checkout GitHub Action'
uses: actions/checkout@main

- name: 'Login to GitHub Container Registry'
uses: docker/login-action@v1
with:
registry: ghcr.io
username: ${{github.actor}}
password: ${{secrets.GITHUB_TOKEN}}

- name: 'Build Inventory Image'
run: |
docker build . --tag ghcr.io/qubic/qubic-archiver:${{github.ref_name}}
docker push ghcr.io/qubic/qubic-archiver:${{github.ref_name}}
6 changes: 3 additions & 3 deletions Deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
The docker-compose deployment system consists of four services:
- `qubic-http` - the http proxy server that provides an http interface to query directly the qubic node(s)
- `qubic-archiver` - the archiver processor and HTTP server that provides rpc endpoints to query the archiver
- `qubic-node-fetcher` - a service that is starting from a reliable node, gather the peers by "walking" from peer to peer(if not set to fixed list) and then filters them out so they don't have more than 30 ticks behind. This service is also exposing an http server for the qubic-archiver to retrieve the reliable peers
- `qubic-nodes` - a service responsible with providing `qubic-archiver` and `qubic-http` information regarding reliable nodes and the max tick of the network
- `traefik` - a reverse proxy that will route the incoming requests to the correct service and also exposes metrics and dashboard

# Run with docker-compose
## Prerequisites

Before starting the system, open the `dev.docker-compose.yml` file and make sure you modify it based on your needs:

- Use reliable peer list for the node-fetcher service. It's defined in the `NODE_FETCHER_QUBIC_STARTING_PEERS_IP` environment variable.
- Use a reliable peer list for the `qubic-nodes` service. It's defined in the `QUBIC_NODES_QUBIC_PEER_LIST` environment variable.
You should add your own reliable peers if you have qubic nodes deployed with tx status addon, or you can request a list of reliable peers from the qubic team.
- Use your domain name (or external ip) and replace `testapi.qubic.org` with your domain (or external ip) in the `qubic-http` and `qubic-archiver` services.
- Use your file path and replace volume bindings for `qubic-archiver` and `qubic-node-fetcher` services. For example if you have a store folder on `/root/store/` you should replace volume binding for `qubic-archiver` to `/root/store/archiver:/app/store`.
- Use your file path and replace volume bindings for the `qubic-archiver` service. For example if you have a store folder on `/root/store/` you should replace volume binding for `qubic-archiver` to `/root/store/archiver:/app/store`.

```bash
$ docker-compose -f dev.docker-compose.yml up -d
Expand Down
Loading
Loading