README.md: no huge info

Signed-off-by: Alexander Indenbaum <aindenba@redhat.com>
ceph · Dec 17, 2024 · f30daeb · f30daeb
1 parent bf83ae5
commit f30daeb
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 46 deletions.
diff --git a/.github/workflows/build-container.yml b/.github/workflows/build-container.yml
@@ -86,47 +86,47 @@ jobs:
           path: |
             ceph.tar
 
-  build-arm64:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-
-      - name: Build container images - spdk
-        run: make build SVC=spdk TARGET_ARCH=arm64
-
-      - name: Build container images - bdevperf
-        run: make build SVC=bdevperf TARGET_ARCH=arm64
-
-      - name: Build container images - nvmeof
-        run: make build SVC=nvmeof TARGET_ARCH=arm64
-
-      - name: Build container images - nvmeof-cli
-        run: make build SVC=nvmeof-cli TARGET_ARCH=arm64
-
-      - name: Build container images - ceph
-        run: make build SVC=ceph TARGET_ARCH=arm64
-
-      - name: Save container images
-        run: |
-          . .env
-          docker tag $QUAY_NVMEOF:$NVMEOF_VERSION $QUAY_NVMEOF:$NVMEOF_VERSION-arm64
-          docker tag $QUAY_NVMEOFCLI:$NVMEOF_VERSION $QUAY_NVMEOFCLI:$NVMEOF_VERSION-arm64
-          docker save $QUAY_NVMEOF:$NVMEOF_VERSION-arm64 > nvmeof-arm64.tar
-          docker save $QUAY_NVMEOFCLI:$NVMEOF_VERSION-arm64 > nvmeof-cli-arm64.tar
-
-      - name: Upload nvmeof-arm64 container images
-        uses: actions/upload-artifact@v4
-        with:
-          name: container_images_nvmeof_arm64
-          path: |
-            nvmeof-arm64.tar
-            nvmeof-cli-arm64.tar
+# build-arm64:
+#   runs-on: ubuntu-latest
+#   steps:
+#     - name: Checkout code
+#       uses: actions/checkout@v4
+#       with:
+#         submodules: recursive
+
+#     - name: Set up QEMU
+#       uses: docker/setup-qemu-action@v3
+
+#     - name: Build container images - spdk
+#       run: make build SVC=spdk TARGET_ARCH=arm64
+
+#     - name: Build container images - bdevperf
+#       run: make build SVC=bdevperf TARGET_ARCH=arm64
+
+#     - name: Build container images - nvmeof
+#       run: make build SVC=nvmeof TARGET_ARCH=arm64
+
+#     - name: Build container images - nvmeof-cli
+#       run: make build SVC=nvmeof-cli TARGET_ARCH=arm64
+
+#     - name: Build container images - ceph
+#       run: make build SVC=ceph TARGET_ARCH=arm64
+
+#     - name: Save container images
+#       run: |
+#         . .env
+#         docker tag $QUAY_NVMEOF:$NVMEOF_VERSION $QUAY_NVMEOF:$NVMEOF_VERSION-arm64
+#         docker tag $QUAY_NVMEOFCLI:$NVMEOF_VERSION $QUAY_NVMEOFCLI:$NVMEOF_VERSION-arm64
+#         docker save $QUAY_NVMEOF:$NVMEOF_VERSION-arm64 > nvmeof-arm64.tar
+#         docker save $QUAY_NVMEOFCLI:$NVMEOF_VERSION-arm64 > nvmeof-cli-arm64.tar
+
+#     - name: Upload nvmeof-arm64 container images
+#       uses: actions/upload-artifact@v4
+#       with:
+#         name: container_images_nvmeof_arm64
+#         path: |
+#           nvmeof-arm64.tar
+#           nvmeof-cli-arm64.tar
 
   pytest:
     needs: [build, build-ceph]
@@ -684,7 +684,7 @@ jobs:
 
   push-images-to-ceph-registry:
     if: github.event_name == 'release'
-    needs: [pytest, demo, discovery, ha, atom, build-arm64]
+    needs: [pytest, demo, discovery, ha, atom]
     runs-on: ubuntu-latest
 
     steps:
@@ -701,8 +701,8 @@ jobs:
         run: |
           docker load < nvmeof.tar
           docker load < nvmeof-cli.tar
-          docker load < nvmeof-arm64.tar
-          docker load < nvmeof-cli-arm64.tar
+          #docker load < nvmeof-arm64.tar
+          #docker load < nvmeof-cli-arm64.tar
 
       - name: Login to quay.io
         uses: docker/login-action@v2
@@ -714,7 +714,7 @@ jobs:
       - name: Publish nvmeof containers when release/tag is created
         run: |
           make push
-          make push TAG_SUFFIX="-arm64"
+          #make push TAG_SUFFIX="-arm64"
           make push-manifest-list
 
   push-devel-image-to-ceph-registry:

diff --git a/README.md b/README.md
@@ -294,14 +294,21 @@ client_cert = ./client.crt
 
 ### Huge-Pages
 
-[DPDK requires hugepages](https://doc.dpdk.org/guides/linux_gsg/sys_reqs.html#linux-gsg-hugepages) to be set up:
+[DPDK uses by default hugepages](https://doc.dpdk.org/guides/linux_gsg/sys_reqs.html#linux-gsg-hugepages) to be set up:
 
 ```bash
 sh -c 'echo 4096 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages'
 ```
 
 This is automatically done in the `make setup` step. The amount of hugepages can be configured with `make setup HUGEPAGES=512`.
 
+ℹ️ **Info:** To eliminate the dependency on huge pages, set [mem_size=4096](https://github.com/ceph/ceph-nvmeof/blob/bf83ae504e77358944c8a0150d390cf66086fa2b/tests/ceph-nvmeof.no-huge.conf#L68) (memory size in megabytes) in the spdk section of the ceph-nvmeof.conf file. See the [example](https://github.com/ceph/ceph-nvmeof/blob/devel/tests/ceph-nvmeof.no-huge.conf) configuration file for reference.
+
+```ini
+[spdk]
+mem_size=4096
+```
+
 ## Development
 
 ### Set-up