Remove unused scripts and consistify readme steps (#485)

This commit is contained in:
James Wilson authored and GitHub committed 2022-07-26 14:48:30 +02:00
1 parent 5bff41d0c1
commit 8067b0caa2
3 files changed
+3 -69

No files matched your search

+3 -12
View File
@@ -97,7 +97,7 @@ polkadot --dev --telemetry-url 'ws://localhost:8001/submit 0'
To build the backend docker image, navigate into the `backend` folder of this repository and run: To build the backend docker image, navigate into the `backend` folder of this repository and run:
``` ```
docker build -t substrate-telemetry-backend . docker build -t parity/substrate-telemetry-backend .
``` ```
The backend image contains both the `telemetry_core` and `telemetry_shard` binaries. The backend image contains both the `telemetry_core` and `telemetry_shard` binaries.
@@ -105,7 +105,7 @@ The backend image contains both the `telemetry_core` and `telemetry_shard` binar
To build the frontend docker image, navigate into the `frontend` folder and run: To build the frontend docker image, navigate into the `frontend` folder and run:
``` ```
docker build -t substrate-telemetry-frontend . docker build -t parity/substrate-telemetry-frontend .
``` ```
### Run the backend and frontend using `docker-compose` ### Run the backend and frontend using `docker-compose`
@@ -116,7 +116,7 @@ To connect a substrate node and have it send telemetry to this running instance,
### Run the backend and frontend using `docker` ### Run the backend and frontend using `docker`
If you'd like to get things running manually using Docker, you can do the following. This assumes that you've built the images as per the above, and have two images named `substrate-telemetry-backend` and `substrate-telemetry-frontend`. If you'd like to get things running manually using Docker, you can do the following. This assumes that you've built the images as per the above, and have two images named `parity/substrate-telemetry-backend` and `parity/substrate-telemetry-frontend`.
1. Create a new shared network so that the various containers can communicate with eachother: 1. Create a new shared network so that the various containers can communicate with eachother:
@@ -185,15 +185,6 @@ You should now see your node showing up in your local [telemetry frontend](http:
![image](doc/screenshot01.png) ![image](doc/screenshot01.png)
### Build & Publish the Frontend & Backend docker images
The building process is standard. You just need to notice that the `Dockerfile`s are in `./frontend/` and `./backend` and tell docker about it. The context must remain the repository's root though. This is all done for you in the following scripts:
```sh
DOCKER_USER=$USER ./scripts/build-docker-frontend.sh
DOCKER_USER=$USER ./scripts/build-docker-backend.sh
```
## Deployment ## Deployment
This section covers the internal deployment of Substrate Telemetry to our staging and live environments. This section covers the internal deployment of Substrate Telemetry to our staging and live environments.
-28
View File
@@ -1,28 +0,0 @@
#!/usr/bin/env bash
pushd "$(git rev-parse --show-toplevel)/backend" > /dev/null
while getopts ":Nsgapv:" arg; do
case "${arg}" in
p)
PUBLISH="true"
;;
esac
done
IMAGE=substrate-telemetry-backend
DOCKER_USER=${DOCKER_USER:-paritytech}
echo "Building $IMAGE as $DOCKER_USER"
docker build -t $IMAGE -f ./Dockerfile .
docker tag $IMAGE $DOCKER_USER/$IMAGE
if [[ "$PUBLISH" = 'true' ]]; then
docker push $DOCKER_USER/$IMAGE
else
echo 'No -p passed, skipping publishing to docker hub'
fi
popd > /dev/null
docker images | grep $IMAGE
-29
View File
@@ -1,29 +0,0 @@
#!/usr/bin/env bash
set -e
pushd "$(git rev-parse --show-toplevel)/frontend" > /dev/null
while getopts ":Nsgapv:" arg; do
case "${arg}" in
p)
PUBLISH="true"
;;
esac
done
IMAGE=substrate-telemetry-frontend
DOCKER_USER=${DOCKER_USER:-paritytech}
echo "Publishing $IMAGE as $DOCKER_USER"
docker build -t $IMAGE -f packages/frontend/Dockerfile .
docker tag $IMAGE $DOCKER_USER/$IMAGE
if [[ "$PUBLISH" = 'true' ]]; then
docker push $DOCKER_USER/$IMAGE
else
echo 'No -p passed, skipping publishing to docker hub'
fi
popd > /dev/null
docker images | grep $IMAGE