Merge pull request #229 from skriss/plugin-docs

add godoc for ResourceSelector

pkg/backup/item_action.go

@@ -48,9 +48,27 @@ type ResourceIdentifier struct {
 // included/excluded resources, and a label-selector that can be used
 // to match a set of items from a cluster.
 type ResourceSelector struct {
+	// IncludedNamespaces is a slice of namespace names to match. All
+	// namespaces in this slice, except those in ExcludedNamespaces,
+	// will be matched. A nil/empty slice matches all namespaces.
 	IncludedNamespaces []string
+	// ExcludedNamespaces is a slice of namespace names to exclude.
+	// All namespaces in IncludedNamespaces, *except* those in
+	// this slice, will be matched.
 	ExcludedNamespaces []string
-	IncludedResources  []string
-	ExcludedResources  []string
-	LabelSelector      string
+	// IncludedResources is a slice of resources to match. Resources
+	// may be specified as full names (e.g. "services") or abbreviations
+	// (e.g. "svc"). All resources in this slice, except those in
+	// ExcludedResources, will be matched. A nil/empty slice matches
+	// all resources.
+	IncludedResources []string
+	// ExcludedResources is a slice of resources to exclude.
+	// Resources may be specified as full names (e.g. "services") or
+	// abbreviations (e.g. "svc"). All resources in IncludedResources,
+	// *except* those in this slice, will be matched.
+	ExcludedResources []string
+	// LabelSelector is a string representation of a selector to apply
+	// when matching resources. See "k8s.io/apimachinery/pkg/labels".Parse()
+	// for details on syntax.
+	LabelSelector string
 }

pkg/restore/item_action.go

@@ -41,9 +41,27 @@ type ItemAction interface {
 // included/excluded resources, and a label-selector that can be used
 // to match a set of items from a cluster.
 type ResourceSelector struct {
+	// IncludedNamespaces is a slice of namespace names to match. All
+	// namespaces in this slice, except those in ExcludedNamespaces,
+	// will be matched. A nil/empty slice matches all namespaces.
 	IncludedNamespaces []string
+	// ExcludedNamespaces is a slice of namespace names to exclude.
+	// All namespaces in IncludedNamespaces, *except* those in
+	// this slice, will be matched.
 	ExcludedNamespaces []string
-	IncludedResources  []string
-	ExcludedResources  []string
-	LabelSelector      string
+	// IncludedResources is a slice of resources to match. Resources
+	// may be specified as full names (e.g. "services") or abbreviations
+	// (e.g. "svc"). All resources in this slice, except those in
+	// ExcludedResources, will be matched. A nil/empty slice matches
+	// all resources.
+	IncludedResources []string
+	// ExcludedResources is a slice of resources to exclude.
+	// Resources may be specified as full names (e.g. "services") or
+	// abbreviations (e.g. "svc"). All resources in IncludedResources,
+	// *except* those in this slice, will be matched.
+	ExcludedResources []string
+	// LabelSelector is a string representation of a selector to apply
+	// when matching resources. See "k8s.io/apimachinery/pkg/labels".Parse()
+	// for details on syntax.
+	LabelSelector string
 }