From 190a7a2077f97e13b0605bfbfc7235fd6041d424 Mon Sep 17 00:00:00 2001 From: Razvan Deaconescu Date: Sun, 28 Jan 2024 08:40:43 +0200 Subject: [PATCH] feat(library): Introduce Memcached 1.6 as library Introduce Memcached 1.6 image (ELF Loader) for bincompat runs. Add `Kraftfile` to build for QMEU and Firecracker on x86_64 using initrd for volume support. The current build uses embedded initrd to build a single image consisting of both the kernel and the initial ramdisk. Add GitHub workflow to build and deploy the image. Add success badge in `README.md`. Signed-off-by: Razvan Deaconescu --- .github/workflows/library-memcached1.6.yaml | 75 +++++++++++ README.md | 1 + library/memcached/1.6/.dockerignore | 3 + library/memcached/1.6/.gitignore | 3 + library/memcached/1.6/Dockerfile | 35 ++++++ library/memcached/1.6/Kraftfile | 130 ++++++++++++++++++++ library/memcached/1.6/README.md | 89 ++++++++++++++ 7 files changed, 336 insertions(+) create mode 100644 .github/workflows/library-memcached1.6.yaml create mode 100644 library/memcached/1.6/.dockerignore create mode 100644 library/memcached/1.6/.gitignore create mode 100644 library/memcached/1.6/Dockerfile create mode 100644 library/memcached/1.6/Kraftfile create mode 100644 library/memcached/1.6/README.md diff --git a/.github/workflows/library-memcached1.6.yaml b/.github/workflows/library-memcached1.6.yaml new file mode 100644 index 00000000..a2078aec --- /dev/null +++ b/.github/workflows/library-memcached1.6.yaml @@ -0,0 +1,75 @@ +name: library/memcached:1.6 + +on: + schedule: + - cron: '0 0 * * *' # Everyday at 12AM + + push: + branches: [main] + paths: + - 'library/memcached/1.6/**' + - '.github/workflows/library-memcached1.6.yaml' + - '!library/memcached/1.6/README.md' + + pull_request: + types: [opened, synchronize, reopened] + branches: [main] + paths: + - 'library/memcached/1.6/**' + - '.github/workflows/library-memcached1.6.yaml' + - '!library/memcached/1.6/README.md' + +jobs: + build: + strategy: + fail-fast: false + matrix: + include: + - plat: qemu + arch: x86_64 + - plat: fc + arch: x86_64 + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Build memcached1.6 + uses: unikraft/kraftkit@staging + with: + loglevel: debug + workdir: library/memcached/1.6 + runtimedir: /github/workspace/.kraftkit + plat: ${{ matrix.plat }} + arch: ${{ matrix.arch }} + push: false + output: oci://index.unikraft.io/unikraft.org/memcached:1.6 + + - name: Archive OCI digests + uses: actions/upload-artifact@v3 + with: + name: oci-digests-${{ matrix.arch }}-${{ matrix.plat }} + path: ${{ github.workspace }}/.kraftkit/oci/digests + if-no-files-found: error + + push: + if: ${{ github.event_name == 'push' || github.event_name == 'schedule' }} + needs: [ build ] + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Login to OCI registry + uses: docker/login-action@v2 + with: + registry: index.unikraft.io + username: ${{ secrets.REG_USERNAME }} + password: ${{ secrets.REG_TOKEN }} + + - name: Retrieve, merge and push OCI digests + uses: ./.github/actions/merge-oci-digests + with: + name: index.unikraft.io/unikraft.org/memcached:1.6 + push: true diff --git a/README.md b/README.md index b11f3544..7efd1631 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ kraft pkg ls --apps --update | [![](https://github.com/unikraft/catalog/actions/workflows/library-hugo0.122.yaml/badge.svg)](https://github.com/unikraft/catalog/actions/workflows/library-hugo0.122.yaml) | [`unikraft.org/hugo:0.122`](library/hugo/0.122) | | [![](https://github.com/unikraft/catalog/actions/workflows/library-lua5.4.4.yaml/badge.svg)](https://github.com/unikraft/catalog/actions/workflows/library-lua5.4.4.yaml) | [`unikraft.org/lua:5.4.4`](library/lua/5.4.4) | | [![](https://github.com/unikraft/catalog/actions/workflows/library-lua5.4.yaml/badge.svg)](https://github.com/unikraft/catalog/actions/workflows/library-lua5.4.yaml) | [`unikraft.org/lua:5.4`](library/lua/5.4) | +| [![](https://github.com/unikraft/catalog/actions/workflows/library-memcached1.6.yaml/badge.svg)](https://github.com/unikraft/catalog/actions/workflows/library-memcached1.6.yaml) | [`unikraft.org/memcached:1.6`](library/memcached/1.6) | | [![](https://github.com/unikraft/catalog/actions/workflows/library-nginx1.15.yaml/badge.svg)](https://github.com/unikraft/catalog/actions/workflows/library-nginx1.15.yaml) | [`unikraft.org/nginx:1.15`](library/nginx/1.15) | | [![](https://github.com/unikraft/catalog/actions/workflows/library-nginx1.25.yaml/badge.svg)](https://github.com/unikraft/catalog/actions/workflows/library-nginx1.25.yaml) | [`unikraft.org/nginx:1.25`](library/nginx/1.25) | | [![](https://github.com/unikraft/catalog/actions/workflows/library-node18.yaml/badge.svg)](https://github.com/unikraft/catalog/actions/workflows/library-node18.yaml) | [`unikraft.org/node:18`](library/node/18) | diff --git a/library/memcached/1.6/.dockerignore b/library/memcached/1.6/.dockerignore new file mode 100644 index 00000000..a154b6ff --- /dev/null +++ b/library/memcached/1.6/.dockerignore @@ -0,0 +1,3 @@ +/Makefile.uk +/.unikraft/ +/.config* diff --git a/library/memcached/1.6/.gitignore b/library/memcached/1.6/.gitignore new file mode 100644 index 00000000..a154b6ff --- /dev/null +++ b/library/memcached/1.6/.gitignore @@ -0,0 +1,3 @@ +/Makefile.uk +/.unikraft/ +/.config* diff --git a/library/memcached/1.6/Dockerfile b/library/memcached/1.6/Dockerfile new file mode 100644 index 00000000..2d92deaa --- /dev/null +++ b/library/memcached/1.6/Dockerfile @@ -0,0 +1,35 @@ +FROM memcached:1.6.23-bookworm as build + +FROM alpine:3 AS sys + +RUN set -xe; \ + mkdir -p /target/etc; \ + mkdir -p /blank; \ + apk --no-cache add \ + ca-certificates \ + tzdata \ + ; \ + update-ca-certificates; \ + ln -sf ../usr/share/zoneinfo/Etc/UTC /target/etc/localtime; \ + echo "Etc/UTC" > /target/etc/timezone; + +FROM scratch + +COPY --from=sys /target/etc /etc +COPY --from=sys /usr/share/zoneinfo/Etc/UTC /usr/share/zoneinfo/Etc/UTC +COPY --from=sys /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt +COPY --from=sys /blank /tmp + +# Binary executable +COPY --from=build /usr/local/bin/memcached /usr/bin/memcached + +# System libraryes +COPY --from=build /lib/x86_64-linux-gnu/libssl.so.3 /lib/x86_64-linux-gnu/libssl.so.3 +COPY --from=build /lib/x86_64-linux-gnu/libcrypto.so.3 /lib/x86_64-linux-gnu/libcrypto.so.3 +COPY --from=build /lib/x86_64-linux-gnu/libevent-2.1.so.7 /lib/x86_64-linux-gnu/libevent-2.1.so.7 +COPY --from=build /lib/x86_64-linux-gnu/libsasl2.so.2 /lib/x86_64-linux-gnu/libsasl2.so.2 +COPY --from=build /lib/x86_64-linux-gnu/libc.so.6 /lib/x86_64-linux-gnu/libc.so.6 +COPY --from=build /lib64/ld-linux-x86-64.so.2 /lib64/ld-linux-x86-64.so.2 + +# Configuration files +COPY --from=build /etc/passwd /etc/passwd diff --git a/library/memcached/1.6/Kraftfile b/library/memcached/1.6/Kraftfile new file mode 100644 index 00000000..1318e31b --- /dev/null +++ b/library/memcached/1.6/Kraftfile @@ -0,0 +1,130 @@ +spec: v0.6 + +name: memcached + +rootfs: ./Dockerfile + +cmd: ["/usr/bin/memcached", "-u", "root"] + +template: + source: https://github.com/unikraft/app-elfloader.git + version: staging + +unikraft: + source: https://github.com/unikraft/unikraft.git + version: staging + kconfig: + # Configurations options for app-elfloader + # (they can't be part of the template atm) + CONFIG_APPELFLOADER_ARCH_PRCTL: 'y' + CONFIG_APPELFLOADER_BRK: 'y' + CONFIG_APPELFLOADER_CUSTOMAPPNAME: 'y' + CONFIG_APPELFLOADER_STACK_NBPAGES: 128 + CONFIG_APPELFLOADER_VFSEXEC_EXECBIT: 'n' + CONFIG_APPELFLOADER_VFSEXEC: 'y' + CONFIG_APPELFLOADER_AUTOGEN_REPLACEEXIST: 'y' + # Unikraft options + CONFIG_HAVE_PAGING_DIRECTMAP: 'y' + CONFIG_HAVE_PAGING: 'y' + CONFIG_I8042: 'y' + CONFIG_LIBDEVFS_AUTOMOUNT: 'y' + CONFIG_LIBDEVFS_DEV_NULL: 'y' + CONFIG_LIBDEVFS_DEV_STDOUT: 'y' + CONFIG_LIBDEVFS_DEV_ZERO: 'y' + CONFIG_LIBDEVFS: 'y' + CONFIG_LIBPOSIX_ENVIRON_ENVP0: "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" + CONFIG_LIBPOSIX_ENVIRON_ENVP1: "LD_LIBRARY_PATH=/usr/local/lib:/usr/lib:/lib" + CONFIG_LIBPOSIX_ENVIRON_ENVP2: "HOME=/" + CONFIG_LIBPOSIX_ENVIRON: 'y' + CONFIG_LIBPOSIX_ENVIRON_LIBPARAM: 'y' + CONFIG_LIBPOSIX_ENVIRON_LIBPARAM_MAXCOUNT: '64' + CONFIG_LIBPOSIX_EVENTFD: 'y' + CONFIG_LIBPOSIX_FDIO: 'y' + CONFIG_LIBPOSIX_FDTAB: 'y' + CONFIG_LIBPOSIX_FUTEX: 'y' + CONFIG_LIBPOSIX_MMAP: 'y' + CONFIG_LIBPOSIX_PIPE: 'y' + CONFIG_LIBPOSIX_POLL: 'y' + CONFIG_LIBPOSIX_PROCESS_CLONE: 'y' + CONFIG_LIBPOSIX_SOCKET: 'y' + CONFIG_LIBPOSIX_SYSINFO: 'y' + CONFIG_LIBPOSIX_TIME: 'y' + CONFIG_LIBPOSIX_TIMERFD: 'y' + CONFIG_LIBPOSIX_UNIXSOCKET: 'y' + CONFIG_LIBPOSIX_USER_GID: 0 + CONFIG_LIBPOSIX_USER_GROUPNAME: "root" + CONFIG_LIBPOSIX_USER_UID: 0 + CONFIG_LIBPOSIX_USER_USERNAME: "root" + CONFIG_LIBPOSIX_USER: 'y' + CONFIG_LIBRAMFS: 'y' + CONFIG_LIBSYSCALL_SHIM_HANDLER_ULTLS: 'y' + CONFIG_LIBSYSCALL_SHIM_HANDLER: 'y' + CONFIG_LIBSYSCALL_SHIM_LEGACY_VERBOSE: 'y' + CONFIG_LIBSYSCALL_SHIM: 'y' + CONFIG_LIBUKALLOCPOOL: 'y' + CONFIG_LIBUKBLKDEV_MAXNBQUEUES: '1' + CONFIG_LIBUKBLKDEV_DISPATCHERTHREADS: 'y' + CONFIG_LIBUKBLKDEV_SYNC_IO_BLOCKED_WAITING: 'y' + CONFIG_LIBUKBLKDEV: 'y' + CONFIG_LIBUKBOOT_BANNER_MINIMAL: 'y' + CONFIG_LIBUKBOOT_HEAP_BASE: '0x400000000' + CONFIG_LIBUKBOOT_MAINTHREAD: 'y' + CONFIG_LIBUKBOOT_SHUTDOWNREQ_HANDLER: 'y' + CONFIG_LIBUKCPIO: 'y' + CONFIG_LIBUKDEBUG_CRASH_SCREEN: 'y' + CONFIG_LIBUKDEBUG_ENABLE_ASSERT: 'y' + CONFIG_LIBUKDEBUG_PRINT_SRCNAME: 'n' + CONFIG_LIBUKDEBUG_PRINT_TIME: 'y' + CONFIG_LIBUKDEBUG_PRINTK_ERR: 'y' + CONFIG_LIBUKDEBUG_PRINTK: 'y' + CONFIG_LIBUKDEBUG: 'y' + CONFIG_LIBUKFALLOC: 'y' + CONFIG_LIBUKMPI: 'n' + CONFIG_LIBUKSIGNAL: 'y' + CONFIG_LIBUKSWRAND_DEVFS: 'y' + CONFIG_LIBUKSWRAND: 'y' + CONFIG_LIBUKVMEM_DEFAULT_BASE: '0x0000001000000000' + CONFIG_LIBUKVMEM_DEMAND_PAGE_IN_SIZE: 12 + CONFIG_LIBUKVMEM_PAGEFAULT_HANDLER_PRIO: 4 + CONFIG_LIBUKVMEM: 'y' + CONFIG_LIBVFSCORE_AUTOMOUNT_CI: 'y' + CONFIG_LIBVFSCORE_AUTOMOUNT_CI_EINITRD: 'y' + CONFIG_LIBVFSCORE_NONLARGEFILE: 'y' + CONFIG_LIBVFSCORE: 'y' + CONFIG_OPTIMIZE_DEADELIM: 'y' + CONFIG_OPTIMIZE_LTO: 'y' + CONFIG_PAGING: 'y' + CONFIG_STACK_SIZE_PAGE_ORDER: 4 # 128 * 4K = 512K + CONFIG_UKPLAT_MEMREGION_MAX_COUNT: 64 + + # Debug options + # CONFIG_LIBUKDEBUG_PRINTD: 'y' + # CONFIG_LIBUKDEBUG_PRINTK_INFO: 'y' + # CONFIG_LIBSYSCALL_SHIM_STRACE: 'y' + +libraries: + lwip: + source: https://github.com/unikraft/lib-lwip.git + version: staging + kconfig: + CONFIG_LWIP_TCP: 'y' + CONFIG_LWIP_UDP: 'y' + CONFIG_LWIP_RAW: 'y' + CONFIG_LWIP_WND_SCALE: 'y' + CONFIG_LWIP_TCP_KEEPALIVE: 'y' + CONFIG_LWIP_THREADS: 'y' + CONFIG_LWIP_HEAP: 'y' + CONFIG_LWIP_SOCKET: 'y' + CONFIG_LWIP_AUTOIFACE: 'y' + CONFIG_LWIP_NUM_TCPCON: 64 + CONFIG_LWIP_NUM_TCPLISTENERS: 64 + CONFIG_LWIP_ICMP: 'y' + CONFIG_LWIP_DHCP: 'y' + CONFIG_LWIP_DNS: 'n' + libelf: + source: https://github.com/unikraft/lib-libelf.git + version: staging + +targets: +- fc/x86_64 +- qemu/x86_64 diff --git a/library/memcached/1.6/README.md b/library/memcached/1.6/README.md new file mode 100644 index 00000000..9bd4d576 --- /dev/null +++ b/library/memcached/1.6/README.md @@ -0,0 +1,89 @@ +# Memcached + +This directory contains the [`Memcached`](https://memcached.org/) runtime on Unikraft, in binary compatibility mode. +It implements a simple HTTP server running on Unikraft that provides a simple response to each request. + +## Run and Use + +Use `kraft` to run the image and start a Unikraft instance: + +```bash +kraft run --rm -p 11211:11211 --plat qemu --arch x86_64 unikraft.org/memcached:1.6 +``` + +If the `--plat` argument is left out, it defaults to `qemu`. +If the `--arch` argument is left out, it defaults to your system's CPU architecture. + +Once executed, it will open port `11211` and wait for connections. + +Investigate the service via `telnet`: + +```console +telnet localhost 11211 +``` + +```text +Trying 127.0.0.1... +Connected to localhost. +Escape character is '^]'. +stats +STAT pid 1 +STAT uptime 15 +STAT time 1706423794 +STAT version 1.6.23 +STAT libevent 2.1.12-stable +STAT pointer_size 64 +[...] +``` + +## Inspect and Close + +To list information about the Unikraft instance, use: + +```bash +kraft ps +``` + +```text +NAME KERNEL ARGS CREATED STATUS MEM PORTS PLAT +quizzical_johndanielii project://memcached:qemu/x86_64 /usr/bin/memcached -u root 7 seconds ago running 0MiB 0.0.0.0:11211->11211/tcp qemu/x86_64 +``` + +The instance name is `quizzical_johndanielii`. +To close the Unikraft instance, close the `kraft` process (e.g., via `Ctrl+c`) or run: + +```bash +kraft rm quizzical_johndanielii +``` + +## Build and Run Locally + +The commands so far used the pre-build Ruby image available in the Unikraft registry. + +In oder to to build a local image, clone this repository and `cd` into this directory. +Then use `kraft` to build an image locally: + +```bash +kraft build --no-cache --no-update --plat qemu --arch x86_64 +``` + +Similar to the `kraft run` command, if the `--plat` argument is left out, it defaults to `qemu`. +If the `--arch` argument is left out, it defaults to your system's CPU architecture. + +In order to run the locally built image, use `.` (_dot_, the current directory) as the final argument to the `kraft run` command: + +```bash +kraft run --rm -p 11211:11211 --plat qemu --arch x86_64 . +``` + +Same as above, it will open port `11211` and wait for connections. + +## `kraft` and `sudo` + +Mixing invocations of `kraft` and `sudo` can lead to unexpected behavior. +Read more about how to start `kraft` without `sudo` at [https://unikraft.org/sudoless](https://unikraft.org/sudoless). + +## Learn More + +- [How to run unikernels locally](https://unikraft.org/docs/cli/running) +- [How to build `Dockerfile` root filesystems with BuildKit](https://unikraft.org/guides/building-dockerfile-images-with-buildkit)