From 53f16521a7af529d0ae590d03b2d9d39342b97ef Mon Sep 17 00:00:00 2001 From: Ryan McKinley Date: Wed, 3 Jul 2024 14:45:25 -0700 Subject: [PATCH] add doc.go --- pkg/storage/unified/apistore/doc.go | 5 +++++ pkg/storage/unified/entitybridge/doc.go | 5 +++++ pkg/storage/unified/resource/doc.go | 2 ++ 3 files changed, 12 insertions(+) create mode 100644 pkg/storage/unified/apistore/doc.go create mode 100644 pkg/storage/unified/entitybridge/doc.go create mode 100644 pkg/storage/unified/resource/doc.go diff --git a/pkg/storage/unified/apistore/doc.go b/pkg/storage/unified/apistore/doc.go new file mode 100644 index 00000000000..5fb2f8ac31f --- /dev/null +++ b/pkg/storage/unified/apistore/doc.go @@ -0,0 +1,5 @@ +// Package apistore provides a kubernetes store.Interface for a ResourceServer +// +// This package is responsible for running all the apiserver specific logic +// before and after sending requests to the StorageServer +package apistore diff --git a/pkg/storage/unified/entitybridge/doc.go b/pkg/storage/unified/entitybridge/doc.go new file mode 100644 index 00000000000..aed47e41441 --- /dev/null +++ b/pkg/storage/unified/entitybridge/doc.go @@ -0,0 +1,5 @@ +// Package entitybridge implements an ResourceServer using existing EntityAPI contracts +// +// This package will be removed and replaced with a more streamlined SQL implementation +// that leverages what we have learned from the entity deployments so far +package entitybridge diff --git a/pkg/storage/unified/resource/doc.go b/pkg/storage/unified/resource/doc.go new file mode 100644 index 00000000000..9c186ed6c46 --- /dev/null +++ b/pkg/storage/unified/resource/doc.go @@ -0,0 +1,2 @@ +// Package resource creates a ResourceServer that handles generic storage operations +package resource