Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codekow/container-xmrig
XMR Container - mine Monero / CPU benchmark with a container. k8s and OpenShift templates
https://github.com/codekow/container-xmrig
benchmark docker k8s kubernetes monero monero-mining openshift podman xmr xmrig
Last synced: 3 months ago
JSON representation
XMR Container - mine Monero / CPU benchmark with a container. k8s and OpenShift templates
- Host: GitHub
- URL: https://github.com/codekow/container-xmrig
- Owner: codekow
- License: mit
- Created: 2021-11-20T01:19:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-08T04:22:25.000Z (6 months ago)
- Last Synced: 2024-08-08T06:15:22.874Z (6 months ago)
- Topics: benchmark, docker, k8s, kubernetes, monero, monero-mining, openshift, podman, xmr, xmrig
- Language: Shell
- Homepage:
- Size: 130 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# XMRig Container - Mine / Benchmark in Docker / Podman / Kubernetes
The purpose of this repo is to have a way to test limits and burn in hardware.
Have you configured your security policies and resource limits effectively to curb user abuse?
Managing resources in Kubernetes can be a challenge. This repo is intended to simulate heavy workloads in order to observe enforcement of configured limits and security controls / policies.
Whatever your goal... launch Xmrig in Podman, Docker, or Kubernetes.
## Xmrig
:warning: NOTICE :warning:
[Xmrig](https://xmrig.com) is an open-source project for mining [Monero](https://www.getmonero.org) (XMR) cryptocurrency. It allows you to mine for a pool and receive Monero.
Running the container(s) without parameters ~~helps contribute $$~~ [sends metrics](https://moneroocean.stream/#/dashboard?addr=4AwPZobe6PsLbfk5ntnv6Wa9DPL3aPd4N2b761EmsMpAQbBaJaAajQGhtBXDL9Mo4G649oAmWzNJU5L3YBS458iw2XkJp26) for this project.
## Getting Started
### Usage Docker / Podman
```
docker run -it --rm ghcr.io/codekow/xmrig
```
```
podman run -it --rm ghcr.io/codekow/xmrig
```
Run meta miner
```
# see xmrig/bin/entrypoint.sh for more info.
# this might get documented... :)
podman run -it --rm ghcr.io/codekow/xmrig start_meta_miner
```
Examples below will use `podman` but should work the same with `docker`
### Environment Variables
For those of you who want to ~~get rich~~ [lose money](https://whattomine.com/coins/101-xmr-cryptonight?hr=2.0&p=80&fee=1.0&cost=0.18&cost_currency=USD&hcost=0.0&span_br=&span_d=24&commit=Calculate) mining, use the following example to configure your container(s).
NOTE: This container does not run as `root` by default
```
export POOL_URL="Pool URL"
export POOL_USER="Public Monero address"
export POOL_PASS="Miner ID - optional for most pools"
export DONATE_LEVEL="Donation in percent, default: 1"
export EXTRA_ARGS="Other parameters to pass to xmrig"
podman run \
-it --rm \
--name miner \
-e POOL_URL=$POOL_URL \
-e POOL_USER=$POOL_USER \
-e POOL_PASS=$POOL_PASS \
-e DONATE_LEVEL=$DONATE_LEVEL \
-e EXTRA_ARGS=$EXTRA_ARGS \
ghcr.io/codekow/xmrig
```
## Run as `root`
Running processes as `root` comes with risks and rewards (like most things).
If you are trying to:
- Improve hash rates (aka: performance) modifying [Model Specific Register](https://xmrig.com/docs/miner/randomx-optimization-guide/msr) (MSR)
- Like [taking risks](https://xkcd.com/1252)
- Have a history of making [bad choices](https://en.wikipedia.org/wiki/Hot_Pockets)
Then the following is for you.
```
sudo podman run \
-it --rm \
--privileged \
-u root \
-v /lib/modules:/lib/modules:ro \
ghcr.io/codekow/xmrig
```
NOTE: mounting `/lib/modules` read-only inside the container allows compatibility with more systems, but is usually not required.
## Development
Please throw away your cryptocurrency at the address below.
XMR:
`4AwPZobe6PsLbfk5ntnv6Wa9DPL3aPd4N2b761EmsMpAQbBaJaAajQGhtBXDL9Mo4G649oAmWzNJU5L3YBS458iw2XkJp26`
For those with time to look at the code...
```
# ubuntu
apt install podman
apt install curl git make aspell python3.10-venv
```
```
# run before submitting a PR
make lint
make build
```
## Links
- [Xmrig](https://xmrig.com)
- [Monero](https://www.getmonero.org)
- [Nvidia - Documentation](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/)
- [Nvidia - Podman using CDI](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/cdi-support.html)