diff --git a/pkg/deploy/registry/deploy/doc.go b/pkg/deploy/registry/deploy/doc.go new file mode 100644 index 000000000000..c9371eaeaeb5 --- /dev/null +++ b/pkg/deploy/registry/deploy/doc.go @@ -0,0 +1,3 @@ +// Package deploy provides Registry interface and its RESTStorage +// implementation for storing Deployment api objects. +package deploy diff --git a/pkg/deploy/registry/deploy/registry.go b/pkg/deploy/registry/deploy/registry.go index 2a4915bc7f72..8891e7ee8cbb 100644 --- a/pkg/deploy/registry/deploy/registry.go +++ b/pkg/deploy/registry/deploy/registry.go @@ -6,7 +6,7 @@ import ( api "github.com/openshift/origin/pkg/deploy/api" ) -// Registry is an interface for things that know how to store Deployments +// Registry is an interface for things that know how to store Deployments. type Registry interface { ListDeployments(selector labels.Selector) (*api.DeploymentList, error) GetDeployment(id string) (*api.Deployment, error) diff --git a/pkg/deploy/registry/deploy/rest.go b/pkg/deploy/registry/deploy/rest.go index 8cabdfad61ba..c9847d3d4c4d 100644 --- a/pkg/deploy/registry/deploy/rest.go +++ b/pkg/deploy/registry/deploy/rest.go @@ -21,13 +21,14 @@ type REST struct { registry Registry } +// NewREST creates a new REST backed by the given registry. func NewREST(registry Registry) apiserver.RESTStorage { return &REST{ registry: registry, } } -// New creates a new Deployment for use with Create and Update +// New creates a new Deployment for use with Create and Update. func (s *REST) New() runtime.Object { return &deployapi.Deployment{} } diff --git a/pkg/deploy/registry/deployconfig/doc.go b/pkg/deploy/registry/deployconfig/doc.go new file mode 100644 index 000000000000..e9680f78c9d9 --- /dev/null +++ b/pkg/deploy/registry/deployconfig/doc.go @@ -0,0 +1,3 @@ +// Package deployconfig provides Registry interface and its RESTStorage +// implementation for storing DeploymentConfig api objects. +package deployconfig diff --git a/pkg/deploy/registry/deployconfig/registry.go b/pkg/deploy/registry/deployconfig/registry.go index af6caa5745c4..3d32a6cc9b07 100644 --- a/pkg/deploy/registry/deployconfig/registry.go +++ b/pkg/deploy/registry/deployconfig/registry.go @@ -6,7 +6,7 @@ import ( api "github.com/openshift/origin/pkg/deploy/api" ) -// Registry is an interface for things that know how to store DeploymentConfigs +// Registry is an interface for things that know how to store DeploymentConfigs. type Registry interface { ListDeploymentConfigs(selector labels.Selector) (*api.DeploymentConfigList, error) WatchDeploymentConfigs(resourceVersion uint64, filter func(repo *api.DeploymentConfig) bool) (watch.Interface, error) diff --git a/pkg/deploy/registry/deployconfig/rest.go b/pkg/deploy/registry/deployconfig/rest.go index 2c82c7d7ac2c..8dcd14f09d68 100644 --- a/pkg/deploy/registry/deployconfig/rest.go +++ b/pkg/deploy/registry/deployconfig/rest.go @@ -17,13 +17,14 @@ type REST struct { registry Registry } +// NewREST creates a new REST backed by the given registry. func NewREST(registry Registry) apiserver.RESTStorage { return &REST{ registry: registry, } } -// New creates a new DeploymentConfig for use with Create and Update +// New creates a new DeploymentConfig for use with Create and Update. func (s *REST) New() runtime.Object { return &deployapi.DeploymentConfig{} } diff --git a/pkg/deploy/registry/etcd/doc.go b/pkg/deploy/registry/etcd/doc.go new file mode 100644 index 000000000000..f846abfad9dd --- /dev/null +++ b/pkg/deploy/registry/etcd/doc.go @@ -0,0 +1,3 @@ +// Package etcd provides etcd backend implementation for storing +// Deployment and DeploymentConfig objects +package etcd