Merge pull request #8 from soubinan/feature

Remove unecessary multiplatforms and another try fix for cosign authN…

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: XEN Orchestra Container
+name: Container Image Build
 
 on:
   push:
@@ -12,16 +12,11 @@ env:
   IMAGE_NAME: soubinan/xoa-container
   TEST_TAG: soubinan/xoa-container:test
   PROJECT_URL: https://github.com/soubinan/xoa-container
+  AUTHOR: https://github.com/soubinan
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        platform:
-          - linux/amd64
-          # - linux/arm64
 
     steps:
       - name: Get xo-server version
@@ -46,11 +41,18 @@ jobs:
             type=semver,pattern={{major}}
             type=raw,latest
           labels: |
-            --label "org.opencontainers.image.source=${{ env.PROJECT_URL }}"
-            --label "org.opencontainers.image.url=${{ env.PROJECT_URL }}"
-            --label "org.opencontainers.image.title=XOA-Container"
-            --label "org.opencontainers.image.description=XEN Orchestra As a Container: Build from XO-Server $XO_SERVER and XO-Web $XO_WEB"
-            --label "org.opencontainers.image.licenses=CC-BY-NC"
+            org.opencontainers.image.source=${{ env.PROJECT_URL }}
+            org.opencontainers.image.url=${{ env.PROJECT_URL }}
+            org.opencontainers.image.title=XOA-Container
+            org.opencontainers.image.version={{version}}
+            org.opencontainers.image.description=XEN Orchestra As Container built from sources with XO-Server $XO_SERVER and XO-Web $XO_WEB
+            org.opencontainers.image.documentation=${{ env.PROJECT_URL }}
+            org.opencontainers.image.authors=${{ env.AUTHOR }}
+            org.opencontainers.image.licenses=CC-BY-NC
+          annotations: |
+            org.opencontainers.image.description=XEN Orchestra As Container built from sources with XO-Server $XO_SERVER and XO-Web $XO_WEB
+            org.opencontainers.image.version={{version}}
+            org.opencontainers.image.licenses=CC-BY-NC
       - name: Install cosign
         if: github.event_name == 'release'
         uses: sigstore/cosign-installer@v3
@@ -70,10 +72,10 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           context: "."
-          platforms: ${{ matrix.platform }}
           file: "./Containerfile"
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          annotations: ${{ steps.meta.outputs.annotations }}
           cache-from: type=gha
           cache-to: type=gha,mode=max
           build-args: |
@@ -83,7 +85,9 @@ jobs:
       - name: Sign the published container images
         if: github.event_name == 'release'
         run: |
-          cosign sign --yes "${TAGS}@${DIGEST}"
+          cosign sign --yes --key env://COSIGN_PRIVATE_KEY "${TAGS}@${DIGEST}"
         env:
           TAGS: ${{ steps.meta.outputs.tags }}
           DIGEST: ${{ steps.build-and-push.outputs.digest }}
+          COSIGN_PRIVATE_KEY: ${{ secrets.COSIGN_PRIVATE_KEY }}
+          COSIGN_PASSWORD: ${{ secrets.COSIGN_PASSWORD }}

Containerfile

@@ -48,6 +48,7 @@ COPY --from=build_xoa /app /app
 RUN find /app/packages/ -maxdepth 1 -mindepth 1 -name "xo-server-*" -not -name "xo-server-test" -exec ln -s {} /app/packages/xo-server/node_modules \;
 RUN mkdir -p /etc/xo-server &&\
     cp /app/packages/xo-server/sample.config.toml /etc/xo-server/config.toml
+
 ARG XOWEB=latest \
     XOSERVER=latest
 

README.md

@@ -1,31 +1,34 @@
 # XEN Orchestra As a Container
 
-Is a containerized XEN Orchestra version inspired by [XEN-Orchestra-Docker](https://github.com/ronivay/xen-orchestra-docker) and [XEN-Orchestra-CE](https://github.com/Ezka77/xen-orchestra-ce)
+XOA in XOA Container means `XEN Orchestra As`, do not confuse with the official Vates's XOA meaning `XEN Orchestra Appliance`. Vates is the open source company behind XCP-NG and XEN Orchestra.
+We are very grateful for their work and strongly encourage you to support them. Even a github star count as a support.
 
-> Please use this repo's issues for all bugs observed or supports needed related to the created container images
+XOA Container - standing for `XEN Orchestra As Container` - is a containerized XEN Orchestra version inspired by [XEN-Orchestra-Docker](https://github.com/ronivay/xen-orchestra-docker) and [XEN-Orchestra-CE](https://github.com/Ezka77/xen-orchestra-ce).
 
-## Usage (Tested with Docker and Podman)
+> Please use this repo's issues for all bugs observed or supports needed related to the xoa-container images.
+
+## Usage (Tested with Docker and Podman, but we prefer podman)
 
 ### Get the image
 
 ```bash
-docker pull ghcr.io/soubinan/xoa-container:latest
+podman pull ghcr.io/soubinan/xoa-container:latest
 ```
 
 ### Execute
 
 ```bash
 # You already have Redis running
-docker run --rm -p 8080:80 -v <path/to/xo/config>:/etc/xo-server -v <path/to/xo/data>:/var/lib/xo-server -v <path/to/xo/backup>:/var/lib/xo-backup ghcr.io/soubinan/xoa-container:latest
+podman run [-d] --rm -p 8080:80 -v </local/path/config>:/etc/xo-server -v </local/path/data>:/var/lib/xo-server -v </local/path/backup>:/var/lib/xo-backup ghcr.io/soubinan/xoa-container:latest
 ```
 
 or
 
 ```bash
 # Use the Compose file with Redis included
-docker network create frontnet
-docker network create redisnet
-docker-compose up [-d]
+podman network create frontnet
+podman network create redisnet
+podman-compose up [-d]
 ```
 
 ## Known issues
@@ -53,16 +56,14 @@ sudo sysctl "vm.overcommit_memory=1"
 ```
 
 Note for Docker Desktop/WSL: See <https://stackoverflow.com/a/69294687> for how to apply sysctl config values.
-
 Background: Due to the fact that (for good reasons) the Redis container does not run in privileged mode, there is no way that Redis can enable this for you, i.e., /proc is read-only for containers.
-
 See Redis documentation, corresponding docker issue and kernel documentation for more info.
 
 ## Goals
 
 * Automatic build from sources
 * Add all plugins dynamically
-* Build as a nodejs container
+* Build as an exclusive nodejs container
 * To be OCI compliant (Avoid as much as possible the specific Docker dependencies)
 * Follow the container building good practices: One process per container (Redis is separated from the XEN-server)
 * Keep it as simple as possible
@@ -72,15 +73,14 @@ See Redis documentation, corresponding docker issue and kernel documentation for
 
 ## Non-Goals
 
-* To be built on many image base (It is built using the **Debian image base only**)
+* To be built on many linux distributions (It is built using the **Debian image base only**)
 * To run all the stack as a unique container. If you are interested about this kind of packaging, please check the very good options from [XEN-Orchestra-Docker](https://github.com/ronivay/xen-orchestra-docker) and [XEN-Orchestra-CE](https://github.com/Ezka77/xen-orchestra-ce)
 * To build an image as small as possible (But we try to keep it as optimized as we can)
-* Make it configurable after the initial build
 * Be a replacement or an alternative to the official XEN-Orchestra flavors
 
 ## Todo
 
-* Port it to K8S (Add the expected k8s manifest)
+* Port it to K8S (Add the expected k8s/helm manifest)
 
 ## Test and run tools
 
@@ -89,7 +89,8 @@ See Redis documentation, corresponding docker issue and kernel documentation for
 
 ## XEN-Orchestra
 
-XEN-Container exists thanks to [XEN-Ochestra](https://github.com/vatesfr/xen-orchestra) by [VatesFR](https://github.com/vatesfr) team. Always consider use their supported versions for production purpose
+XEN-Container exists thanks to [XEN-Ochestra](https://github.com/vatesfr/xen-orchestra) by [VatesFR](https://github.com/vatesfr) team.
+Always consider use their supported versions for production purpose.
 
 ### Support