Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RenderManifests ¶
Execute a `kargo-render` command and return the response.
Types ¶
type ActionTaken ¶
type ActionTaken string
ActionTaken indicates what action, if any was taken in response to a RenderRequest.
const ( // ActionTakenWroteToLocalPath represents the case where Kargo Render // responded to a RenderRequest by writing the rendered manifests to a local // path. ActionTakenWroteToLocalPath ActionTaken = "WROTE_TO_LOCAL_PATH" )
type Request ¶
type Request struct {
// TargetBranch is the name of an environment-specific branch in the GitOps
// repository referenced by the RepoURL field into which plain YAML should be
// rendered.
TargetBranch string `json:"targetBranch,omitempty"`
// LocalInPath specifies a path to the repository's working tree with the
// desired source commit already checked out.
LocalInPath string `json:"localInPath,omitempty"`
// LocalOutPath specifies a path where the rendered manifests should be
// written. The specified path must NOT exist already.
LocalOutPath string `json:"localOutPath,omitempty"`
// Images specifies images to incorporate into environment-specific
// manifests.
Images []string `json:"images,omitempty"`
// RepoCreds encapsulates read/write credentials for the remote GitOps
// repository referenced by the RepoURL field.
RepoCreds git.RepoCredentials `json:"repoCreds,omitempty"`
}
Request is a request for Kargo Render to render environment-specific manifests from input in the default branch of the repository specified by RepoURL.
type Response ¶
type Response struct {
ActionTaken ActionTaken `json:"actionTaken,omitempty"`
// LocalPath is the path to the directory where the rendered manifests
// were written.
LocalPath string `json:"localPath,omitempty"`
}
Response encapsulates details of a successful rendering of some environment-specific manifests into an environment-specific branch.
Click to show internal directories.
Click to hide internal directories.