README
¶
nexgate-orchestrator
the orchestrator module, member of GSF-nexgate ZUGFeRD family.
This Go module handles central orchestration within the NexGate ecosystem.
Tasks
- Reading and validating the initial JSON structure (
input). - Transforming the data into the internal
ZugferdMasterformat (invoice). - Generating
RenderJobfiles within thenexgate-envstructure. - Triggering the individual engine workers (Base, PDF, ZUGFeRD).
Installation
go get codeberg.org/tiny-frameworks/nexgate-orchestrator
Use
The module is instantiated via the API and strictly requires the path to the environment root
orch, err := orchestrator.New(envRoot)
Documentation, Contributing & Security
- For the detailed documentation of nexgate-engines, see the main repository nexgate-doc.
- For the complete documentation of the nexgate system, see the main repository nexgate-doc.
- You can find guidelines for bug reports and pull requests in the central Contributing Guidelines.
- Information on reporting security vulnerabilities can be found in our Security Policy.
Documentation
¶
Index ¶
Constants ¶
View Source
const EnvRootKey = "NEXGATE_ENVROOT"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Orchestrator ¶
type Orchestrator struct {
ZugferdMaster *invoice.ZUGFeRDmaster
// contains filtered or unexported fields
}
func New ¶
func New(envRoot string) (*Orchestrator, error)
func NewDefault ¶
func NewDefault() (*Orchestrator, error)
func (*Orchestrator) CreateWriter ¶
func (o *Orchestrator) CreateWriter(provider string, engine string, timeout time.Duration, kind writer.WriterKind) (writer.Writer, error)
Die zentrale Factory-Methode
func (*Orchestrator) RunJsonJob ¶
func (o *Orchestrator) RunJsonJob(json []byte) (renderOutput *writer.RenderOutput, err error)
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.