Skip to content

Main Navigation Guide Reference API

Appearance

Sidebar Navigation

cli

cli-interfaces

entrypoint

Interfaces

CliEntryPointOptions

Functions

cliEntryPoint

generate

Variables

generateCommand

secret

apply

Variables

secretApplyCommand

secret

Variables

secretCommand

validate

Variables

secretValidateCommand

commands

ConfigLoader

Classes

ConfigLoader

constants

Variables

FRAMEWORK_LABEL

LABELS

generate

GenerateCommand

Classes

GenerateCommand

Interfaces

GenerateCommandOptions

GenerateRunner

Classes

GenerateRunner

Interfaces

RenderedFile

Renderer

Classes

Renderer

Interfaces

RenderedResource

types

Interfaces

ProjectGenerateOptions

MetadataInjector

Classes

MetadataInjector

Interfaces

MetadataInjectorOptions

SecretCommand

Classes

SecretCommand

Interfaces

SecretCommandOptions

config

Functions

defineConfig

domain

ConfigMigrator

Classes

ConfigMigrator

Interfaces

ConfigMigrationResult

IFileSystem

Interfaces

IFileSystem

InMemoryFileSystem

Classes

InMemoryFileSystem

NodeFileSystem

Classes

NodeFileSystem

ResourceFilter

Classes

ResourceFilter

Interfaces

FilterResult

YamlRenderer

Classes

YamlRenderer

Interfaces

ResourceInfo

executor

execa-executor

Classes

ExecaExecutor

kubectl-executor

Classes

KubectlExecutor

index

internal

constant

Variables

MARK_BULLET

MARK_CHECK

MARK_ERROR

MARK_INFO

MARK_NODE

MARK_TREE_BRANCH

MARK_TREE_END

MARK_TREE_LEAF

MARK_TREE_SPACE

MARK_WARNING

error

Functions

handlerError

load-config

Variables

DEFAULT_CONFIG_EXTENSIONS

DEFAULT_CONFIG_NAME

Functions

getConfig

getMatchConfigFile

logger

Classes

ConsoleLogger

SilentLogger

types

Interfaces

GlobalConfigOptions

utils

Interfaces

StackInfo

Type Aliases

Subcommand

Functions

censorSecretPayload

extractKindFromResourceEntry

extractStackInfo

extractStackInfoFromConfig

getClassName

getStackName

validateId

validateString

verboseCliConfig

secret

connectors

InMemoryConnector

Classes

InMemoryConnector

orchestrator

SecretManagerEngine

Classes

SecretManagerEngine

Interfaces

EffectsOptions

MergedSecretManager

Type Aliases

SecretManagerName

StackName

SecretsOrchestrator

Classes

SecretsOrchestrator

types

Interfaces

ConfigConflictOptions

EffectsOptions

SecretsOrchestratorOptions

Type Aliases

ConflictLevel

ConflictStrategy

providers

InMemoryProvider

Classes

InMemoryProvider

Interfaces

InMemoryProviderConfig

merge-utils

Functions

createMergeHandler

SecretInjectionBuilder

Classes

SecretInjectionBuilder

SecretManager

Classes

SecretManager

Interfaces

SecretManagerEffect

SecretOptions

SecretRegistry

Classes

SecretRegistry

SecretsInjectionContext

Classes

SecretsInjectionContext

Type Aliases

ExtractProviderEnvKeys

ExtractProviderStrategies

InferSecretEnvKeys

InferSecretProviderKey

InferSecretStrategies

types

Interfaces

EnvOptions

SecretManagerRegistrationOptions

Type Aliases

AnySecretManager

ExtractSecretManager

ProjectSecretOptions

stack

BaseStack

Classes

BaseStack

Interfaces

UseSecretsOptions

Type Aliases

SecretManagerId

ResourceComposer

Classes

ResourceComposer

Interfaces

ResourceEntry

Stack

Classes

Stack

Type Aliases

ConfigureComposerFunction

Functions

createStack

utils

Type Aliases

ResourceManifest

Functions

buildComposerFromObject

types

Interfaces

KubricateConfig

ProjectMetadataOptions

Type Aliases

AnyClass

AnyFunction

AnyKey

AnyString

FallbackIfNever

FunctionLike

InferConfigureComposerFunc

IsNever

version

Variables

version

On this page

kubricate / config / defineConfig

Function: defineConfig()

ts

function defineConfig(config): KubricateConfig;

Parameters

config

KubricateConfig

Returns

KubricateConfig

Pager

Previous pageconfig

Next pageConfigMigrator

Documentation Distributed under CC BY 4.0