codex-storage
/
nim-codex
mirror of https://github.com/codex-storage/nim-codex.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
nim-codex/docker/README.md

64 lines
2.0 KiB
Markdown
Raw Normal View History

Docker build (#354) * Sets up working dockerized build and codex docker image creation * Making codex configurable from the docker environment * Sets up two networks with three codex nodes * enables and exposes metrics endpoint for first node * Manually performed two-client test scenario with docker containers * Sets up docker-ignore and docker github workflow * Wires up all codex CLI arguments to docker env vars * Makes API_PORT variable optional as well * Removes duplicate docker-login step * Fixes path to docker file * Switches target dockerhub for debugging * Adds git tag info to --version output * Exposes version information via debug endpoint * Debugging docker image * specifies target platforms for docker build * specifies platform for QEMU and buildx steps * Attempt to debug line endings * Disables march-native in config.nims as test * Applies make argument to disable architecture optimization during docker build * Removes subset version tags from docker build * Restore multi-arch build * Removes docker-build test branch from CI branches
2023-03-08 11:45:55 +00:00
# Codex Docker Image
Build and run using the example docker-compose file:
`docker-compose up -d`
Stop and retain image and volume data:
`docker-compose down`
Stop and delete image and volume data:
`docker-compose down --rmi all -v`
`rm -R hostdatadir`
# Environment variables
Codex docker image supports the following environment variables:
Makes required arguments overrideable from environment variables (#377)
2023-03-20 14:07:07 +00:00
- LISTEN_ADDRS(*)
- API_BINDADDR(*)
- DATA_DIR(*)
Docker build (#354) * Sets up working dockerized build and codex docker image creation * Making codex configurable from the docker environment * Sets up two networks with three codex nodes * enables and exposes metrics endpoint for first node * Manually performed two-client test scenario with docker containers * Sets up docker-ignore and docker github workflow * Wires up all codex CLI arguments to docker env vars * Makes API_PORT variable optional as well * Removes duplicate docker-login step * Fixes path to docker file * Switches target dockerhub for debugging * Adds git tag info to --version output * Exposes version information via debug endpoint * Debugging docker image * specifies target platforms for docker build * specifies platform for QEMU and buildx steps * Attempt to debug line endings * Disables march-native in config.nims as test * Applies make argument to disable architecture optimization during docker build * Removes subset version tags from docker build * Restore multi-arch build * Removes docker-build test branch from CI branches
2023-03-08 11:45:55 +00:00
- LOG_LEVEL
- METRICS_ADDR
- METRICS_PORT
- NAT_IP
- API_PORT
- DISC_IP
- DISC_PORT
- NET_PRIVKEY
- BOOTSTRAP_SPR
- MAX_PEERS
- AGENT_STRING
- STORAGE_QUOTA
- BLOCK_TTL
- CACHE_SIZE
- ETH_PROVIDER
- ETH_ACCOUNT
- ETH_DEPLOYMENT
Docker multiarch debug (#447) * Uses correct string for marketplace address * first steps towards support for arm64 * Applies multiarch ubuntu dockerfile as codex-dockerfile. * Add `--simulate-proof-failures` env variable, update docker-compose to point to slimmed image * Add image to CI, and update startCodex.sh * Sets up separate docker build for arm * Update arm64 arm of docker ci * [docker] modify startCodex.sh - include overridden node name in log output if specified in test - quote `—log-level` value so that multiple log levels can be specified - ensure any CLI parameter env vars are passed through to the codex binary, instead of conditionally including them - add `—persistence` - add `—validator` * fixes load and push for amd docker build --------- Co-authored-by: Eric Mastro <github@egonat.me>
2023-06-19 06:28:27 +00:00
- SIMULATE_PROOF_FAILURES
- VALIDATOR
- PERSISTENCE
- CODEX_NODENAME(†)
Docker build (#354) * Sets up working dockerized build and codex docker image creation * Making codex configurable from the docker environment * Sets up two networks with three codex nodes * enables and exposes metrics endpoint for first node * Manually performed two-client test scenario with docker containers * Sets up docker-ignore and docker github workflow * Wires up all codex CLI arguments to docker env vars * Makes API_PORT variable optional as well * Removes duplicate docker-login step * Fixes path to docker file * Switches target dockerhub for debugging * Adds git tag info to --version output * Exposes version information via debug endpoint * Debugging docker image * specifies target platforms for docker build * specifies platform for QEMU and buildx steps * Attempt to debug line endings * Disables march-native in config.nims as test * Applies make argument to disable architecture optimization during docker build * Removes subset version tags from docker build * Restore multi-arch build * Removes docker-build test branch from CI branches
2023-03-08 11:45:55 +00:00
Makes required arguments overrideable from environment variables (#377)
2023-03-20 14:07:07 +00:00
(*) These variables have default values in the docker image that are different from Codex's standard default values.
Docker multiarch debug (#447) * Uses correct string for marketplace address * first steps towards support for arm64 * Applies multiarch ubuntu dockerfile as codex-dockerfile. * Add `--simulate-proof-failures` env variable, update docker-compose to point to slimmed image * Add image to CI, and update startCodex.sh * Sets up separate docker build for arm * Update arm64 arm of docker ci * [docker] modify startCodex.sh - include overridden node name in log output if specified in test - quote `—log-level` value so that multiple log levels can be specified - ensure any CLI parameter env vars are passed through to the codex binary, instead of conditionally including them - add `—persistence` - add `—validator` * fixes load and push for amd docker build --------- Co-authored-by: Eric Mastro <github@egonat.me>
2023-06-19 06:28:27 +00:00
(†) CODEX_NODENAME is used for logging purposes only in the docker image
Docker build (#354) * Sets up working dockerized build and codex docker image creation * Making codex configurable from the docker environment * Sets up two networks with three codex nodes * enables and exposes metrics endpoint for first node * Manually performed two-client test scenario with docker containers * Sets up docker-ignore and docker github workflow * Wires up all codex CLI arguments to docker env vars * Makes API_PORT variable optional as well * Removes duplicate docker-login step * Fixes path to docker file * Switches target dockerhub for debugging * Adds git tag info to --version output * Exposes version information via debug endpoint * Debugging docker image * specifies target platforms for docker build * specifies platform for QEMU and buildx steps * Attempt to debug line endings * Disables march-native in config.nims as test * Applies make argument to disable architecture optimization during docker build * Removes subset version tags from docker build * Restore multi-arch build * Removes docker-build test branch from CI branches
2023-03-08 11:45:55 +00:00
All environment variables are optional and will default to Codex's CLI default values.
# Constants
Codex CLI arguments 'data-dir', 'listen-addrs', and 'api-bindaddr' cannot be configured. They are set to values required for docker in case of bind addresses. In the case of 'data-dir', the value is set to `/datadir`. It is important that you map this folder to a host volume in your container configuration. See docker-compose.yaml for examples.
# Useful
Connect nodes with the `/connect` endpoint.
To get the IP address of a container within a network:
Find container Id: `docker ps`
Open terminal in container: `docker exec -it <CONTAINER ID> sh`
Get IP addresses: `ifconfig`
Docker multiarch debug (#447) * Uses correct string for marketplace address * first steps towards support for arm64 * Applies multiarch ubuntu dockerfile as codex-dockerfile. * Add `--simulate-proof-failures` env variable, update docker-compose to point to slimmed image * Add image to CI, and update startCodex.sh * Sets up separate docker build for arm * Update arm64 arm of docker ci * [docker] modify startCodex.sh - include overridden node name in log output if specified in test - quote `—log-level` value so that multiple log levels can be specified - ensure any CLI parameter env vars are passed through to the codex binary, instead of conditionally including them - add `—persistence` - add `—validator` * fixes load and push for amd docker build --------- Co-authored-by: Eric Mastro <github@egonat.me>
2023-06-19 06:28:27 +00:00
# Slim
1. Build the image using `docker build -t status-im/codexsetup:latest -f codex.Dockerfile ..`
2. The docker image can then be minifed using [slim](https://github.com/slimtoolkit/slim). Install slim on your path and then run:
```shell
slim # brings up interactive prompt
>>> build --target status-im/codexsetup --http-probe-off true
```
3. This should output an image with name `status-im/codexsetup.slim`
4. We can then bring up the image using `docker-compose up -d`.