updates: refactor kustomize (#92)

* update: validation script
* refactor
* update: version
* add: badges
* add: quota

.github/workflows/publish-xmrig-cuda.yml

@@ -15,21 +15,18 @@ on:  # yamllint disable-line rule:truthy
     paths:
     - xmrig/**
     - .github/workflows/**
-  # pull_request:
-  #   branches: ["main"]
-  #   paths:
-  #   - xmrig/**
-  #   - .github/workflows/**
+  pull_request:
+    branches: ["main"]
+    paths:
+    - xmrig/**
+    - .github/workflows/**
 
 env:
   IMAGE_NAME: xmrig
-  IMAGE_VERSION: 6.22.0-cuda
+  IMAGE_VERSION: 6.22.2-cuda
   GHCR_REGISTRY: ghcr.io
   GHCR_USER: ${{ github.repository_owner }}
   GHCR_IMAGE: ${GHCR_REGISTRY}/${GHCR_USER}/${IMAGE_NAME}
-  # DOCKERHUB_REGISTRY=docker.io
-  # DOCKERHUB_USER: ${{ github.repository_owner }}
-
 
 jobs:
   publish:
@@ -45,20 +42,14 @@ jobs:
       - name: Prepare
         id: prep
         run: |
-          #VERSION=${GITHUB_REF#refs/tags/v}
           VERSION=${{ env.IMAGE_VERSION }}
-          MINOR=${VERSION%.*}
-          MAJOR=${VERSION%%.*}
           GHCR_IMAGE=${{ env.GHCR_IMAGE }}
-          #TAGS="${DOCKERHUB_IMAGE}:${MAJOR},${DOCKERHUB_IMAGE}:${MINOR}"
-          #TAGS="${TAGS},${DOCKERHUB_IMAGE}:${VERSION}"
-          TAGS="${TAGS},${GHCR_IMAGE}:${MAJOR},${GHCR_IMAGE}:${MINOR}"
+          TAGS="${GHCR_IMAGE}:latest-cuda"
           TAGS="${TAGS},${GHCR_IMAGE}:${VERSION}"
-          echo ::set-output name=name::${{ env.IMAGE_NAME }}
-          echo ::set-output name=tags::${TAGS}
-          echo ::set-output name=version::${VERSION}
-          #echo ::set-output name=dockerhub_image::${DOCKERHUB_IMAGE}
-          echo ::set-output name=ghcr_image::${GHCR_IMAGE}
+          echo "name=${{ env.IMAGE_NAME }}" >> $GITHUB_OUTPUT
+          echo "tags=${TAGS}" >> $GITHUB_OUTPUT
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+          echo "ghcr_image=${GHCR_IMAGE}" >> $GITHUB_OUTPUT
 
       # https://github.com/docker/login-action
       - name: Log into GitHub Container Registry

.github/workflows/publish-xmrig-proxy.yml

@@ -12,19 +12,19 @@ on:  # yamllint disable-line rule:truthy
     branches: ["main"]
     # Publish semver tags as releases.
     tags: ["v*.*.*"]
-    paths: ["xmrig-proxy/**"]
+    paths:
+      - xmrig-proxy/**
   pull_request:
     branches: ["main"]
-    paths: ["xmrig-proxy/**"]
+    paths:
+      - xmrig-proxy/**
 
 env:
   IMAGE_NAME: xmrig-proxy
-  IMAGE_VERSION: 6.22.0
+  IMAGE_VERSION: 6.22.2
   GHCR_REGISTRY: ghcr.io
   GHCR_USER: ${{ github.repository_owner }}
   GHCR_IMAGE: ${GHCR_REGISTRY}/${GHCR_USER}/${IMAGE_NAME}
-  # DOCKERHUB_REGISTRY=docker.io
-  # DOCKERHUB_USER: ${{ github.repository_owner }}
 
 
 jobs:

.github/workflows/publish-xmrig.yml

@@ -23,13 +23,10 @@ on:  # yamllint disable-line rule:truthy
 
 env:
   IMAGE_NAME: xmrig
-  IMAGE_VERSION: 6.22.0
+  IMAGE_VERSION: 6.22.2
   GHCR_REGISTRY: ghcr.io
   GHCR_USER: ${{ github.repository_owner }}
   GHCR_IMAGE: ${GHCR_REGISTRY}/${GHCR_USER}/${IMAGE_NAME}
-  # DOCKERHUB_REGISTRY=docker.io
-  # DOCKERHUB_USER: ${{ github.repository_owner }}
-
 
 jobs:
   publish:
@@ -50,15 +47,12 @@ jobs:
           MINOR=${VERSION%.*}
           MAJOR=${VERSION%%.*}
           GHCR_IMAGE=${{ env.GHCR_IMAGE }}
-          #TAGS="${DOCKERHUB_IMAGE}:${MAJOR},${DOCKERHUB_IMAGE}:${MINOR}"
-          #TAGS="${TAGS},${DOCKERHUB_IMAGE}:${VERSION},${DOCKERHUB_IMAGE}:latest"
           TAGS="${TAGS},${GHCR_IMAGE}:${MAJOR},${GHCR_IMAGE}:${MINOR}"
           TAGS="${TAGS},${GHCR_IMAGE}:${VERSION},${GHCR_IMAGE}:latest"
-          echo ::set-output name=name::${{ env.IMAGE_NAME }}
-          echo ::set-output name=tags::${TAGS}
-          echo ::set-output name=version::${VERSION}
-          #echo ::set-output name=dockerhub_image::${DOCKERHUB_IMAGE}
-          echo ::set-output name=ghcr_image::${GHCR_IMAGE}
+          echo "name=${{ env.IMAGE_NAME }}" >> $GITHUB_OUTPUT
+          echo "tags=${TAGS}" >> $GITHUB_OUTPUT
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+          echo "ghcr_image=${GHCR_IMAGE}" >> $GITHUB_OUTPUT
 
       # https://github.com/docker/login-action
       - name: Log into GitHub Container Registry

.wordlist-md

@@ -36,4 +36,5 @@ Nvidia
 cryptocurrency
 aspell
 venv
-ubuntu
+ubuntu
+cuda

.yamllint

@@ -1,6 +1,7 @@
 extends: default
 
 rules:
+  comments-indentation: disable
   document-start: disable
   line-length: disable
   indentation:

Makefile

@@ -17,7 +17,7 @@ SHELL=/bin/bash
 build: lint pre-build xmrig-build xmrig-build-cuda xmrig-proxy-build post-build
 
 
-lint: venv lint-yaml lint-spellcheck
+lint: venv lint-yaml lint-spellcheck lint-kustomize
 
 
 pre-build:
@@ -49,6 +49,9 @@ push:
 lint-yaml:
 	 $(VENV)/yamllint -c .yamllint .
 
+lint-kustomize:
+	scripts/validate_kustomize.sh
+
 lint-spellcheck:
 	$(VENV)/pyspelling -c .spellcheck.yaml
 

README.md

@@ -1,5 +1,9 @@
 # XMRig Container - Mine / Benchmark in Docker / Podman / Kubernetes
 
+[![Publish xmrig](https://github.com/codekow/container-xmrig/actions/workflows/publish-xmrig.yml/badge.svg)](https://github.com/codekow/container-xmrig/actions/workflows/publish-xmrig.yml)
+[![Publish xmrig-proxy](https://github.com/codekow/container-xmrig/actions/workflows/publish-xmrig-proxy.yml/badge.svg)](https://github.com/codekow/container-xmrig/actions/workflows/publish-xmrig-proxy.yml)
+[![Publish xmrig-cuda](https://github.com/codekow/container-xmrig/actions/workflows/publish-xmrig-cuda.yml/badge.svg)](https://github.com/codekow/container-xmrig/actions/workflows/publish-xmrig-cuda.yml)
+
 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?
@@ -20,17 +24,17 @@ Running the container(s) without parameters ~~helps contribute $$~~ [sends metri
 
 ### Usage Docker / Podman
 
-```
+```sh
 docker run -it --rm ghcr.io/codekow/xmrig
 ```
 
-```
+```sh
 podman run -it --rm ghcr.io/codekow/xmrig
 ```
 
 Run meta miner
 
-```
+```sh
 # see xmrig/bin/entrypoint.sh for more info.
 # this might get documented... :)
 podman run -it --rm ghcr.io/codekow/xmrig start_meta_miner
@@ -44,7 +48,7 @@ For those of you who want to ~~get rich~~ [lose money](https://whattomine.com/co
 
 NOTE: This container does not run as `root` by default
 
-```
+```sh
 export POOL_URL="Pool URL"
 export POOL_USER="Public Monero address"
 export POOL_PASS="Miner ID - optional for most pools"
@@ -67,13 +71,14 @@ podman run \
 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.
 
-```
+```sh
 sudo podman run \
   -it --rm \
   --privileged \
@@ -94,13 +99,13 @@ XMR:
 
 For those with time to look at the code...
 
-```
+```sh
 # ubuntu
 apt install podman
 apt install curl git make aspell python3.10-venv
 ```
 
-```
+```sh
 # run before submitting a PR
 make lint
 make build

k8s/base/kustomization.yaml

@@ -1,5 +1,8 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 
+components:
+  - ../components/quota
+
 resources:
-  - xmrig-ds.yaml
+  - namespace.yaml

k8s/base/namespace.yaml

@@ -3,4 +3,4 @@ apiVersion: v1
 metadata:
   name: burn-in
   annotations:
-    openshift.io/display-name: Hardware Burn-In
+    openshift.io/display-name: Stress Cluster Workload

k8s/base/cronjob/kustomization.yaml → k8s/components/cronjob/kustomization.yaml

@@ -1,5 +1,5 @@
-apiVersion: kustomize.config.k8s.io/v1beta1
-kind: Kustomization
+apiVersion: kustomize.config.k8s.io/v1alpha1
+kind: Component
 
 resources:
   - cron-xmrig-sa.yaml

k8s/components/daemon-set/kustomization.yaml

@@ -0,0 +1,5 @@
+apiVersion: kustomize.config.k8s.io/v1alpha1
+kind: Component
+
+resources:
+  - xmrig-ds.yaml

k8s/base/xmrig-ds.yaml → k8s/components/daemon-set/xmrig-ds.yaml

@@ -44,10 +44,10 @@ spec:
           image: ghcr.io/codekow/xmrig:latest
           resources:
             limits:
-          #     cpu: '5'
-          #     memory: 2400Mi
-          #   requests:
-          #     memory: 2400Mi
+            #   cpu: '5'
+            #   memory: 2400Mi
+            # requests:
+            #   memory: 2400Mi
       volumes:
         - name: empty
           emptyDir: {}

k8s/base/deployment/xmrig-deploy.yaml → k8s/components/deployment/deployment.yaml

@@ -3,10 +3,6 @@ kind: Deployment
 metadata:
   labels:
     app: xmrig
-    app.kubernetes.io/component: xmrig
-    app.kubernetes.io/instance: xmrig
-    app.kubernetes.io/name: xmrig
-    app.kubernetes.io/part-of: xmrig
   name: xmrig
 spec:
   replicas: 1
@@ -32,13 +28,13 @@ spec:
         - name: POOL_PASS
           value: k8s
         - name: EXTRA_ARGS
-          value: '--no-huge-pages --cpu-no-yield --max-cpu-usage=100 -t=1 --no-color'
+          value: '--no-huge-pages --cpu-no-yield --max-cpu-usage=100 -t=2'
         resources:
           limits:
-            cpu: '1'
+            cpu: '3'
             memory: 2400Mi
           requests:
-            cpu: '1'
+            cpu: '2'
         ports:
         - containerPort: 3333
           protocol: TCP

k8s/components/deployment/kustomization.yaml

@@ -0,0 +1,13 @@
+apiVersion: kustomize.config.k8s.io/v1alpha1
+kind: Component
+
+labels:
+- includeSelectors: true
+  pairs:
+    app.kubernetes.io/component: xmrig
+    app.kubernetes.io/instance: xmrig
+    app.kubernetes.io/name: xmrig
+    app.kubernetes.io/part-of: xmrig
+
+resources:
+  - deployment.yaml

k8s/components/proxy-miner/kustomization.yaml

@@ -0,0 +1,25 @@
+apiVersion: kustomize.config.k8s.io/v1alpha1
+kind: Component
+
+labels:
+- includeSelectors: true
+  pairs:
+    app.kubernetes.io/component: xmrig
+    app.kubernetes.io/instance: xmrig
+    app.kubernetes.io/name: xmrig
+    app.kubernetes.io/part-of: xmrig
+
+components:
+  - ../../components/deployment
+
+patches:
+  - target:
+      group: apps
+      kind: Deployment
+      name: xmrig
+    patch: |-
+      - op: replace
+        path: /spec/template/spec/containers/0/env/0
+        value:
+            name: POOL_URL
+            value: xmrig-proxy:3333

k8s/components/proxy/deployment.yaml

@@ -0,0 +1,48 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: xmrig-proxy
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: xmrig-proxy
+  strategy:
+    type: RollingUpdate
+  template:
+    metadata:
+      labels:
+        app: xmrig-proxy
+    spec:
+      containers:
+      - env:
+        - name: POOL_URL
+          value: gulf.moneroocean.stream:10128
+        - name: POOL_USER
+          value: 4AwPZobe6PsLbfk5ntnv6Wa9DPL3aPd4N2b761EmsMpAQbBaJaAajQGhtBXDL9Mo4G649oAmWzNJU5L3YBS458iw2XkJp26
+        - name: POOL_PASS
+          value: k8s-proxy
+        - name: EXTRA_ARGS
+          value: ""
+        image: ghcr.io/codekow/xmrig-proxy:latest
+        imagePullPolicy: IfNotPresent
+        name: xmrig-proxy
+        ports:
+        - containerPort: 3333
+          protocol: TCP
+        - containerPort: 8080
+          protocol: TCP
+        resources:
+          limits:
+            cpu: 500m
+            memory: 128Mi
+          requests:
+            cpu: 500m
+            memory: 128Mi
+        volumeMounts:
+        - mountPath: /home/miner
+          name: empty
+      restartPolicy: Always
+      volumes:
+      - emptyDir: {}
+        name: empty