Collection of tools, scripts, and helpers for maintaining BitDust infrastructure and software development. Also, you will learn how to start your own private BitDust network from scratch here.
BitDust project development flow is based on two independent GIT repositories:
When changes in the development repo are considered "good enough," files are manually copied by one of the developers to the stable repo fork on his local machine, and a new commit must be created to start a new Pull Request.
This process can be considered a new "Release" - BitDust software does not have any versioning of the releases because it is not required. After Pull Request is merged - the release is done.
Every BitDust node periodically "checks & fetches" fresh commits from the GIT repository where it was cloned from. This way BitDust software on your local machine automatically "updates itself" and stays in sync with the "Stable" repository. Every BitDust contributor is responsible for delivering high-standard, super reliable, and well-tested source code changes every time Pull Request is merged.
As a user of BitDust software, you can disable automatic updates at any moment in the program settings and always run only the code you cloned the first time when you get into BitDust's network.
You can also fork BitDust's "stable" repo and clone locally your fork to quickly check and run the main Python code. Like any other GitHub project you forked, your fork will be fully independent of the main repo - you will have to sync manually with the main repo if you wish to stay on the same version. This will work best for all developers and those who wish to learn BitDust or participate in testing. Remember to always check and stay in sync with the main network and refresh your code from Stable repository.
If you stay out of sync with other users, your data is at risk! Remember always to check & pull your BitDust software sources and stay in sync with the main network by updating your code from Stable repository.
For non-developers and all other people willing to join the BitDust network in a common way we maintain BitDust Desktop Application installer.
Go directly to bitdust.io web site and download installer file - we provide link directly from [GitHub repo](BitDust desktop. The Application uses Electron Framework for GUI and will automatically clone from BitDust Stable repo for the first time you run application and keep your local sources in sync with the master branch.
As a BitDust software user, you can disable automatic updates at any moment in the program settings and always run only the code you cloned the first time when you get into the BitDust network.
Below is a step-by-step guide for developers to deliver changes from the "Development" repository into the "Stable" repository.
To run a new BitDust release, you must already fork and clone both repositories. Basically, you need to do those actions only once and keep your repositories up-to-date with the main branches.
Here we assume your fork will be "origin" and the main repository will be added as "upstream":
# fork and clone development repo
git clone [email protected]:<your GitHub username here>/devel.git bitdust.devel
cd bitdust.devel
git remote add upstream https://github.com/bitdust-io/devel.git
cd ..
# fork and clone stable repo
git clone [email protected]:<your GitHub username here>/public.git bitdust
cd bitdust
git remote add upstream https://github.com/bitdust-io/public.git
cd ..
# clone devops repo
git clone https://github.com/bitdust-io/devops.git bitdust.devops
To start a release, you must prepare source code changes inside your forked & cloned "Stable" repo. You do not do any changes to the source code manually but use two helper scripts built for you. Those scripts will take source code from the "Development" repo you already cloned locally, prepare everything for you to start Pull Request in the "Stable" repo, and publish the latest source code.
To start, you open a terminal window, change to the bitdust.devops repository, and run the First script:
git clone https://github.com/bitdust-io/devops.git bitdust.devops
cd bitdust.devops/
./ci/release_prepare
This will prepare all files to be committed into the "Stable" repository. Your terminal output will display all modified/added/removed files. That script is doing a bunch of things:
- copy files from "devel" to "stable" repo
- disable DEBUG mode in all Python files
- compare all files in both repositories
- updates
HISTORY.txtfile in "devel" repo
You must manually edit and prepare the CHANGELOG.txt file inside your BitDust development repo. You must provide short info about your changes with a date and name.
After running release_prepare, you should see a list of the most recent commits in your terminal console output.
You can copy & paste those lines from your console to the top of CHANGELOG.txt file.
Look at the HISTORY.TXT file in the root of the development repo and use commit messages to build info in the CHANGELOG.txt file.
head -20 ../bitdust.devel/HISTORY.txt
nano ../bitdust.devel/CHANGELOG.txt
Now you need to open another terminal window, go to the "Stable" repository, and use git add ... / git rm ... to confirm and prepare changes to be released.
First, mark all modified files in the git repo to be committed in the new release: cd ./bitdust git add -u .
Add all other new files to git manually - this is important to check here to not miss any files created recently in "devel" repo:
git status
git add <some new file>
If some files or folders were removed from "devel" repo - do not forget to also remove them from the "Stable" repo and mark those changes to be commited:
git rm <some old file>
We are almost done!
Switch back your terminal to bitdust.devops repository and execute manually Second script:
cd ../bitdust.devops/
./ci/release_start
That script will push all prepared changes to your forked repositories.
All you need now to do start the release is to create new Pull Request towards "stable" repository via GitHub web site.
Make sure Travis build is green and people review your changes and everyone agree.
One of the developers must click Merge button finally and ...
Congratulations, YOU ARE LIVE!
Do not forget to update your fork right away to stay in sync:
git pull upstream master
git push origin master
BitDust developers community maintaining few machines to "seed" the Main network - you can find those hosts in default_network.json file.
Those machines we monitor via Grafana dashboard - bellow you can read how it was provisioned.
You need to install Docker service on the monitoring host first and prepare local folder to store Grafana and InfluxDB files:
sudo apt-get update
sudo apt-get install apt-transport-https ca-certificates curl gnupg-agent software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo apt-key fingerprint 0EBFCD88
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io
sudo groupadd docker
sudo usermod -aG docker $USER
mkdir -p /home/bitdust/monitoring/influxdb
mkdir -p /home/bitdust/monitoring/grafana
Then you just run the Grafana server and InfluxDB via Docker container like that:
docker run -d \
--name docker-influxdb-grafana \
-p 3003:3003 \
-p 3004:8888 \
-p 8086:8086 \
-v /home/bitdust/monitoring/influxdb:/var/lib/influxdb \
-v /home/bitdust/monitoring/grafana:/var/lib/grafana \
philhawthorne/docker-influxdb-grafana:latest
This will run the process in background and make Grafana dashboard available on http://localhost:3003.
You can use Apache2 or Nginx server to redirect the web traffic and make your monitoring dashboard avaialble via HTTPS on web port 80.
First you need to install Ansible locally.
Then clone bitdust.devops repo and build your virtual environment:
git clone https://github.com/bitdust-io/devops.git bitdust.devops
cd bitdust.devops
make venv
cd ansible
ansible-playbook telegraf.yml -i inventory/main -K --limit monitoring -e "application_name=monitoring"
ansible-playbook telegraf.yml -i inventory/main -K -e "application_name=main"
ansible-playbook bitdust_install.yml -i inventory/main -e "application_name=main"
ansible-playbook bitdust_refresh.yml -i inventory/main -e "application_name=main"
ansible-playbook bitdust_info.yml -i inventory/main -e "application_name=main"
ansible nodes -i ansible/inventory/main -m shell -a 'curl localhost:8180/process/health/v1'