More documentation about specific services and components can be found in the following sections:
- services/api - Data API and data model layer that powers all applications
- services/web - Web application and administration dashboard
Using Docker Compose you can build and run all services and dependencies as follows:
docker-compose upOpen the dashboard at http://localhost:3200/ - Admin login credentials can be seen in the API output.
Steps to run the full stack locally:
Optinally run as docker containers:
# create local data folders for mongo and ES
sudo mkdir /root/data
sudo mkdir /root/esdata
chmod 777 -R /root/esdata
# run docker containers for mongo and ES
docker run --name mongo -d -p 27017:27017 -v /root/data:/data/db mongo:5.0.1
docker run --name elasticsearch -d -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" -v /root/esdata:/usr/share/elasticsearch/data elasticsearch:7.12.0cd services/api
yarn install
yarn start
# Note: Reload fixtures with:
# ./scripts/fixtures/reloadcd services/api
yarn elasticsearch-sink:startcd services/web
yarn install
yarn startcd services/api
node scripts/publish-fixture-events.jsLogin with admin@tectonic.io:tectonic.now at http://localhost:3200
Full portal with examples:
http://localhost:3200/docs/getting-started
Code documentation:
In order to release a new Tectonic version, you need to create a release on github with an incremented version tag, e.g., v1.0.1, v1.2.4, v2.0.0, and release notes. Next you can checkout the release branch locally:
git pull origin master
git checkout v1.0.1On this branch you can build the images and push the images to Docker Hub as follows:
bedrock cloud build # select all services
./docker-push all 1.0.1 # pass the branch/release version, without the `v` prefixTo push the latest tag from the master branch and not a specific release version:
bedrock cloud build # select all services
./docker-push # pushes all services with the 'latest' tag
./docker-push api # pushes only the api service with the 'latest' tag
./docker-push api latest # same as aboveInstall tectonic-cli:
curl -s https://gist.githubusercontent.com/beatlevic/80c45c040bdb46c180af7b5557e1fca6/raw/1efebb3b17578e0a3849994dddd6fbb91055ddc8/install | bashCreate a new Tectonic environment:
tectonic createRollout deployment with latest version:
tectonic cloud authorize # Authorize tectonic environment or pass environment:
# tectonic cloud authorize production
tectonic cloud rollout # select environment and services to rollout or pass environment and service:
# tectonic cloud rollout production api