glusterfs

README

GlusterFS Driver

Status: Not for production, experimental only

This driver provides an example deployment of GlusterFS onto Kuberntes. It is based on Heketi provides Kubernetes with dynamic provisioning of GlusterFS volumes from multiple storage clusters.

Requirements

To you create at least a three node cluster, you can use Matchbox/Bootkube or Kubernetes-CentOS.

• At least 2Gi RAM
  • Matchbox/Bootkube: Edit scripts/libvirt in Matchbox and change the value of --memory=1024 to --memory=2048.
• At least one raw extra disk for use by GlusterFS
  • Matchbox/Bootkube: Edit scripts/libvirt in Matchbox and add the switch --disk size=100 after --disk pool=default,size=6.
• Although it is currently being investigated how to do this automatically, ports on the nodes must be opened according to Infrastructure Requirements. It is necessary to open these ports because the containers require (today) a network using host-net, not cluster net.
  • Not necessary if using Matchbox/Bootkube or Kubernetes-CentOS.
• If the Kubernetes system is running some time of authorization mechanism, like RBAC, you may need to setup a service account called heketi-service-account which provides the appropriate rules for Heketi to run container exec commands successfully. See examples/glusterfs/auth/rbac.
  • Needed for Matchbox/Bootkube, but not for Kubernetes-CentOS since the latter has no authorization.
• Nodes need to have the kernel module dm_thin_pool loaded
  • Needed for Matchbox/Bootkube, but already installed in Kubernetes-CentOS.

Deployment

The file examples/glusterfs/cluster.yml contains an example GlusterFS deployment using three nodes. The file has been setup to work with the demo Kuberntes deployment, but you can change the number of servers and node names according to your Kuberntes cluster. There is also an examples/glusterfs/aws.yml provided as an example. To deploy the GlusterFS storage, type:

$ kubectl create -f examples/glusterfs/cluster.yaml

You can check the status of the storage cluster, storage nodes, and Heketi by running the following:

$ kubectl get storagecluster -o yaml
$ kubectl get storagenodes -o yaml
$ kubectl get pods

Deployment of GlusterFS cluster may take some time. You may look at the status of your cluster by looking to see if is ready:

$ kubectl get storagecluster gluster -o yaml

Once the cluster is ready, a StorageClass will be created automatically to enable dynamic provisioning of volumes from the GlusterFS cluster.

$ kubectl get storageclass

Troubleshooting

To easiest way to check for errors is to check the logs of Heketi and QM.

Example Application

The file examples/glusterfs/nginx-demo.yaml contains an example application set which will utilize dynamic provisioning to create a physical volume. Simply run the following command to start the demo:

$ kubectl create -f examples/glusterfs/nginx-demo.yaml

This application runs a set of pods which write a index.html file with the date and the host name. To see the output of the application, determine the NodePort of the nginx service. Here is an example application output:

$ kubectl get svc my-nginx-svc -o yaml | grep nodePort
  - nodePort: 31823
$ curl http://<ip of a Kubernetes node>:31823
Mon Mar 20 19:37:30 UTC 2017
nfs-busybox-2t80g

Documentation

Index

• func IsGlusterFSStorageClusterUsable(c *spec.StorageCluster) error
• func IsGlusterFSStorageNodeUsable(s *spec.StorageNode) error
• func New(client kubernetes.Interface, qm restclient.Interface) (qmstorage.StorageType, error)
• type GlusterStorage
  • func (st *GlusterStorage) AddCluster(c *spec.StorageCluster) (*spec.StorageCluster, error)
  • func (st *GlusterStorage) AddNode(s *spec.StorageNode) (*spec.StorageNode, error)
  • func (st *GlusterStorage) DeleteCluster(c *spec.StorageCluster) error
  • func (st *GlusterStorage) DeleteNode(s *spec.StorageNode) error
  • func (st *GlusterStorage) Init() error
  • func (st *GlusterStorage) MakeDeployment(s *spec.StorageNode, old *v1beta1.Deployment) (*v1beta1.Deployment, error)
  • func (st *GlusterStorage) Type() spec.StorageTypeIdentifier
  • func (st *GlusterStorage) UpdateCluster(old *spec.StorageCluster, new *spec.StorageCluster) error
  • func (st *GlusterStorage) UpdateNode(s *spec.StorageNode) (*spec.StorageNode, error)

Functions

func IsGlusterFSStorageClusterUsable

func IsGlusterFSStorageClusterUsable(c *spec.StorageCluster) error

func IsGlusterFSStorageNodeUsable

func IsGlusterFSStorageNodeUsable(s *spec.StorageNode) error

func New

func New(client kubernetes.Interface, qm restclient.Interface) (qmstorage.StorageType, error)

Types

type GlusterStorage

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

func (*GlusterStorage) AddCluster

func (st *GlusterStorage) AddCluster(c *spec.StorageCluster) (*spec.StorageCluster, error)

func (*GlusterStorage) AddNode

func (st *GlusterStorage) AddNode(s *spec.StorageNode) (*spec.StorageNode, error)

func (*GlusterStorage) DeleteCluster

func (st *GlusterStorage) DeleteCluster(c *spec.StorageCluster) error

func (*GlusterStorage) DeleteNode

func (st *GlusterStorage) DeleteNode(s *spec.StorageNode) error

func (*GlusterStorage) Init

func (st *GlusterStorage) Init() error

func (*GlusterStorage) MakeDeployment

func (st *GlusterStorage) MakeDeployment(s *spec.StorageNode,
	old *v1beta1.Deployment) (*v1beta1.Deployment, error)

func (*GlusterStorage) Type

func (st *GlusterStorage) Type() spec.StorageTypeIdentifier

func (*GlusterStorage) UpdateCluster

func (st *GlusterStorage) UpdateCluster(old *spec.StorageCluster,
	new *spec.StorageCluster) error

func (*GlusterStorage) UpdateNode

func (st *GlusterStorage) UpdateNode(s *spec.StorageNode) (*spec.StorageNode, error)