BlueprintsAdministrators

Configuration reference

Configuration keys of the blueprints module: sections, environment variables, types and defaults.

Generated from the module's code when its image was built — do not edit. Each key can be set as an environment variable on the module's deployment in namespace stackship-system; a double underscore separates the levels. An environment variable overrides the module's shipped appsettings. Values that could be credentials are not shown.

`Auth`

Bound to StackshipAuthOptions.

Key	Environment variable	Type	Default
`Auth:InternalUrl`	`Auth__InternalUrl`	`string`	`""`
`Auth:Module:Audience`	`Auth__Module__Audience`	`string`
`Auth:Module:ClientId`	`Auth__Module__ClientId`	`string`	`""`
`Auth:Module:ClientSecret`	`Auth__Module__ClientSecret`	`string`	(not shown)
`Auth:Realm`	`Auth__Realm`	`string`	`""`
`Auth:Stackship:Audience`	`Auth__Stackship__Audience`	`string`
`Auth:Stackship:ClientId`	`Auth__Stackship__ClientId`	`string`	`""`
`Auth:Stackship:ClientSecret`	`Auth__Stackship__ClientSecret`	`string`	(not shown)
`Auth:Url`	`Auth__Url`	`string`	`""`

`Blueprints:Catalog`

Bound to BlueprintCatalogOptions.

Key	Environment variable	Type	Default
`Blueprints:Catalog:CloneTimeoutSeconds`	`Blueprints__Catalog__CloneTimeoutSeconds`	`integer`	`120`
`Blueprints:Catalog:Path`	`Blueprints__Catalog__Path`	`string`	`blueprints`
`Blueprints:Catalog:Ref`	`Blueprints__Catalog__Ref`	`string`	`main`
`Blueprints:Catalog:RefreshIntervalSeconds`	`Blueprints__Catalog__RefreshIntervalSeconds`	`integer`	`3600`
`Blueprints:Catalog:RepositoryUrl`	`Blueprints__Catalog__RepositoryUrl`	`string`	`""`
`Blueprints:Catalog:WorkingDirectory`	`Blueprints__Catalog__WorkingDirectory`	`string`	`/tmp/blueprint-catalog`

`Stackship`

Bound to StackshipModuleOptions.

Key	Environment variable	Type	Default
`Stackship:AutoUnregisterOnShutdown`	`Stackship__AutoUnregisterOnShutdown`	`boolean`	`true`
`Stackship:BackendBaseUrl`	`Stackship__BackendBaseUrl`	`string`	`""`
`Stackship:BaseUrl`	`Stackship__BaseUrl`	`string`	`""`
`Stackship:CustomResourceDefinitions:{index}:Group`	`Stackship__CustomResourceDefinitions__{index}__Group`	`string`
`Stackship:CustomResourceDefinitions:{index}:Plural`	`Stackship__CustomResourceDefinitions__{index}__Plural`	`string`
`Stackship:CustomResourceDefinitions:{index}:ReadAction`	`Stackship__CustomResourceDefinitions__{index}__ReadAction`	`string`
`Stackship:CustomResourceDefinitions:{index}:ResourceName`	`Stackship__CustomResourceDefinitions__{index}__ResourceName`	`string`
`Stackship:CustomResourceDefinitions:{index}:StatusSource`	`Stackship__CustomResourceDefinitions__{index}__StatusSource`	`string`
`Stackship:CustomResourceDefinitions:{index}:UserManagedResource`	`Stackship__CustomResourceDefinitions__{index}__UserManagedResource`	`boolean`
`Stackship:CustomResourceDefinitions:{index}:Version`	`Stackship__CustomResourceDefinitions__{index}__Version`	`string`
`Stackship:DisplayName`	`Stackship__DisplayName`	`string`	`""`
`Stackship:HeartbeatInterval`	`Stackship__HeartbeatInterval`	`duration`	`00:00:30`
`Stackship:HeartbeatTimeout`	`Stackship__HeartbeatTimeout`	`duration`
`Stackship:HttpTimeout`	`Stackship__HttpTimeout`	`duration`	`00:00:15`
`Stackship:Key`	`Stackship__Key`	`string`	(not shown)
`Stackship:RegistrationRetryInterval`	`Stackship__RegistrationRetryInterval`	`duration`	`00:00:05`
`Stackship:UseGrpcRegistration`	`Stackship__UseGrpcRegistration`	`boolean`	`false`

`Stackship:Authorization`

Bound to AuthorizationOptions.

Key	Environment variable	Type	Default
`Stackship:Authorization:CacheTtlSeconds`	`Stackship__Authorization__CacheTtlSeconds`	`integer`	`30`
`Stackship:Authorization:RbacEndpoint`	`Stackship__Authorization__RbacEndpoint`	`string`	`""`

Other shipped settings

Keys the module's appsettings sets that no options section above covers.

Key	Environment variable	Shipped value
`BlueprintAuth:ClientId`	`BlueprintAuth__ClientId`	`stackship-ingress-auth`
`BlueprintAuth:CookieDomain`	`BlueprintAuth__CookieDomain`	`""`
`BlueprintAuth:CookieLifetimeMinutes`	`BlueprintAuth__CookieLifetimeMinutes`	`480`
`BlueprintAuth:CookieName`	`BlueprintAuth__CookieName`	`.StackshipBlueprintAuth`
`BlueprintAuth:GatewayHost`	`BlueprintAuth__GatewayHost`	`""`
`BlueprintAuth:InternalAuthUrl`	`BlueprintAuth__InternalAuthUrl`	`""`
`Blueprints:DomainSuffix`	`Blueprints__DomainSuffix`	`stackship.local`
`ConnectionStrings:Postgres`	`ConnectionStrings__Postgres`	(not shown)
`IngressController:CertificateIssuer`	`IngressController__CertificateIssuer`	`letsencrypt-prod`
`IngressController:ClassName`	`IngressController__ClassName`	`nginx`
`IngressController:Type`	`IngressController__Type`	`nginx`