hydrate-orchestrator
No long description provided.
Installation
dagger install github.com/prefapp/daggerverse/hydrate-orchestrator@2e5b0a2d710099fd792e2cecc2a1ae1d123e611d
Entrypoint
Return Type
HydrateOrchestrator !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
repo | String ! | - | Github repository name <owner>/<repo> |
ghToken | Secret ! | - | GitHub token |
valuesStateDir | Directory ! | - | State values directory (e.g. state-app-<app>#main) |
wetStateDir | Directory ! | - | Wet state directory (e.g. wet-state-app-<app>#<deployment-branch>) |
authDir | Directory | - | Auth directory |
deploymentBranch | String | "deployment" | Deployment branch to hydrate |
event | Enum | "pr" | Event that triggered the workflow |
dotFirestartr | Directory ! | - | .firestartr directory. It contains de org global configurations. |
ghCliVersion | String | "v2.66.1" | Gh CLI Version |
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) *HydrateOrchestrator {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr)
}
Types
HydrateOrchestrator 🔗
repo() 🔗
Return Type
String !
Example
func (m *myModule) example(ctx context.Context, repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) string {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
Repo(ctx)
}
ghToken() 🔗
Return Type
Secret !
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) *Secret {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
GhToken()
}
app() 🔗
Return Type
String !
Example
func (m *myModule) example(ctx context.Context, repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) string {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
App(ctx)
}
valuesStateDir() 🔗
Return Type
Directory !
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) *Directory {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
ValuesStateDir()
}
wetStateDir() 🔗
Return Type
Directory !
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) *Directory {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
WetStateDir()
}
authDir() 🔗
Return Type
Directory !
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) *Directory {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
AuthDir()
}
deploymentBranch() 🔗
Return Type
String !
Example
func (m *myModule) example(ctx context.Context, repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) string {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
DeploymentBranch(ctx)
}
event() 🔗
Return Type
Enum !
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
Event()
}
dotFirestartr() 🔗
Return Type
Directory !
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) *Directory {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
DotFirestartr()
}
ghCliVersion() 🔗
Return Type
String !
Example
func (m *myModule) example(ctx context.Context, repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) string {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
GhCliVersion(ctx)
}
artifactRef() 🔗
Return Type
String !
Example
func (m *myModule) example(ctx context.Context, repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory) string {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
ArtifactRef(ctx)
}
runDispatch() 🔗
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
newImagesMatrix | String | "{\"images\":[]}" | No description provided |
platformType | String ! | "kubernetes" | No description provided |
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory, platformType string) *File {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
RunDispatch(platformType)
}
generateTfWorkspacesDeployments() 🔗
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
newImagesMatrix | String ! | - | No description provided |
repositoryCaller | String ! | - | No description provided |
repoUrl | String ! | - | No description provided |
reviewers | [String ! ] ! | - | No description provided |
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory, newImagesMatrix string, repositoryCaller string, repoUrl string, reviewers []string) *File {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
GenerateTfWorkspacesDeployments(newImagesMatrix, repositoryCaller, repoUrl, reviewers)
}
automergeFileExists() 🔗
Return Type
Boolean !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
globPattern | String ! | - | No description provided |
Example
func (m *myModule) example(ctx context.Context, repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory, globPattern string) bool {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
AutomergeFileExists(ctx, globPattern)
}
mergePullRequest() 🔗
Return Type
Void !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
prLink | String ! | - | No description provided |
Example
func (m *myModule) example(ctx context.Context, repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory, prLink string) {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
MergePullRequest(ctx, prLink)
}
deploymentSummaryToFile() 🔗
Function that creates a dagger.File object from a DeploymentSummary object
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
deploymentSummary | HydrateOrchestratorDeploymentSummary ! | - | No description provided |
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory, deploymentSummary *HydrateOrchestratorDeploymentSummary) *File {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
DeploymentSummaryToFile(deploymentSummary)
}
generateDeployment() 🔗
Hydrate deployments based on the updated deployments
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
author | String | "author" | Author of the PR |
globPattern | String ! | - | Glob Pattern |
artifactRef | String | "" | Aritfact ref. This param could be used to reference the artifact that triggered the deployment It contains the image tag, sha, etc. |
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory, globPattern string) *File {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
GenerateDeployment(globPattern)
}
validateChanges() 🔗
Hydrate deployments based on the updated deployments
Return Type
Void !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
updatedDeployments | String ! | - | Updated deployments in JSON format |
Example
func (m *myModule) example(ctx context.Context, repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory, updatedDeployments string) {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
ValidateChanges(ctx, updatedDeployments)
}
generateKubernetesDeployments() 🔗
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
newImagesMatrix | String ! | - | No description provided |
repositoryCaller | String ! | - | No description provided |
repoUrl | String ! | - | No description provided |
reviewers | [String ! ] ! | - | No description provided |
Example
func (m *myModule) example(repo string, ghToken *Secret, valuesStateDir *Directory, wetStateDir *Directory, dotFirestartr *Directory, newImagesMatrix string, repositoryCaller string, repoUrl string, reviewers []string) *File {
return dag.
HydrateOrchestrator(repo, ghToken, valuesStateDir, wetStateDir, dotFirestartr).
GenerateKubernetesDeployments(newImagesMatrix, repositoryCaller, repoUrl, reviewers)
}
HydrateOrchestratorDeploymentSummary 🔗
items() 🔗
Return Type
[HydrateOrchestratorDeploymentSummaryRow ! ] !
Example
Function HydrateOrchestratorDeploymentSummary.items is not accessible from the hydrate-orchestrator module
deploymentSummaryToMarkdownTable() 🔗
Function that converts a DeploymentSummary object to a markdown table
Return Type
String !
Example
Function HydrateOrchestratorDeploymentSummary.deploymentSummaryToMarkdownTable is not accessible from the hydrate-orchestrator module
HydrateOrchestratorDeploymentSummaryRow 🔗
deploymentPath() 🔗
Deployment path
Return Type
String !
Example
Function HydrateOrchestratorDeploymentSummaryRow.deploymentPath is not accessible from the hydrate-orchestrator module
status() 🔗
Status of the deployment
Return Type
String !
Example
Function HydrateOrchestratorDeploymentSummaryRow.status is not accessible from the hydrate-orchestrator module