firestartr-config
This module has been generated via dagger init and serves as a reference tobasic module structure as you get started with Dagger.
Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.
The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.
Installation
dagger install github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925bEntrypoint
Return Type
FirestartrConfig !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| dotFirestartr | Directory ! | - | The path to the values directory, where the helm values are stored |
Example
dagger -m github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925b call \
--dot-firestartr DIR_PATHfunc (m *MyModule) Example(dotFirestartr *dagger.Directory) *dagger.FirestartrConfig {
return dag.
FirestartrConfig(dotFirestartr)
}@function
def example(dot_firestartr: dagger.Directory) -> dagger.FirestartrConfig:
return (
dag.firestartr_config(dot_firestartr)
)@func()
example(dotFirestartr: Directory): FirestartrConfig {
return dag
.firestartrConfig(dotFirestartr)
}Types
FirestartrConfig 🔗
apps() 🔗
Return Type
[FirestartrConfigFirestartrApp ! ] ! Example
dagger -m github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925b call \
--dot-firestartr DIR_PATH appsfunc (m *MyModule) Example(dotFirestartr *dagger.Directory) []*dagger.FirestartrConfigFirestartrApp {
return dag.
FirestartrConfig(dotFirestartr).
Apps()
}@function
def example(dot_firestartr: dagger.Directory) -> List[dagger.FirestartrConfigFirestartrApp]:
return (
dag.firestartr_config(dot_firestartr)
.apps()
)@func()
example(dotFirestartr: Directory): FirestartrConfigFirestartrApp[] {
return dag
.firestartrConfig(dotFirestartr)
.apps()
}registries() 🔗
Return Type
[FirestartrConfigRegistry ! ] ! Example
dagger -m github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925b call \
--dot-firestartr DIR_PATH registriesfunc (m *MyModule) Example(dotFirestartr *dagger.Directory) []*dagger.FirestartrConfigRegistry {
return dag.
FirestartrConfig(dotFirestartr).
Registries()
}@function
def example(dot_firestartr: dagger.Directory) -> List[dagger.FirestartrConfigRegistry]:
return (
dag.firestartr_config(dot_firestartr)
.registries()
)@func()
example(dotFirestartr: Directory): FirestartrConfigRegistry[] {
return dag
.firestartrConfig(dotFirestartr)
.registries()
}platforms() 🔗
Return Type
[FirestartrConfigPlatform ! ] ! Example
dagger -m github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925b call \
--dot-firestartr DIR_PATH platformsfunc (m *MyModule) Example(dotFirestartr *dagger.Directory) []*dagger.FirestartrConfigPlatform {
return dag.
FirestartrConfig(dotFirestartr).
Platforms()
}@function
def example(dot_firestartr: dagger.Directory) -> List[dagger.FirestartrConfigPlatform]:
return (
dag.firestartr_config(dot_firestartr)
.platforms()
)@func()
example(dotFirestartr: Directory): FirestartrConfigPlatform[] {
return dag
.firestartrConfig(dotFirestartr)
.platforms()
}dotFirestartrDir() 🔗
Return Type
Directory ! Example
dagger -m github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925b call \
--dot-firestartr DIR_PATH dot-firestartr-dirfunc (m *MyModule) Example(dotFirestartr *dagger.Directory) *dagger.Directory {
return dag.
FirestartrConfig(dotFirestartr).
DotFirestartrDir()
}@function
def example(dot_firestartr: dagger.Directory) -> dagger.Directory:
return (
dag.firestartr_config(dot_firestartr)
.dot_firestartr_dir()
)@func()
example(dotFirestartr: Directory): Directory {
return dag
.firestartrConfig(dotFirestartr)
.dotFirestartrDir()
}findPlatformByName() 🔗
Return Type
FirestartrConfigPlatform !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| name | String ! | - | No description provided |
Example
dagger -m github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925b call \
--dot-firestartr DIR_PATH find-platform-by-name --name stringfunc (m *MyModule) Example(dotFirestartr *dagger.Directory, name string) *dagger.FirestartrConfigPlatform {
return dag.
FirestartrConfig(dotFirestartr).
FindPlatformByName(name)
}@function
def example(dot_firestartr: dagger.Directory, name: str) -> dagger.FirestartrConfigPlatform:
return (
dag.firestartr_config(dot_firestartr)
.find_platform_by_name(name)
)@func()
example(dotFirestartr: Directory, name: string): FirestartrConfigPlatform {
return dag
.firestartrConfig(dotFirestartr)
.findPlatformByName(name)
}FirestartrConfigPlatform 🔗
platformType() 🔗
Cannot use
Typeas a field name, it seems to be a reserved keyword for Dagger.io
Return Type
String ! Example
dagger -m github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925b call \
find-platform-by-name --name string \
platform-typefunc (m *MyModule) Example(ctx context.Context, name string) string {
return dag.
FirestartrConfig().
FindPlatformByName(name).
PlatformType(ctx)
}@function
async def example(name: str) -> str:
return await (
dag.firestartr_config()
.find_platform_by_name(name)
.platform_type()
)@func()
async example(name: string): Promise<string> {
return dag
.firestartrConfig()
.findPlatformByName(name)
.platformType()
}name() 🔗
Return Type
String ! Example
dagger -m github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925b call \
find-platform-by-name --name string \
namefunc (m *MyModule) Example(ctx context.Context, name string) string {
return dag.
FirestartrConfig().
FindPlatformByName(name).
Name(ctx)
}@function
async def example(name: str) -> str:
return await (
dag.firestartr_config()
.find_platform_by_name(name)
.name()
)@func()
async example(name: string): Promise<string> {
return dag
.firestartrConfig()
.findPlatformByName(name)
.name()
}tenants() 🔗
Return Type
[String ! ] ! Example
dagger -m github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925b call \
find-platform-by-name --name string \
tenantsfunc (m *MyModule) Example(ctx context.Context, name string) []string {
return dag.
FirestartrConfig().
FindPlatformByName(name).
Tenants(ctx)
}@function
async def example(name: str) -> List[str]:
return await (
dag.firestartr_config()
.find_platform_by_name(name)
.tenants()
)@func()
async example(name: string): Promise<string[]> {
return dag
.firestartrConfig()
.findPlatformByName(name)
.tenants()
}envs() 🔗
Return Type
[String ! ] ! Example
dagger -m github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925b call \
find-platform-by-name --name string \
envsfunc (m *MyModule) Example(ctx context.Context, name string) []string {
return dag.
FirestartrConfig().
FindPlatformByName(name).
Envs(ctx)
}@function
async def example(name: str) -> List[str]:
return await (
dag.firestartr_config()
.find_platform_by_name(name)
.envs()
)@func()
async example(name: string): Promise<string[]> {
return dag
.firestartrConfig()
.findPlatformByName(name)
.envs()
}allowedClaims() 🔗
Return Type
[FirestartrConfigAllowedClaim ! ] ! Example
dagger -m github.com/prefapp/daggerverse/firestartr-config@960698c7fff8e3fdce5d6334350b440882f1925b call \
find-platform-by-name --name string \
allowed-claimsfunc (m *MyModule) Example(name string) []*dagger.FirestartrConfigAllowedClaim {
return dag.
FirestartrConfig().
FindPlatformByName(name).
AllowedClaims()
}@function
def example(name: str) -> List[dagger.FirestartrConfigAllowedClaim]:
return (
dag.firestartr_config()
.find_platform_by_name(name)
.allowed_claims()
)@func()
example(name: string): FirestartrConfigAllowedClaim[] {
return dag
.firestartrConfig()
.findPlatformByName(name)
.allowedClaims()
}FirestartrConfigFirestartrApp 🔗
name() 🔗
Return Type
String ! Example
Function FirestartrConfigFirestartrApp.name is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrApp.name is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrApp.name is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrApp.name is not accessible from the firestartr-config modulestateRepo() 🔗
Return Type
String ! Example
Function FirestartrConfigFirestartrApp.stateRepo is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrApp.stateRepo is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrApp.stateRepo is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrApp.stateRepo is not accessible from the firestartr-config moduleservices() 🔗
Return Type
[FirestartrConfigFirestartrService ! ] ! Example
Function FirestartrConfigFirestartrApp.services is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrApp.services is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrApp.services is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrApp.services is not accessible from the firestartr-config moduleFirestartrConfigRegistry 🔗
name() 🔗
Return Type
String ! Example
Function FirestartrConfigRegistry.name is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.name is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.name is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.name is not accessible from the firestartr-config moduleregistry() 🔗
Return Type
String ! Example
Function FirestartrConfigRegistry.registry is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.registry is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.registry is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.registry is not accessible from the firestartr-config moduleimageTypes() 🔗
Return Type
[String ! ] ! Example
Function FirestartrConfigRegistry.imageTypes is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.imageTypes is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.imageTypes is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.imageTypes is not accessible from the firestartr-config moduleisDefault() 🔗
Return Type
Boolean ! Example
Function FirestartrConfigRegistry.isDefault is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.isDefault is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.isDefault is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.isDefault is not accessible from the firestartr-config moduleauthStrategy() 🔗
Return Type
String ! Example
Function FirestartrConfigRegistry.authStrategy is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.authStrategy is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.authStrategy is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.authStrategy is not accessible from the firestartr-config modulebasePaths() 🔗
Return Type
FirestartrConfigBasePaths ! Example
Function FirestartrConfigRegistry.basePaths is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.basePaths is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.basePaths is not accessible from the firestartr-config moduleFunction FirestartrConfigRegistry.basePaths is not accessible from the firestartr-config moduleFirestartrConfigAllowedClaim 🔗
resourceTypes() 🔗
Return Type
[String ! ] ! Example
Function FirestartrConfigAllowedClaim.resourceTypes is not accessible from the firestartr-config moduleFunction FirestartrConfigAllowedClaim.resourceTypes is not accessible from the firestartr-config moduleFunction FirestartrConfigAllowedClaim.resourceTypes is not accessible from the firestartr-config moduleFunction FirestartrConfigAllowedClaim.resourceTypes is not accessible from the firestartr-config moduleproviders() 🔗
Return Type
[String ! ] ! Example
Function FirestartrConfigAllowedClaim.providers is not accessible from the firestartr-config moduleFunction FirestartrConfigAllowedClaim.providers is not accessible from the firestartr-config moduleFunction FirestartrConfigAllowedClaim.providers is not accessible from the firestartr-config moduleFunction FirestartrConfigAllowedClaim.providers is not accessible from the firestartr-config modulebackend() 🔗
Return Type
String ! Example
Function FirestartrConfigAllowedClaim.backend is not accessible from the firestartr-config moduleFunction FirestartrConfigAllowedClaim.backend is not accessible from the firestartr-config moduleFunction FirestartrConfigAllowedClaim.backend is not accessible from the firestartr-config moduleFunction FirestartrConfigAllowedClaim.backend is not accessible from the firestartr-config moduleFirestartrConfigFirestartrService 🔗
repo() 🔗
Return Type
String ! Example
Function FirestartrConfigFirestartrService.repo is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrService.repo is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrService.repo is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrService.repo is not accessible from the firestartr-config moduleserviceNames() 🔗
Return Type
[String ! ] ! Example
Function FirestartrConfigFirestartrService.serviceNames is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrService.serviceNames is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrService.serviceNames is not accessible from the firestartr-config moduleFunction FirestartrConfigFirestartrService.serviceNames is not accessible from the firestartr-config moduleFirestartrConfigBasePaths 🔗
services() 🔗
Return Type
String ! Example
Function FirestartrConfigBasePaths.services is not accessible from the firestartr-config moduleFunction FirestartrConfigBasePaths.services is not accessible from the firestartr-config moduleFunction FirestartrConfigBasePaths.services is not accessible from the firestartr-config moduleFunction FirestartrConfigBasePaths.services is not accessible from the firestartr-config modulecharts() 🔗
Return Type
String ! Example
Function FirestartrConfigBasePaths.charts is not accessible from the firestartr-config moduleFunction FirestartrConfigBasePaths.charts is not accessible from the firestartr-config moduleFunction FirestartrConfigBasePaths.charts is not accessible from the firestartr-config moduleFunction FirestartrConfigBasePaths.charts is not accessible from the firestartr-config module