Documentation
¶
Overview ¶
Package admin is templates' internal API: the console module's editor, served as gRPC on the platform port behind the internal secret and relayed by backplane under the operator's session. Every change is an audit record.
Index ¶
- Constants
- Variables
- type Admin
- func (a *Admin) ActivateVersion(ctx context.Context, req *templatesconsolev1.ActivateVersionRequest) (*templatesconsolev1.ActivateVersionResponse, error)
- func (a *Admin) DeleteTemplate(ctx context.Context, req *templatesconsolev1.DeleteTemplateRequest) (*templatesconsolev1.DeleteTemplateResponse, error)
- func (a *Admin) GetSettings(_ context.Context, _ *templatesconsolev1.GetSettingsRequest) (*templatesconsolev1.GetSettingsResponse, error)
- func (a *Admin) GetTemplate(ctx context.Context, req *templatesconsolev1.GetTemplateRequest) (*templatesconsolev1.GetTemplateResponse, error)
- func (a *Admin) ListTemplates(ctx context.Context, _ *templatesconsolev1.ListTemplatesRequest) (*templatesconsolev1.ListTemplatesResponse, error)
- func (a *Admin) Preview(ctx context.Context, req *templatesconsolev1.PreviewRequest) (*templatesconsolev1.PreviewResponse, error)
- func (a *Admin) SaveTemplate(ctx context.Context, req *templatesconsolev1.SaveTemplateRequest) (*templatesconsolev1.SaveTemplateResponse, error)
- type FileSet
- type FileTemplate
- type Files
Constants ¶
const FilesAuthor = "files"
FilesAuthor is the author of the versions the files source writes.
Variables ¶
var ErrFiles = errors.New("templates: files source")
ErrFiles: the files source is not a valid set of templates.
Functions ¶
This section is empty.
Types ¶
type Admin ¶
type Admin struct {
templatesconsolev1.UnimplementedAdminServiceServer
deps.Component
// contains filtered or unexported fields
}
Admin serves AdminService.
func (*Admin) ActivateVersion ¶
func (a *Admin) ActivateVersion( ctx context.Context, req *templatesconsolev1.ActivateVersionRequest, ) (*templatesconsolev1.ActivateVersionResponse, error)
ActivateVersion implements AdminService.
func (*Admin) DeleteTemplate ¶
func (a *Admin) DeleteTemplate( ctx context.Context, req *templatesconsolev1.DeleteTemplateRequest, ) (*templatesconsolev1.DeleteTemplateResponse, error)
DeleteTemplate implements AdminService.
func (*Admin) GetSettings ¶ added in v0.2.0
func (a *Admin) GetSettings( _ context.Context, _ *templatesconsolev1.GetSettingsRequest, ) (*templatesconsolev1.GetSettingsResponse, error)
GetSettings implements AdminService.
func (*Admin) GetTemplate ¶
func (a *Admin) GetTemplate( ctx context.Context, req *templatesconsolev1.GetTemplateRequest, ) (*templatesconsolev1.GetTemplateResponse, error)
GetTemplate implements AdminService.
func (*Admin) ListTemplates ¶
func (a *Admin) ListTemplates( ctx context.Context, _ *templatesconsolev1.ListTemplatesRequest, ) (*templatesconsolev1.ListTemplatesResponse, error)
ListTemplates implements AdminService.
func (*Admin) Preview ¶
func (a *Admin) Preview( ctx context.Context, req *templatesconsolev1.PreviewRequest, ) (*templatesconsolev1.PreviewResponse, error)
Preview implements AdminService.
func (*Admin) SaveTemplate ¶
func (a *Admin) SaveTemplate( ctx context.Context, req *templatesconsolev1.SaveTemplateRequest, ) (*templatesconsolev1.SaveTemplateResponse, error)
SaveTemplate implements AdminService.
type FileSet ¶ added in v0.2.7
type FileSet struct {
Templates map[string]FileTemplate
Digest string
}
FileSet is what a directory holds: templates by name, and its digest.
type FileTemplate ¶ added in v0.2.7
FileTemplate is a template as its directory says.
type Files ¶ added in v0.2.7
Files keeps the templates of a directory in force: the directory is the desired state, and the console only reads (and previews) what it holds.
Every subdirectory is one template, named by it:
kratos.recovery_code_valid/ template.yaml # optional: description, default_language, sample en/subject.txt # <language>/<part>.<ext>: .txt a text part, .html an html one en/html.html ru/subject.txt ru/html.html _footer/ en/html.html # a shared piece: its part named as the including part (or its only one)
Names starting with a dot are skipped (a Kubernetes ConfigMap's ..data). A pass saves what differs from a template's active version as a new version and activates it; a template a directory no longer holds is deleted. A template that does not compile keeps the version in force; a directory that does not read whole changes nothing. Replicas run it side by side and converge.