hydrate-orchestrator

No long description provided.

Installation

dagger install github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8

Entrypoint

Return Type

HydrateOrchestrator !

Arguments

Name	Type	Default Value	Description
repo	String !	-	Github repository name <owner>/<repo>
ghToken	Secret !	-	GitHub token
app	String !	-	Application name
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

Example

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH

func (m *MyModule) Example(repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory) *dagger.HydrateOrchestrator  {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
}

@function
def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, ) -> dagger.HydrateOrchestrator:
	return (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
	)

@func()
example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, ): HydrateOrchestrator {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
}

Types

HydrateOrchestrator 🔗

repo() 🔗

Return Type

String !

Example

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH repo

func (m *MyModule) Example(ctx context.Context, repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory) string  {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			Repo(ctx)
}

@function
async def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, ) -> str:
	return await (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.repo()
	)

@func()
async example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, ): Promise<string> {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.repo()
}

ghToken() 🔗

Return Type

Secret !

Example

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH gh-token

func (m *MyModule) Example(repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory) *dagger.Secret  {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			GhToken()
}

@function
def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, ) -> dagger.Secret:
	return (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.gh_token()
	)

@func()
example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, ): Secret {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.ghToken()
}

app() 🔗

Return Type

String !

Example

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH app

func (m *MyModule) Example(ctx context.Context, repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory) string  {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			App(ctx)
}

@function
async def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, ) -> str:
	return await (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.app()
	)

@func()
async example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, ): Promise<string> {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.app()
}

valuesStateDir() 🔗

Return Type

Directory !

Example

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH values-state-dir

func (m *MyModule) Example(repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory) *dagger.Directory  {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			ValuesStateDir()
}

@function
def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, ) -> dagger.Directory:
	return (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.values_state_dir()
	)

@func()
example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, ): Directory {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.valuesStateDir()
}

wetStateDir() 🔗

Return Type

Directory !

Example

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH wet-state-dir

func (m *MyModule) Example(repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory) *dagger.Directory  {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			WetStateDir()
}

@function
def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, ) -> dagger.Directory:
	return (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.wet_state_dir()
	)

@func()
example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, ): Directory {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.wetStateDir()
}

authDir() 🔗

Return Type

Directory !

Example

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH auth-dir

func (m *MyModule) Example(repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory) *dagger.Directory  {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			AuthDir()
}

@function
def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, ) -> dagger.Directory:
	return (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.auth_dir()
	)

@func()
example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, ): Directory {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.authDir()
}

deploymentBranch() 🔗

Return Type

String !

Example

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH deployment-branch

func (m *MyModule) Example(ctx context.Context, repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory) string  {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			DeploymentBranch(ctx)
}

@function
async def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, ) -> str:
	return await (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.deployment_branch()
	)

@func()
async example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, ): Promise<string> {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.deploymentBranch()
}

event() 🔗

Return Type

Enum !

Example

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH event

func (m *MyModule) Example(repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory)   {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			Event()
}

@function
def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, ) -> :
	return (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.event()
	)

@func()
example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, ):  {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.event()
}

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

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory, deploymentSummary *dagger.HydrateOrchestratorDeploymentSummary) *dagger.File  {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			DeploymentSummaryToFile(deploymentSummary)
}

@function
def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, deployment_summary: dagger.HydrateOrchestratorDeploymentSummary) -> dagger.File:
	return (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.deployment_summary_to_file(deployment_summary)
	)

@func()
example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, deploymentSummary: HydrateOrchestratorDeploymentSummary): File {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.deploymentSummaryToFile(deploymentSummary)
}

runDispatch() 🔗

Return Type

Void !

Arguments

Name	Type	Default Value	Description
id	Integer !	-	Workflow run id
newImagesMatrix	String	"{\"images\":[]}"	No description provided

Example

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH run-dispatch --id integer

func (m *MyModule) Example(ctx context.Context, repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory, id int)   {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			RunDispatch(ctx, id)
}

@function
async def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, id: int) -> None:
	return await (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.run_dispatch(id)
	)

@func()
async example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, id: number): Promise<void> {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.runDispatch(id)
}

generateDeployment() 🔗

Hydrate deployments based on the updated deployments

Return Type

File !

Arguments

Name	Type	Default Value	Description
id	Integer	0	Identifier that triggered the render, this could be a PR number or a workflow run id
author	String	"author"	Author of the PR
deploymentType	String !	-	Type of deployment
cluster	String !	-	Cluster name
tenant	String !	-	Tenant name
environment	String !	-	Environment name

Example

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH generate-deployment --deployment-type string --cluster string --tenant string --environment string

func (m *MyModule) Example(repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory, deploymentType string, cluster string, tenant string, environment string) *dagger.File  {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			GenerateDeployment(deploymentType, cluster, tenant, environment)
}

@function
def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, deployment_type: str, cluster: str, tenant: str, environment: str) -> dagger.File:
	return (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.generate_deployment(deployment_type, cluster, tenant, environment)
	)

@func()
example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, deploymentType: string, cluster: string, tenant: string, environment: string): File {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.generateDeployment(deploymentType, cluster, tenant, environment)
}

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

dagger -m github.com/prefapp/daggerverse/hydrate-orchestrator@1fd7efbf1d147f1edbb0af835cc2adcedd19edc8 call \
 --repo string --gh-token env:MYSECRET --app string --values-state-dir DIR_PATH --wet-state-dir DIR_PATH --auth-dir DIR_PATH validate-changes --updated-deployments string

func (m *MyModule) Example(ctx context.Context, repo string, ghToken *dagger.Secret, app string, valuesStateDir *dagger.Directory, wetStateDir *dagger.Directory, authDir *dagger.Directory, updatedDeployments string)   {
	return dag.
			HydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir).
			ValidateChanges(ctx, updatedDeployments)
}

@function
async def example(repo: str, gh_token: dagger.Secret, app: str, values_state_dir: dagger.Directory, wet_state_dir: dagger.Directory, auth_dir: dagger.Directory, updated_deployments: str) -> None:
	return await (
		dag.hydrate_orchestrator(repo, gh_token, app, values_state_dir, wet_state_dir, auth_dir)
		.validate_changes(updated_deployments)
	)

@func()
async example(repo: string, ghToken: Secret, app: string, valuesStateDir: Directory, wetStateDir: Directory, authDir: Directory, updatedDeployments: string): Promise<void> {
	return dag
		.hydrateOrchestrator(repo, ghToken, app, valuesStateDir, wetStateDir, authDir)
		.validateChanges(updatedDeployments)
}

HydrateOrchestratorDeploymentSummary 🔗

items() 🔗

Return Type

[HydrateOrchestratorDeploymentSummaryRow ! ] !

Example

Function HydrateOrchestratorDeploymentSummary.items is not accessible from the hydrate-orchestrator module

Function HydrateOrchestratorDeploymentSummary.items is not accessible from the hydrate-orchestrator module

Function HydrateOrchestratorDeploymentSummary.items is not accessible from the hydrate-orchestrator module

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

Function HydrateOrchestratorDeploymentSummary.deploymentSummaryToMarkdownTable is not accessible from the hydrate-orchestrator module

Function HydrateOrchestratorDeploymentSummary.deploymentSummaryToMarkdownTable is not accessible from the hydrate-orchestrator module

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

Function HydrateOrchestratorDeploymentSummaryRow.deploymentPath is not accessible from the hydrate-orchestrator module

Function HydrateOrchestratorDeploymentSummaryRow.deploymentPath is not accessible from the hydrate-orchestrator module

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

Function HydrateOrchestratorDeploymentSummaryRow.status is not accessible from the hydrate-orchestrator module

Function HydrateOrchestratorDeploymentSummaryRow.status is not accessible from the hydrate-orchestrator module

Function HydrateOrchestratorDeploymentSummaryRow.status is not accessible from the hydrate-orchestrator module