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.

Sign up for GitHub

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

feat(devnet): add substrate docker images to dockerfile #2263

Merged
merged 38 commits into from
Mar 8, 2022
Merged

feat(devnet): add substrate docker images to dockerfile #2263

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
6139712
feat: include substrate docker image
EclesioMeloJunior Jan 31, 2022
8c3fb1d
chore: add substrate docker images
EclesioMeloJunior Feb 2, 2022
c0be6dc
chore: formatting and add depends on yaml key
EclesioMeloJunior Feb 2, 2022
eda4e4a
chore: add datadog stuff again
EclesioMeloJunior Feb 2, 2022
dae59e2
chore: use alice peer id
EclesioMeloJunior Feb 2, 2022
6ccf8fb
chore: split substrate docker compose services into another file
EclesioMeloJunior Feb 2, 2022
1407b3a
chore: enable prometheus external and add datadog
EclesioMeloJunior Feb 2, 2022
0d59fac
Merge branch 'development' into eclesio/substrate-docker-image
EclesioMeloJunior Feb 4, 2022
5108412
chore: keep substrate ports same as gossamer node ports
EclesioMeloJunior Feb 4, 2022
9fa7ffb
chore: expose rpc and ws calls in substrate docker file
EclesioMeloJunior Feb 4, 2022
71a8f5e
chore: use same dns name and p2p id
EclesioMeloJunior Feb 4, 2022
f1fea2d
chore: use same key for both alice gossamer and substrate nodes
EclesioMeloJunior Feb 4, 2022
9b485f6
chore: fix dd golang cmd
EclesioMeloJunior Feb 4, 2022
cff9c8c
Update devnet/README.md
EclesioMeloJunior Feb 7, 2022
262b329
Update devnet/README.md
EclesioMeloJunior Feb 7, 2022
012b4b9
chore: update `substrate_alice` readme info
EclesioMeloJunior Feb 7, 2022
1d158a3
Update devnet/README.md
EclesioMeloJunior Feb 7, 2022
f0689ee
chore: add `/tcp` to expose ports
EclesioMeloJunior Feb 7, 2022
604ce4b
Merge branch 'eclesio/substrate-docker-image' of github.com:ChainSafe…
EclesioMeloJunior Feb 7, 2022
237647a
chore: adjust args and envs
EclesioMeloJunior Feb 7, 2022
ae0429e
chore: pin prometheus version, add read only volume and add trailing …
EclesioMeloJunior Feb 7, 2022
843d361
chore: improve README.md
EclesioMeloJunior Feb 7, 2022
bcb134e
Merge branch 'development' into eclesio/substrate-docker-image
EclesioMeloJunior Feb 7, 2022
579136c
chore: add port 7001 explicitly
EclesioMeloJunior Feb 7, 2022
c49bcf0
chore: remove prometheus `--config.file` flag
EclesioMeloJunior Feb 8, 2022
f03093a
chore: use env to chain
EclesioMeloJunior Feb 8, 2022
25946ca
update substrate_bob.Dockerfile
EclesioMeloJunior Feb 8, 2022
e8c1e9d
Merge branch 'development' into eclesio/substrate-docker-image
EclesioMeloJunior Feb 9, 2022
15f1377
chore: add datadog-agent start to gssmr alice node
EclesioMeloJunior Feb 9, 2022
94c6a87
Merge branch 'eclesio/substrate-docker-image' of github.com:ChainSafe…
EclesioMeloJunior Feb 9, 2022
17fd1f2
chore: add comment about different but same node keys
EclesioMeloJunior Feb 16, 2022
aacb438
chore: update substrate docker images to version 0.9.17
EclesioMeloJunior Mar 2, 2022
a382561
chore: include license header
EclesioMeloJunior Mar 2, 2022
ca63faa
Merge branch 'development' into eclesio/substrate-docker-image
EclesioMeloJunior Mar 3, 2022
a4bd83c
chore: make image smaller, start dd agent at entrypoint
EclesioMeloJunior Mar 3, 2022
e476e23
chore: use only one genesis
EclesioMeloJunior Mar 3, 2022
e12686d
chore: be more descriptive at genesis.json folder
EclesioMeloJunior Mar 4, 2022
03c89c6
chore: update image to use arg polkadot version
EclesioMeloJunior Mar 4, 2022
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
12 changes: 0 additions & 12 deletions devnet/docker-compose-substrate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,4 @@
services:
prometheus:
image: prom/prometheus:v2.33.1
volumes:
- ./../prometheus.yml:/etc/prometheus/prometheus.yml:ro
command:
- '--storage.tsdb.path=/prometheus'
- '--web.console.libraries=/usr/share/prometheus/console_libraries'
- '--web.console.templates=/usr/share/prometheus/consoles'
ports:
- 9090
restart: always

alice:
platform: linux/amd64
build:
Expand Down
43 changes: 28 additions & 15 deletions devnet/substrate_alice.Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,48 @@
FROM parity/polkadot:v0.9.10 AS polkadot
FROM golang:1.17
# Copyright 2022 ChainSafe Systems (ON)
# SPDX-License-Identifier: LGPL-3.0-only

FROM golang:1.17 as openmetrics
ARG METRICS_NAMESPACE=substrate.local.devnet

WORKDIR /devnet

COPY ./devnet/go.mod ./devnet/go.sum ./
RUN go mod download
Comment on lines +11 to +12
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need this? won't go run ... on line 13 just auto-download dependencies?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is for Docker layer caching, so dependencies are cached and rebuilds will be faster.


COPY ./devnet .
RUN go run cmd/update-dd-agent-confd/main.go -n=${METRICS_NAMESPACE} -t=key:alice > conf.yaml

FROM parity/polkadot:v0.9.17

ARG CHAIN=cross-client
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the difference between the gssmr chain that's within our codebase and this one?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both have 3 authority nodes, however, the cross-client genesis file is accepted by the substrate node since it has staking and session json keys while gssmr chain has Babe and Grandpa json keys. The cross-client genesis file has the runtime version 09.10 that don't trigger errors like:

CRIT target=runtime message=panicked at 'Timestamp slot must match `CurrentSlot`'

Copy link
Contributor

@timwu20 timwu20 Feb 23, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally we should have one chain all cross client, and gossamer only setups. We may end up having multiple of these chains that differ based on number of authority nodes.

@kishansagathiya is working on secondary vrf slot mode for babe #2307. We need to ensure that the genesis file is using this mode and we should be updating to v0.9.16 of polkadot.

It would be nice to have some sort of readme or something in the devnet readme that describes how to generate these files. I know you were following the steps provided by Kishan, but where did the original genesis-spec.json come from? What pallets are in the runtime? These are questions we should have answers to. It may make sense to have another repo and associated github CI workflows to generate these genesis files that the devnets can pull down as part of the docker image build process. Rather than just putting arbitrary files in this repo.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where did the original genesis-spec.json come from?

./polkadot build-spec --disable-default-bootnode --dev > genesis-spec.json
And then you will have to modify it according to your requirements, like adding authorities.

And then you run something like this to get a genesis.json file
./polkadot build-spec --chain genesis-spec.json --raw --disable-default-bootnode > genesis.json

Will make a pr to add this to read me.

New versions have a different genesis-spec file than 0.9.10.
Also running cross-client dev net with newer version of polkadot gives runtime errors. So, yeah we need to update.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we rename this to something more descriptive. 3-auth-node-0.9.10 or something.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also we could have 0.9.10 as a build argument at the top global scope in the Dockerfile.

i.e.

ARG POLKADOT_VERSION=v0.9.10

FROM parity/polkadot:${POLKADOT_VERSION} AS polkadot
FROM golang:1.17

ARG CHAIN=3-auth-node-${POLKADOT_VERSION}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@qdm12 I was having problems trying to use arguments declared before FROM, following this issue (link) I could resolve and apply the suggestion.

Basically, all the ARG's declared/initialized before FROM needs to be redeclared after FROM to use its values otherwise will not be possible to get the value from ARG. I your suggestion we need to add

ARG POLKADOT_VERSION=v0.9.10

FROM parity/polkadot:${POLKADOT_VERSION} AS polkadot
FROM golang:1.17

+ ARG POLKADOT_VERSION
# Now its possible to use the value here
ARG CHAIN=3-auth-node-${POLKADOT_VERSION}

ARG VERSION=v0.9.10
ARG DD_API_KEY=somekey
ARG METRICS_NAMESPACE=substrate.local.devnet

ENV CHAIN=${CHAIN}
ENV DD_API_KEY=${DD_API_KEY}
ENV CHAIN=${CHAIN}

RUN DD_AGENT_MAJOR_VERSION=7 DD_INSTALL_ONLY=true DD_SITE="datadoghq.com" bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script.sh)"
USER root
RUN apt update && apt install -y curl
EclesioMeloJunior marked this conversation as resolved.
Show resolved Hide resolved

COPY --from=polkadot /usr/bin/polkadot /usr/bin/polkadot
WORKDIR /cross-client

WORKDIR /gossamer
RUN curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script.sh --output install_script.sh && \
chmod +x ./install_script.sh

COPY go.mod go.sum ./
RUN go mod download
RUN DD_AGENT_MAJOR_VERSION=7 DD_INSTALL_ONLY=true DD_SITE="datadoghq.com" ./install_script.sh
COPY --from=openmetrics /devnet/conf.yaml /etc/datadog-agent/conf.d/openmetrics.d/

COPY . .
RUN service datadog-agent start
EclesioMeloJunior marked this conversation as resolved.
Show resolved Hide resolved

WORKDIR /gossamer/devnet
USER polkadot

RUN go run cmd/update-dd-agent-confd/main.go -n=${METRICS_NAMESPACE} -t=key:alice > /etc/datadog-agent/conf.d/openmetrics.d/conf.yaml
COPY ./devnet/chain ./chain/

# The substrate node-key argument should be a 32 bytes long sr25519 secret key
# while gossamer nodes uses a 64 bytes long sr25519 key (32 bytes long to secret key + 32 bytes long to public key).
# Then to keep both substrate and gossamer alice nodes with the same libp2p node keys we just need to use
# the first 32 bytes from `alice.node.key` which means the 32 bytes long sr25519 secret key used here.
ENTRYPOINT service datadog-agent start && /usr/bin/polkadot \
--chain chain/$CHAIN/genesis-raw.json \
ENTRYPOINT /usr/bin/polkadot \
--chain ./chain/$CHAIN/genesis-raw.json \
--alice \
--port 7001 \
--rpc-port 8545 \
Expand Down
44 changes: 29 additions & 15 deletions devnet/substrate_bob.Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,46 @@
FROM parity/polkadot:v0.9.10 AS polkadot
FROM golang:1.17
# Copyright 2022 ChainSafe Systems (ON)
# SPDX-License-Identifier: LGPL-3.0-only

FROM golang:1.17 as openmetrics

ARG METRICS_NAMESPACE=substrate.local.devnet

WORKDIR /devnet

COPY ./devnet/go.mod ./devnet/go.sum ./
RUN go mod download

COPY ./devnet .
RUN go run cmd/update-dd-agent-confd/main.go -n=${METRICS_NAMESPACE} -t=key:alice > conf.yaml

FROM parity/polkadot:v0.9.17

ARG key
ARG CHAIN=cross-client
ARG DD_API_KEY=somekey
ARG METRICS_NAMESPACE=substrate.local.devnet

ENV key=${key}
ENV CHAIN=${CHAIN}
ENV DD_API_KEY=${DD_API_KEY}
qdm12 marked this conversation as resolved.
Show resolved Hide resolved
ENV CHAIN=${CHAIN}
ENV key=${key}

RUN test -n "${key}"
RUN DD_AGENT_MAJOR_VERSION=7 DD_INSTALL_ONLY=true DD_SITE="datadoghq.com" bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script.sh)"
USER root
RUN apt update && apt install -y curl
EclesioMeloJunior marked this conversation as resolved.
Show resolved Hide resolved

COPY --from=polkadot /usr/bin/polkadot /usr/bin/polkadot
WORKDIR /cross-client

WORKDIR /gossamer
RUN curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script.sh --output install_script.sh && \
chmod +x ./install_script.sh

COPY go.mod go.sum ./
RUN go mod download
RUN DD_AGENT_MAJOR_VERSION=7 DD_INSTALL_ONLY=true DD_SITE="datadoghq.com" ./install_script.sh
COPY --from=openmetrics /devnet/conf.yaml /etc/datadog-agent/conf.d/openmetrics.d/

COPY . .
RUN service datadog-agent start

WORKDIR /gossamer/devnet
USER polkadot

RUN go run cmd/update-dd-agent-confd/main.go -n=${METRICS_NAMESPACE} -t=key:$key > /etc/datadog-agent/conf.d/openmetrics.d/conf.yaml
COPY ./devnet/chain ./chain/

ENTRYPOINT service datadog-agent start && /usr/bin/polkadot \
ENTRYPOINT /usr/bin/polkadot \
--bootnodes /dns/alice/tcp/7001/p2p/12D3KooWMER5iow67nScpWeVqEiRRx59PJ3xMMAYPTACYPRQbbWU \
--chain chain/$CHAIN/genesis-raw.json \
--port 7001 \
Expand Down