Skip to content

Commit

Permalink
improve docstring of Orchestrator interface
Browse files Browse the repository at this point in the history
  • Loading branch information
Pavlos Tzianos committed May 7, 2024
1 parent a3755b8 commit 5186171
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion pkg/pipelines/orchestrator.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ import (
"github.com/ocurity/dracon/pkg/components"
)

// Orchestrator represents a piece of code
// Orchestrator represents a piece of code that orchestrates the deployment of
// components and pipelines on a backend. The backend could be a cluster with a
// Tekton operator for example, or some other system.
type Orchestrator[P runtime.Object] interface {
// Prepare checks if the expected components are present in the cluster and
// performs any operations to ensure that the workflow can be deployed.
Expand Down

0 comments on commit 5186171

Please sign in to comment.