nfs

Documentation

Overview

Package nfs to manage an NFS export.

Package nfs operator to manage NFS Server.

Portion of this file is comming from https://github.com/kubernetes-incubator/external-storage/blob/master/nfs/pkg/server/server.go

Index

• Constants
• Variables
• func NewNFSProvisioner(clientset kubernetes.Interface, rookClientset rookclient.Interface) *nfsProvisioner
• func Run(ganeshaConfig string) error
• func Setup(ganeshaConfig string) error
• func Stop()
• type Controller
  • func NewController(context *clusterd.Context, containerImage string) *Controller
  • func (c *Controller) StartWatch(namespace string, stopCh chan struct{}) error
• type Operator
  • func New(context *clusterd.Context, containerImage string) *Operator
  • func (o *Operator) Run() error

Constants

const (
	NFSConfigMapPath = "/nfs-ganesha/config"
)

Variables

var NFSResource = opkit.CustomResource{
	Name:    customResourceName,
	Plural:  customResourceNamePlural,
	Group:   nfsv1alpha1.CustomResourceGroup,
	Version: nfsv1alpha1.Version,
	Scope:   apiextensionsv1beta1.NamespaceScoped,
	Kind:    reflect.TypeOf(nfsv1alpha1.NFSServer{}).Name(),
}

NFSResource represents the nfs export custom resource

Functions

func NewNFSProvisioner

func NewNFSProvisioner(clientset kubernetes.Interface, rookClientset rookclient.Interface) *nfsProvisioner

NewNFSProvisioner returns an instance of nfsProvisioner

func Run

func Run(ganeshaConfig string) error

Run : run the NFS server in the foreground until it exits Ideally, it should never exit when run in foreground mode We force foreground to allow the provisioner process to restart the server if it crashes - daemonization prevents us from using Wait() for this purpose

func Setup

func Setup(ganeshaConfig string) error

Setup sets up various prerequisites and settings for the server. If an error is encountered at any point it returns it instantly

func Stop

func Stop()

Stop stops the NFS server.

Types

type Controller

type Controller struct {
	// contains filtered or unexported fields
}

Controller represents a controller object for nfs server custom resources

func NewController

func NewController(context *clusterd.Context, containerImage string) *Controller

NewController create controller for watching nfsserver custom resources created

func (*Controller) StartWatch

func (c *Controller) StartWatch(namespace string, stopCh chan struct{}) error

StartWatch watches for instances of nfsserver custom resources and acts on them

type Operator

type Operator struct {
	// contains filtered or unexported fields
}

Operator type for managing NFS Server.

func New

func New(context *clusterd.Context, containerImage string) *Operator

New creates an operator instance.

func (*Operator) Run

func (o *Operator) Run() error

Run the operator instance.