From 787ceb8168bccbd4e80041c7d33bcff805c3b13d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Soko=C5=82owski?= Date: Tue, 26 Sep 2023 12:09:20 +0200 Subject: [PATCH] ci: push images to new wakuorg/nwaku repo MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jakub SokoĊ‚owski --- Makefile | 2 +- ci/Jenkinsfile.release | 11 +++++++++-- docs/contributors/release-process.md | 4 ++-- docs/operators/docker-quickstart.md | 14 +++++++------- docs/operators/how-to/configure.md | 4 ++-- docs/operators/how-to/run-with-rln.md | 8 ++++---- docs/operators/overview.md | 2 +- docs/operators/quickstart.md | 2 +- 8 files changed, 27 insertions(+), 20 deletions(-) diff --git a/Makefile b/Makefile index 083b4f42a..8fe940880 100644 --- a/Makefile +++ b/Makefile @@ -229,7 +229,7 @@ DOCKER_IMAGE_NIMFLAGS := $(DOCKER_IMAGE_NIMFLAGS) $(HEAPTRACK_PARAMS) # build a docker image for the fleet docker-image: MAKE_TARGET ?= wakunode2 docker-image: DOCKER_IMAGE_TAG ?= $(MAKE_TARGET)-$(GIT_VERSION) -docker-image: DOCKER_IMAGE_NAME ?= statusteam/nim-waku:$(DOCKER_IMAGE_TAG) +docker-image: DOCKER_IMAGE_NAME ?= wakuorg/nwaku:$(DOCKER_IMAGE_TAG) docker-image: docker build \ --build-arg="MAKE_TARGET=$(MAKE_TARGET)" \ diff --git a/ci/Jenkinsfile.release b/ci/Jenkinsfile.release index d298badaf..25ec1bb8e 100644 --- a/ci/Jenkinsfile.release +++ b/ci/Jenkinsfile.release @@ -24,7 +24,12 @@ pipeline { string( name: 'IMAGE_NAME', description: 'Name of Docker image to push.', - defaultValue: params.IMAGE_NAME ?: 'statusteam/nim-waku', + defaultValue: params.IMAGE_NAME ?: 'wakuorg/nwaku', + ) + string( + name: 'DOCKER_CRED', + description: 'Name of Docker Hub credential.', + defaultValue: params.DOCKER_CRED ?: 'dockerhub-vacorgbot-api-token', ) string( name: 'NIMFLAGS', @@ -72,7 +77,9 @@ pipeline { stage('Push') { steps { script { - withDockerRegistry([credentialsId: "dockerhub-statusteam-auto", url: ""]) { + withDockerRegistry([ + credentialsId: params.DOCKER_CRED, url: "" + ]) { image.push() image.push(env.IMAGE_TAG) } diff --git a/docs/contributors/release-process.md b/docs/contributors/release-process.md index 272b67076..162aafdc2 100644 --- a/docs/contributors/release-process.md +++ b/docs/contributors/release-process.md @@ -71,11 +71,11 @@ Ensure all items in this list are ticked: ### After the release 1. Announce the release on Twitter, Discord and other channels. -2. Deploy the release image to [Dockerhub](https://hub.docker.com/layers/statusteam/nim-waku/a5f8b9/images/sha256-88691a8f82bd6a4242fa99053a65b7fc4762b23a2b4e879d0f8b578c798a0e09?context=explore) by triggering [the manual Jenkins deployment job](https://ci.infra.status.im/job/nim-waku/job/manual/build). +2. Deploy the release image to [Dockerhub](https://hub.docker.com/layers/wakuorg/nwaku/a5f8b9/images/sha256-88691a8f82bd6a4242fa99053a65b7fc4762b23a2b4e879d0f8b578c798a0e09?context=explore) by triggering [the manual Jenkins deployment job](https://ci.infra.status.im/job/nim-waku/job/manual/build). > Ensure the following build parameters are set: > - `MAKE_TARGET`: `wakunode2` > - `IMAGE_TAG`: the release tag (e.g. `v0.16.0`) - > - `IMAGE_NAME`: `statusteam/nim-waku` + > - `IMAGE_NAME`: `wakuorg/nwaku` > - `NIMFLAGS`: `--colors:off -d:disableMarchNative -d:chronicles_colors:none` > - `GIT_REF` the release tag (e.g. `v0.16.0`) 3. Deploy the release to appropriate fleets: diff --git a/docs/operators/docker-quickstart.md b/docs/operators/docker-quickstart.md index d60a0beaf..bd86caf10 100644 --- a/docs/operators/docker-quickstart.md +++ b/docs/operators/docker-quickstart.md @@ -16,16 +16,16 @@ sudo sh get-docker.sh ## Step 1: Get Docker image -Nwaku Docker images are published to the Docker Hub public registry under [`statusteam/nim-waku`](https://hub.docker.com/r/statusteam/nim-waku). -For specific releases the published images are tagged with the release version, e.g. [`statusteam/nim-waku:v0.16.0`](https://hub.docker.com/layers/statusteam/nim-waku/v0.16.0/images/sha256-7b7f14e7aa1c0a70db297dfd4d43251bda339a14da32885f57ee4b25983c9470?context=explore). +Nwaku Docker images are published to the Docker Hub public registry under [`wakuorg/nwaku`](https://hub.docker.com/r/wakuorg/nwaku). +For specific releases the published images are tagged with the release version, e.g. [`wakuorg/nwaku:v0.20.0`](https://hub.docker.com/layers/wakuorg/nwaku/v0.20.0/images/sha256-9976ac2dc536fae49b21f7b77618aa6f0efb59c694e7b3181e54c08be0c4f089?context=explore). Images are also published for each commit to the `master` branch in the [nwaku repo](https://github.com/status-im/nwaku/commits/master) and tagged with the corresponding commit hash. -See [`statusteam/nim-waku`](https://hub.docker.com/r/statusteam/nim-waku/tags) on Docker Hub for a full list of available tags. +See [`wakuorg/nwaku`](https://hub.docker.com/r/wakuorg/nwaku/tags) on Docker Hub for a full list of available tags. To pull the image of your choice, use ```bash -docker pull statusteam/nim-waku:v0.16.0 # or, whichever tag you prefer in the format statusteam/nim-waku:[tag] +docker pull wakuorg/nwaku:v0.20.0 # or, whichever tag you prefer in the format wakuorg/nwaku:[tag] ``` You can also build the Docker image locally using @@ -33,7 +33,7 @@ You can also build the Docker image locally using ```bash git clone --recurse-submodules https://github.com/waku-org/nwaku cd nwaku -docker build -t statusteam/nim-waku:latest . +docker build -t wakuorg/nwaku:latest . ``` ## Step 2: Run @@ -56,14 +56,14 @@ and any discovery ports (e.g. the Waku discv5 port) that must be reachable from As an example, consider the following command to run nwaku in a Docker container with the most typical configuration: ```bash -docker run -i -t -p 60000:60000 -p 9000:9000/udp statusteam/nim-waku:v0.16.0 \ +docker run -i -t -p 60000:60000 -p 9000:9000/udp wakuorg/nwaku:v0.20.0 \ --dns-discovery:true \ --dns-discovery-url:enrtree://AOGECG2SPND25EEFMAJ5WF3KSGJNSGV356DSTL2YVLLZWIV6SAYBM@prod.waku.nodes.status.im \ --discv5-discovery \ --nat:extip:[yourpublicip] # or, if you are behind a nat: --nat=any ``` -This runs nwaku in a new container from the `statusteam/nim-waku:v0.16.0` image, +This runs nwaku in a new container from the `wakuorg/nwaku:v0.20.0` image, connects to `wakuv2.prod` as bootstrap fleet and enables [Waku Discovery v5](https://rfc.vac.dev/spec/33/) for ambient peer discovery, while mapping the default libp2p listening port (`60000`) diff --git a/docs/operators/how-to/configure.md b/docs/operators/how-to/configure.md index 6d777bf78..b7f70d4c5 100644 --- a/docs/operators/how-to/configure.md +++ b/docs/operators/how-to/configure.md @@ -34,7 +34,7 @@ wakunode2 --tcp-port=65000 In the case of using docker to run you node you should provide the commandline options after the image name as follows: ```shell -docker run statusteam/nim-waku --tcp-port=65000 +docker run wakuorg/nwaku --tcp-port=65000 ``` Run `wakunode2 --help` to get a comprehensive list of configuration options (and its default values): @@ -73,7 +73,7 @@ WAKUNODE2_TCP_PORT=65000 wakunode2 In the case of using docker to run you node you should start the node using the `-e` command options: ```shell -docker run -e "WAKUNODE2_TCP_PORT=65000" statusteam/nim-waku +docker run -e "WAKUNODE2_TCP_PORT=65000" wakuorg/nwaku ``` This is the second configuration method in order of precedence. Any command line configuration option will override the configuration diff --git a/docs/operators/how-to/run-with-rln.md b/docs/operators/how-to/run-with-rln.md index 7804b5966..ed6d27873 100644 --- a/docs/operators/how-to/run-with-rln.md +++ b/docs/operators/how-to/run-with-rln.md @@ -2,7 +2,7 @@ This guide explains how to run a nwaku node with RLN (Rate Limiting Nullifier) enabled. -[RLN](https://rfc.vac.dev/spec/32/) is a protocol integrated into waku v2, +[RLN](https://rfc.vac.dev/spec/32/) is a protocol integrated into waku v2, which prevents spam-based attacks on the network. For further background on the research for RLN tailored to waku, refer @@ -12,7 +12,7 @@ Registering to the membership group has been left out for brevity. If you would like to register to the membership group and send messages with RLN, refer to the [on-chain chat2 tutorial](../../tutorial/onchain-rln-relay-chat2.md). -This guide specifically allows a node to participate in RLN testnet 2. +This guide specifically allows a node to participate in RLN testnet 2. You may alter the rln-specific arguments as required. ## Prerequisites @@ -55,7 +55,7 @@ If you are running the nwaku node within docker, follow [Step 2](../docker-quick export WAKU_FLEET= export SEPOLIA_WS_NODE_ADDRESS= export RLN_RELAY_CONTRACT_ADDRESS="0xF471d71E9b1455bBF4b85d475afb9BB0954A29c4" # Replace this with any compatible implementation -docker run -i -t -p 60000:60000 -p 9000:9000/udp statusteam/nim-waku:v0.12.0 \ +docker run -i -t -p 60000:60000 -p 9000:9000/udp wakuorg/nwaku:v0.20.0 \ --dns-discovery:true \ --dns-discovery-url:"$WAKU_FLEET" \ --discv5-discovery \ @@ -86,4 +86,4 @@ You can also refer to the periodic logging, for a few metrics like - - number of invalid messages -> Note: This guide will be updated in the future to include features like slashing. \ No newline at end of file +> Note: This guide will be updated in the future to include features like slashing. diff --git a/docs/operators/overview.md b/docs/operators/overview.md index 37ab3ea98..28ca9ff0f 100644 --- a/docs/operators/overview.md +++ b/docs/operators/overview.md @@ -17,7 +17,7 @@ or download a precompiled binary from our [releases page](https://github.com/wak If you'd like to test latest changes without building the binaries yourself, you can refer to [nightly release](https://github.com/waku-org/nwaku/releases/tag/nightly). -Docker images are published to [statusteam/nim-waku](https://hub.docker.com/r/statusteam/nim-waku/tags) on Docker Hub. +Docker images are published to [wakuorg/nwaku](https://hub.docker.com/r/wakuorg/nwaku/tags) on Docker Hub. See our [Docker quickstart guide](./docker-quickstart.md) to run nwaku in a Docker container. ## 2. Run diff --git a/docs/operators/quickstart.md b/docs/operators/quickstart.md index 5a6a26258..bc2fe6708 100644 --- a/docs/operators/quickstart.md +++ b/docs/operators/quickstart.md @@ -29,7 +29,7 @@ make wakunode2 ```bash docker run -i -t -p 60000:60000 -p 9000:9000/udp \ - statusteam/nim-waku:v0.12.0 \ # or, the image:tag of your choice + wakuorg/nwaku:v0.20.0 \ # or, the image:tag of your choice --dns-discovery:true \ --dns-discovery-url:enrtree://AOGECG2SPND25EEFMAJ5WF3KSGJNSGV356DSTL2YVLLZWIV6SAYBM@prod.waku.nodes.status.im \ --discv5-discovery \