ci: add release pipeline and getting-started doc

Signed-off-by: imeoer <[email protected]>

Author: imeoer

.github/workflows/e2e.yml

@@ -18,16 +18,6 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Cache Go modules
-        uses: actions/cache@v4
-        with:
-          path: |
-            ~/.cache/go-build
-            ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-
-
       - name: Cache Docker layers
         uses: actions/cache@v4
         with:
@@ -36,21 +26,16 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-docker-buildx-
 
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
       - name: Build Docker Image
         uses: docker/build-push-action@v5
         with:
           context: .
-          file: build/Dockerfile.test
-          build-args: |
-            HOME=${{ env.HOME }}
+          file: ./build/Dockerfile
+          platforms: linux/amd64,linux/arm64
           tags: model-csi-driver:latest
-          load: true
           push: false
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache-new
@@ -90,6 +75,7 @@ jobs:
 
       - name: Deploy model-csi-driver chart
         run: |
+          sed -i "s/VERSION/0.1.0/g" charts/model-csi-driver/Chart.yaml
           helm upgrade --install model-csi-driver ./charts/model-csi-driver --namespace model-csi --create-namespace
 
       - name: Wait for model-csi-driver pods to be ready

.github/workflows/release.yml

@@ -0,0 +1,83 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    env:
+      REGISTRY: ghcr.io
+      IMAGE_NAME: ${{ github.repository }}
+      CHART_NAME: model-csi-driver
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Cache Docker layers
+        uses: actions/cache@v4
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-docker-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-docker-buildx-
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Extract tag name (version)
+        id: extract_tag
+        run: echo "tag=${GITHUB_REF##*/}" >> "$GITHUB_OUTPUT"
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./build/Dockerfile
+          push: true
+          platforms: linux/amd64,linux/arm64
+          tags: |
+            ghcr.io/${{ github.repository }}:${{ steps.extract_tag.outputs.tag }}
+            ghcr.io/${{ github.repository }}:latest
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache-new
+
+      - name: Move Docker Build Cache
+        run: |
+          rm -rf /tmp/.buildx-cache
+          mv /tmp/.buildx-cache-new /tmp/.buildx-cache || true
+
+      - name: Install Helm
+        run: |
+          curl -fsSL https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
+
+      - name: Update chart version
+        run: |
+          TAG=$(echo ${{ steps.extract_tag.outputs.tag }} | sed 's/^v//')
+          sed -i "s/VERSION/${TAG}/g" charts/${CHART_NAME}/Chart.yaml
+
+      - name: Helm registry login
+        run: |
+          echo ${{ secrets.GITHUB_TOKEN }} | helm registry login ghcr.io --username ${{ github.actor }} --password-stdin
+
+      - name: Helm package chart
+        run: |
+          helm package charts/${CHART_NAME} --destination .
+      
+      - name: Helm push chart to GHCR
+        run: |
+          CHART_VERSION=$(yq e '.version' charts/${CHART_NAME}/Chart.yaml)
+          CHART_PKG=${CHART_NAME}-${CHART_VERSION}.tgz
+          helm push $CHART_PKG oci://ghcr.io/${{ github.repository_owner }}/charts

README.md

@@ -1,9 +1,11 @@
 # Model CSI Driver
 
-**Status**: 🚧 This project is actively developed, the CI setup and documentation are still in progress.
-
 Model CSI Driver is a Kubernetes CSI driver for serving OCI model artifacts, which are bundled based on [Model Spec](https://github.com/modelpack/model-spec).
 
+## Documentation
+
+You can find the full documentation on the [getting started](./docs/getting-started.md).
+
 ## Copyright
 
 Copyright © contributors to ModelPack, established as ModelPack a Series of LF Projects, LLC.

build/Dockerfile

@@ -0,0 +1,12 @@
+# syntax=docker/dockerfile:1
+
+FROM --platform=$BUILDPLATFORM golang:1.24 AS builder
+ARG TARGETOS
+ARG TARGETARCH
+WORKDIR /app
+COPY . .
+RUN make -e GOARCH=${TARGETARCH} release
+
+FROM ubuntu:24.04
+COPY --from=builder /app/model-csi-driver /usr/bin/model-csi-driver
+ENTRYPOINT ["/usr/bin/model-csi-driver"]

build/Dockerfile.test

@@ -15,10 +15,10 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
+version: "VERSION"
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.1.0"
+appVersion: "VERSION"

charts/model-csi-driver/Chart.yaml

@@ -6,15 +6,12 @@ config:
   # Unique service identifier of CSI registration
   serviceName: model.csi.modelpack.org
   # Root working directory for model storage and metadata,
-  # must be writable and have enough disk space for model storage
+  # must be writable and have enough disk space
   rootDir: /var/lib/model-csi
   registryAuths:
-    # Registry host:port
-    registry.example.com:
-      # Based64 encoded username:password
-      auth: dXNlcm5hbWU6cGFzc3dvcmQ=
-      # Registry server scheme, http or https
-      serverscheme: https
+    # registry.example.com:
+    #   auth: dXNlcm5hbWU6cGFzc3dvcmQ=
+    #   serverscheme: https
 
 namespace: model-csi
 

charts/model-csi-driver/values.yaml

@@ -4,66 +4,69 @@ Model CSI Driver is a Kubernetes CSI driver for serving OCI model artifacts, whi
 
 ## Overview
 
-The Model CSI Driver enables efficient deployment of model in Kubernetes by:
+The Model CSI Driver simplifies and accelerates model deployment in Kubernetes by:
 
-- Easily mount model artifact as volume into pod
-- Compatibility with older Kubernetes versions
-- Natively supports P2P accelerated distribution
+- Seamlessly mount model artifacts as volumes into pod
+- Compatible with older Kubernetes versions
+- Natively supports P2P-accelerated distribution
 
 ## Prerequisites
 
 Before getting started, ensure you have:
 
-- Kubernetes cluster (v1.20+)
-- `kubectl` configured to access your cluster
+- `kubectl` configured to access your Kubernetes cluster
 - Helm v3.x (recommended for installation)
-- Container runtime with CSI support (containerd, CRI-O)
 
 ## Installation
 
 ### Helm Installation
 
-1. Clone the repository:
-```bash
-git clone https://github.com/your-org/model-csi-driver.git
-cd model-csi-driver
-```
-
-2. Create custom configuration:
+1. Create custom configuration:
 
 ```yaml
 # values-custom.yaml
 config:
   # Root working directory for model storage and metadata,
-  # must be writable and have enough disk space for model storage
+  # must be writable and have enough disk space
   rootDir: /var/lib/model-csi
+  # Configuration for private registry auth
   registryAuths:
     # Registry host:port
     registry.example.com:
       # Based64 encoded username:password
       auth: dXNlcm5hbWU6cGFzc3dvcmQ=
       # Registry server scheme, http or https
       serverscheme: https
+image:
+  # Model csi driver daemonset image
+  repository: ghcr.io/modelpack/model-csi-driver
+  pullPolicy: IfNotPresent
+  tag: latest
 ```
 
-3. Install the driver using Helm:
+2. Install the driver using Helm:
 ```bash
-helm install model-csi-driver ./charts/model-csi-driver \
+helm upgrade --install model-csi-driver \
+    oci://ghcr.io/modelpack/charts/model-csi-driver \
     --namespace model-csi \
     --create-namespace \
     -f values-custom.yaml
 ```
 
-4. Verify the installation:
+3. Verify the installation:
 ```bash
 kubectl get pods -n model-csi
 ```
 
 ## Basic Usage
 
+### Create Model Artifact with modctl
+
+Follow the [guide](https://github.com/modelpack/modctl/blob/main/docs/getting-started.md) to build and push a model artifact to an OCI distribution-compatible registry.
+
 ### Create a Pod with Model Volume
 
-The Model CSI Driver uses inline volumes directly in pod specifications. Here's a basic example:
+The Model CSI Driver uses inline volume directly in pod spec, here's a basic example:
 
 ```yaml
 apiVersion: v1
@@ -84,14 +87,12 @@ spec:
     csi:
       driver: model.csi.modelpack.org
       volumeAttributes:
-        modelRef: "registry.example.com/models/bert-base:latest"
+        modelRef: "registry.example.com/models/qwen3-0.6b:latest"
 ```
 
 ## Troubleshooting
 
-### Common Issues
-
-**Pod stuck in Pending or ContainerCreating**
+### Pod stuck in Pending or ContainerCreating
   ```bash
   # Describe a pod with issues
   kubectl describe pod <pod-name>