add comment docs and make funcs private if possible

coreos · Jan 19, 2018 · 34c3ac4 · 34c3ac4
1 parent 2f8dc0d
commit 34c3ac4
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 4 deletions.
diff --git a/pkg/apis/etcd/v1beta2/cluster.go b/pkg/apis/etcd/v1beta2/cluster.go
@@ -139,7 +139,8 @@ type PodPolicy struct {
 	// This field cannot be updated.
 	EtcdEnv []v1.EnvVar `json:"etcdEnv,omitempty"`
 
-	// PersistentVolumeClaimSpec ...
+	// PersistentVolumeClaimSpec is the spec to describe PVC for the etcd container
+	// This field is optional. If no PVC spec, etcd container will use emptyDir as volume
 	PersistentVolumeClaimSpec *v1.PersistentVolumeClaimSpec `json:"persistentVolumeClaimSpec,omitempty"`
 }
 

diff --git a/pkg/cluster/cluster.go b/pkg/cluster/cluster.go
@@ -375,7 +375,7 @@ func (c *Cluster) setupServices() error {
 	return k8sutil.CreatePeerService(c.config.KubeCli, c.cluster.Name, c.cluster.Namespace, c.cluster.AsOwner())
 }
 
-func (c *Cluster) IsPodPVEnabled() bool {
+func (c *Cluster) isPodPVEnabled() bool {
 	if podPolicy := c.cluster.Spec.Pod; podPolicy != nil {
 		return podPolicy.PersistentVolumeClaimSpec != nil
 	}
@@ -384,7 +384,7 @@ func (c *Cluster) IsPodPVEnabled() bool {
 
 func (c *Cluster) createPod(members etcdutil.MemberSet, m *etcdutil.Member, state string) error {
 	pod := k8sutil.NewEtcdPod(m, members.PeerURLPairs(), c.cluster.Name, state, uuid.New(), c.cluster.Spec, c.cluster.AsOwner())
-	if c.IsPodPVEnabled() {
+	if c.isPodPVEnabled() {
 		pvc := k8sutil.NewEtcdPodPVC(m, *c.cluster.Spec.Pod.PersistentVolumeClaimSpec, c.cluster.Name, c.cluster.Namespace, c.cluster.AsOwner())
 		_, err := c.config.KubeCli.CoreV1().PersistentVolumeClaims(c.cluster.Namespace).Create(pvc)
 		if err != nil {

diff --git a/pkg/cluster/reconcile.go b/pkg/cluster/reconcile.go
@@ -217,7 +217,7 @@ func (c *Cluster) removeMember(toRemove *etcdutil.Member) (err error) {
 	if err := c.removePod(toRemove.Name); err != nil {
 		return err
 	}
-	if c.IsPodPVEnabled() {
+	if c.isPodPVEnabled() {
 		err = c.removePVC(k8sutil.PVCNameFromMemberName(toRemove.Name))
 		if err != nil {
 			return err

diff --git a/pkg/util/k8sutil/k8sutil.go b/pkg/util/k8sutil/k8sutil.go
@@ -78,6 +78,7 @@ func GetPodNames(pods []*v1.Pod) []string {
 	return res
 }
 
+// PVCNameFromMemberName the way we get PVC name from the member name
 func PVCNameFromMemberName(memberName string) string {
 	return memberName
 }
@@ -249,6 +250,7 @@ func NewSeedMemberPod(clusterName string, ms etcdutil.MemberSet, m *etcdutil.Mem
 	return pod
 }
 
+// NewEtcdPodPVC create PVC object from etcd pod's PVC spec
 func NewEtcdPodPVC(m *etcdutil.Member, pvcSpec v1.PersistentVolumeClaimSpec, clusterName, namespace string, owner metav1.OwnerReference) *v1.PersistentVolumeClaim {
 	pvc := &v1.PersistentVolumeClaim{
 		ObjectMeta: metav1.ObjectMeta{