Stack

`laktory.models.stacks.Stack` ¤

Bases: BaseModel

The Stack defines a collection of deployable resources, the deployment configuration, some variables and the environment-specific settings.

Examples:

from laktory import models

stack = models.Stack(
    name="workspace",
    backend="pulumi",
    pulumi={
        "config": {
            "databricks:host": "${vars.DATABRICKS_HOST}",
            "databricks:token": "${vars.DATABRICKS_TOKEN}",
        },
    },
    resources={
        "databricks_pipelines": {
            "pl-stock-prices": {
                "name": "pl-stock-prices",
                "development": "${vars.is_dev}",
                "libraries": [
                    {"notebook": {"path": "/pipelines/dlt_brz_template.py"}},
                ],
            }
        },
        "databricks_jobs": {
            "job-stock-prices": {
                "name": "job-stock-prices",
                "job_clusters": [
                    {
                        "job_cluster_key": "main",
                        "new_cluster": {
                            "spark_version": "16.3.x-scala2.12",
                            "node_type_id": "Standard_DS3_v2",
                        },
                    }
                ],
                "tasks": [
                    {
                        "task_key": "ingest",
                        "job_cluster_key": "main",
                        "notebook_task": {
                            "notebook_path": "/.laktory/jobs/ingest_stock_prices.py",
                        },
                    },
                    {
                        "task_key": "pipeline",
                        "depends_ons": [{"task_key": "ingest"}],
                        "pipeline_task": {
                            "pipeline_id": "${resources.dlt-pl-stock-prices.id}",
                        },
                    },
                ],
            }
        },
    },
    variables={
        "org": "okube",
    },
    environments={
        "dev": {
            "variables": {
                "is_dev": True,
            }
        },
        "prod": {
            "variables": {
                "is_dev": False,
            }
        },
    },
)

References

Stack

PARAMETER	DESCRIPTION
`backend`	IaC backend used for deployment. TYPE: `Literal['pulumi', 'terraform'] \| VariableType` DEFAULT: `None`
`description`	Description of the stack TYPE: `str \| VariableType` DEFAULT: `None`
`environments`	Environment-specific overwrite of config, resources or variables arguments. TYPE: `dict[str \| VariableType, EnvironmentSettings \| VariableType] \| VariableType` DEFAULT: `{}`
`name`	Name of the stack. If Pulumi is used as a backend, it should match the name of the Pulumi project. TYPE: `str \| VariableType`
`organization`	Organization TYPE: `str \| None \| VariableType` DEFAULT: `None`
`pulumi`	Pulumi-specific settings TYPE: `Pulumi \| VariableType` DEFAULT: `Pulumi(variables={}, config={}, outputs={})`
`resources`	Dictionary of resources to be deployed. Each key should be a resource type and each value should be a dictionary of resources who's keys are the resource names and the values the resources definitions. TYPE: `StackResources \| None \| VariableType` DEFAULT: StackResources(variables={}, databricks_accesscontrolrulesets={}, databricks_alerts={}, databricks_apps={}, databricks_catalogs={}, databricks_clusterpolicies={}, databricks_clusters={}, databricks_currentusers={}, databricks_dashboards={}, databricks_dbfsfiles={}, databricks_directories={}, databricks_pipelines={}, databricks_externallocations={}, databricks_grant={}, databricks_grants={}, databricks_groups={}, databricks_jobs={}, databricks_metastoreassignments={}, databricks_metastoredataaccesses={}, databricks_metastores={}, databricks_mlflowexperiments={}, databricks_mlflowmodels={}, databricks_mlflowwebhooks={}, databricks_networkconnectivityconfig={}, databricks_notebooks={}, databricks_notificationdestinations={}, databricks_obotokens={}, databricks_permissions={}, databricks_qualitymonitors={}, databricks_pythonpackages={}, databricks_queries={}, databricks_recipients={}, databricks_repos={}, databricks_schemas={}, databricks_secrets={}, databricks_secretscopes={}, databricks_serviceprincipals={}, databricks_shares={}, databricks_storagecredentials={}, databricks_tables={}, databricks_users={}, databricks_vectorsearchendpoints={}, databricks_vectorsearchindexes={}, databricks_volumes={}, databricks_warehouses={}, databricks_workspacebindings={}, databricks_workspacefiles={}, databricks_workspacetrees={}, pipelines={}, providers={})
`settings`	Laktory settings TYPE: `LaktorySettings \| VariableType` DEFAULT: `None`
`terraform`	Terraform-specific settings TYPE: `Terraform \| VariableType` DEFAULT: `Terraform(variables={}, backend=None)`

METHOD	DESCRIPTION
`apply_settings`	Required to apply settings before instantiating resources and setting default values
`build`	Build stack artifacts before preview or deploy.
`get_env`	Complete definition the stack for a given environment. It takes into
`to_pulumi`	Create a pulumi stack for a given environment `env`.
`to_terraform`	Create a terraform stack for a given environment `env`.