kiwix

Note

To view the full example, as well as its dependencies, please visit examples/kiwix.

This example shows Zarf’s ability to inject data into a container running in a pod, in this case to initialize a Kiwix server to allow offline viewing of documentation and wiki pages.

Data injections allow for data that is not included in the container image to be injected at deploy time and are declared using the dataInjections key within a component. Once the specified container is started, Zarf will copy the files and folders from the specified source into the specified container and path.

Caution

Data injections depend on the tar (and for compress, gzip) executables and their implementation across operating systems. Between macOS and Linux there is general agreement on how these utilities should function, however on Windows you may see issues enabling compression.

To resolve this you can either disable compression or use the GNU core-utils version of tar and gzip.

zarf.yaml

kind: ZarfPackageConfig
metadata:
  name: kiwix
  description: Demo Zarf data injection with Kiwix (https://www.kiwix.org/en/)
  # (optional) Some large datasets may already be compressed making Zarf compression less efficient
  uncompressed: true
  version: 3.5.0

components:
  - name: kiwix-serve
    required: true
    manifests:
      - name: kiwix-serve
        namespace: kiwix
        files:
          - manifests/persistence.yaml
          - manifests/deployment.yaml
          - manifests/service.yaml
    images:
      - ghcr.io/kiwix/kiwix-serve:3.5.0-2
      - alpine:3.18
    # Add new data into the cluster, these will keep trying up until their timeout
    dataInjections:
      # Injection in the data directory using the data-loader init container
      - source: zim-data
        target:
          namespace: kiwix
          selector: app=kiwix-serve
          container: data-loader
          path: /data
        compress: true
    actions:
      onCreate:
        before:
          # Download a .zim file of a DevOps Stack Exchange snapshot into the data directory for use with Kiwix
          - cmd: curl
              https://zarf-remote.s3.us-east-2.amazonaws.com/testdata/devops.stackexchange.com_en_all_2023-05.zim
              -o zim-data/devops.stackexchange.com_en_all_2023-05.zim
          # Below are some more examples of *.zim files of available content:
          # https://library.kiwix.org/?lang=eng
          # NOTE: If `zarf package create`ing regularly you should mirror content to a web host you control to be a friendly neighbor

          # YAML keys starting with `x-` are custom keys that are ignored by the Zarf CLI
          # The `x-mdx` key is used to render the markdown content for https://docs.zarf.dev/ref/examples