root
/
grafana
mirror of https://github.com/grafana/grafana.git
1
0
Fork 0
Code Issues Actions 73 Packages Projects Releases Wiki Activity

unistore/apistore: improve package docs (#110242) 

Signed-off-by: Maicon Costa <maiconscosta@gmail.com>
This commit is contained in:
maicon 2025-08-27 19:00:05 -03:00 committed by GitHub
parent 7768e507da
commit 12382d7f20
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
pkg/storage/unified/apistore/doc.go
View File

@ -1,5 +1,30 @@
// Package apistore provides a kubernetes store.Interface for a ResourceServer
// Package apistore provides an implementation of [k8s.io/apiserver/pkg/storage.Interface]
// that persists data into a [ResourceServer] (backend for unified storage)
//
// This package is responsible for running all the apiserver specific logic
// before and after sending requests to the StorageServer
//
// [StorageOptions] offers a way to configure the storage for each resource. For example,
// it's possible to set a [DefaultPermissionSetter], that will be used by [Storage.Create]
// to set default permissions for new resources.
//
// The idea is that [Storage] sits between the API Server and the [ResourceServer], with an
// optional DualWriter in front of it.
//
// Find below the simplied flow for a request to the API Server (with a DualWriter enabled) and where
// the [Storage] fits in:
//
// POST /apis/dashboards/v1/namespaces/default/dashboards
// ↓
// API Server
// ↓
// DualWriter
// ↙ ↘
// (this package) apistore.Storage LegacyStorage
// ↓ ↓
// unified.ResourceClient LegacyService (like folder.Service or dashboard.Service)
// ↓ ↓
// StorageServer (unified storage) SQL Storage
//
// [ResourceServer]: https://github.com/grafana/grafana/pkg/storage/unified/resource#ResourceServer
package apistore