diff --git a/pkg/api/errors/doc.go b/pkg/api/errors/doc.go new file mode 100644 index 00000000000..f9697e349bf --- /dev/null +++ b/pkg/api/errors/doc.go @@ -0,0 +1,18 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package errors provides detailed error types for api field validation. +package errors diff --git a/pkg/cloudprovider/fake/doc.go b/pkg/cloudprovider/fake/doc.go new file mode 100644 index 00000000000..5b048a7deeb --- /dev/null +++ b/pkg/cloudprovider/fake/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package fake_cloud is a test-double implementation of cloudprovider +// Interface, TCPLoadBalancer and Instances. It is useful for testing. +package fake_cloud diff --git a/pkg/cloudprovider/gce/doc.go b/pkg/cloudprovider/gce/doc.go new file mode 100644 index 00000000000..b9c524602e8 --- /dev/null +++ b/pkg/cloudprovider/gce/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package gce_cloud is an implementation of Interface, TCPLoadBalancer +// and Instances for Google Compute Engine. +package gce_cloud diff --git a/pkg/cloudprovider/vagrant/doc.go b/pkg/cloudprovider/vagrant/doc.go new file mode 100644 index 00000000000..a5116eea707 --- /dev/null +++ b/pkg/cloudprovider/vagrant/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package vagrant_cloud is an implementation of Interface, TCPLoadBalancer +// and Instances for developer managed Vagrant cluster. +package vagrant_cloud diff --git a/pkg/kubelet/config/doc.go b/pkg/kubelet/config/doc.go new file mode 100644 index 00000000000..b87406154fb --- /dev/null +++ b/pkg/kubelet/config/doc.go @@ -0,0 +1,18 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package config implements the pod configuration readers. +package config diff --git a/pkg/registry/controller/doc.go b/pkg/registry/controller/doc.go new file mode 100644 index 00000000000..a7f831f1014 --- /dev/null +++ b/pkg/registry/controller/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package controller provides Registry interface and it's RESTStorage +// implementation for storing ReplicationController api objects. +package controller diff --git a/pkg/registry/endpoint/doc.go b/pkg/registry/endpoint/doc.go new file mode 100644 index 00000000000..316913e92dc --- /dev/null +++ b/pkg/registry/endpoint/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package endpoint provides Registry interface and it's RESTStorage +// implementation for storing Endpoint api objects. +package endpoint diff --git a/pkg/registry/etcd/doc.go b/pkg/registry/etcd/doc.go new file mode 100644 index 00000000000..79d6f587bce --- /dev/null +++ b/pkg/registry/etcd/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package etcd provides etcd backend implementation for storing +// PodRegistry, ControllerRegistry and ServiceRegistry api objects. +package etcd diff --git a/pkg/registry/minion/doc.go b/pkg/registry/minion/doc.go new file mode 100644 index 00000000000..b821ced0b48 --- /dev/null +++ b/pkg/registry/minion/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package minion provides Registry interface and implementation +// for storing Minions. +package minion diff --git a/pkg/registry/pod/doc.go b/pkg/registry/pod/doc.go new file mode 100644 index 00000000000..44b244de976 --- /dev/null +++ b/pkg/registry/pod/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package pod provides Registry interface and it's RESTStorage +// implementation for storing Pod api objects. +package pod diff --git a/pkg/registry/registrytest/doc.go b/pkg/registry/registrytest/doc.go new file mode 100644 index 00000000000..a5dc9321bf6 --- /dev/null +++ b/pkg/registry/registrytest/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package registrytest provides tests for Registry implementations +// for storing Minions, Pods, Schedulers and Services. +package registrytest diff --git a/pkg/registry/service/doc.go b/pkg/registry/service/doc.go new file mode 100644 index 00000000000..bd503f2b0e1 --- /dev/null +++ b/pkg/registry/service/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package service provides Registry interface and it's RESTStorage +// implementation for storing Service api objects. +package service diff --git a/pkg/service/doc.go b/pkg/service/doc.go new file mode 100644 index 00000000000..72faf1ea8d7 --- /dev/null +++ b/pkg/service/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2014 Google Inc. All rights reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package service provides EndpointController implementation +// to manage and sync service endpoints. +package service