Sarkan DocumentationSarkan Documentation
Overview
  • HostDisk CSI
  • SaunaFS Operator
  • SaunaFS CSI
Website
Contact Us
Overview
  • HostDisk CSI
  • SaunaFS Operator
  • SaunaFS CSI
Website
Contact Us
  • Overview

    • Introduction
    • Prerequisites
    • Installation
  • HostDisk CSI

    • Introduction
    • Deployment
    • Usage
    • Design
    • Hostdisk Metrics
  • SaunaFS Operator

    • Introduction
    • Deployment
    • Usage
    • NFS Ganesha
    • Architecture
    • Custom resources
    • Metric exporters
    • Sarkan Grafana Dashboard
  • SaunaFS CSI

    • Introduction
    • Deployment
    • Usage
    • Design

Installation

Helm registry

Authorize to Sarkan's OCI registry using Helm:

helm registry login 'registry.indevops.com'

Hostdisk CSI

  1. Generate a new values.yml file from the defaults:

    helm show values oci://registry.indevops.com/hostdisk-csi/hostdisk-csi > values.yml
    

    Version

    You can generate a values file and install a specific version by using the --version option with both the helm show values and helm install commands

  2. Edit the values.yml and configure it to match your cluster and requirements. You will need to configure the registry using valid credentials.

    registry:
        hostname: registry.indevops.com
        namespace: hostdisk-csi
        username: my-username
        password: my-password
    
    kubeletPath: /var/lib/kubelet
    
  3. Deploy to the Kubernetes cluster:

    helm install "hostdisk-csi" \
        oci://registry.indevops.com/hostdisk-csi/hostdisk-csi \
        --create-namespace -n "hostdisk-csi" \
        -f ./values.yml
    
  4. Use following commands to make sure the installation was successful:

    kubectl --namespace hostdisk-csi rollout status daemonset hostdisk-csi-node
    kubectl --namespace hostdisk-csi rollout status daemonset hostdisk-csi-manager
    
  5. See Hostdisk CSI section for further configuration of this component.

SaunaFS Operator

  1. Generate a new values.yml file from the defaults:

    helm show values oci://registry.indevops.com/saunafs-operator/saunafs-operator > values.yml
    

    Version

    You can generate a values file and install a specific version by using the --version option with both the helm show values and helm install commands

  2. Edit the values.yml and configure it to match your cluster and requirements. You will need to configure the registry using valid credentials.

    registry:
        hostname: registry.indevops.com
        namespace: saunafs-operator
        username: my-username
        password: my-password
    
    kubeletPath: /var/lib/kubelet
    
  3. Deploy to the Kubernetes cluster:

    helm install "saunafs-operator" \
        oci://registry.indevops.com/saunafs-operator/saunafs-operator \
        --create-namespace -n "saunafs-operator" \
        -f ./values.yml
    
  4. Use following commands to make sure the installation was successful:

    kubectl --namespace saunafs-operator rollout status daemonset saunafs-operator
    kubectl --namespace saunafs-operator rollout status deployment saunafs-cgi
    
  5. See SaunaFS Operator section for further configuration of this component.

SaunaFS CSI

  1. Generate a new values.yml file from the defaults:

    helm show values oci://registry.indevops.com/saunafs-csi/saunafs-csi > values.yml
    

    Version

    You can generate a values file and install a specific version by using the --version option with both the helm show values and helm install commands

  2. Edit the values.yml and configure it to match your cluster and requirements. You will need to configure the registry using valid credentials.

    registry:
        hostname: registry.indevops.com
        namespace: saunafs-csi
        username: my-username
        password: my-password
    
    # Path on host machine where SaunaFS volumes will be mounted.
    hostMountPath: "/var/lib/saunafs"
    
    kubeletPath: /var/lib/kubelet
    
  3. Deploy to the Kubernetes cluster:

    helm install "saunafs-csi" \
        oci://registry.indevops.com/saunafs-csi/saunafs-csi \
        --create-namespace -n "saunafs-csi" \
        -f ./values.yml
    
  4. Use following commands to make sure the installation was successful:

    kubectl --namespace saunafs-csi rollout status deployment saunafs-csi-controller
    kubectl --namespace saunafs-csi rollout status daemonset saunafs-csi-node
    
  5. See SaunaFS CSI section for further configuration of this component.

Prev
Prerequisites

Copyright © 2025 Sarkan. All rights reserved.
Made with ❤️ by Indevops for Kubernetes and SaunaFS 💑.