Stack
laktory.models.Stack
¤
Bases: BaseModel
The Stack defines a collection of deployable resources, the deployment configuration, some variables and the environment-specific settings.
ATTRIBUTE | DESCRIPTION |
---|---|
backend |
IaC backend used for deployment.
TYPE:
|
description |
Description of the stack
TYPE:
|
environments |
Environment-specific overwrite of config, resources or variables arguments.
TYPE:
|
name |
Name of the stack. If Pulumi is used as a backend, it should match the name of the Pulumi project.
TYPE:
|
organization |
Organization |
pulumi |
Pulumi-specific settings
TYPE:
|
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:
|
terraform |
Terraform-specific settings
TYPE:
|
variables |
Dictionary of variables made available in the resources definition. |
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_dltpipelines": {
"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",
"clusters": [
{
"name": "main",
"spark_version": "14.0.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,
}
},
},
)
print(stack)
'''
variables={'org': 'okube'} backend='pulumi' description=None environments={'dev': EnvironmentSettings(variables={'is_dev': True}, resources=None), 'prod': EnvironmentSettings(variables={'is_dev': False}, resources=None)} name='workspace' organization=None pulumi=Pulumi(variables={}, config={'databricks:host': '${vars.DATABRICKS_HOST}', 'databricks:token': '${vars.DATABRICKS_TOKEN}'}, outputs={}) resources=StackResources(variables={}, databricks_dashboards={}, databricks_dbfsfiles={}, databricks_catalogs={}, databricks_clusters={}, databricks_directories={}, databricks_externallocations={}, databricks_groups={}, databricks_jobs={'job-stock-prices': Job(resource_name_='job-stock-prices', options=ResourceOptions(variables={}, depends_on=[], provider=None, ignore_changes=None, aliases=None, delete_before_replace=True, import_=None, parent=None, replace_on_changes=None), lookup_existing=None, variables={}, access_controls=[], clusters=[JobCluster(resource_name_=None, options=ResourceOptions(variables={}, depends_on=[], provider=None, ignore_changes=None, aliases=None, delete_before_replace=True, import_=None, parent=None, replace_on_changes=None), lookup_existing=None, variables={}, access_controls=None, apply_policy_default_values=None, autoscale=None, autotermination_minutes=None, cluster_id=None, custom_tags=None, data_security_mode='USER_ISOLATION', driver_instance_pool_id=None, driver_node_type_id=None, enable_elastic_disk=None, enable_local_disk_encryption=None, idempotency_token=None, init_scripts=[], instance_pool_id=None, is_pinned=None, libraries=None, name='main', node_type_id='Standard_DS3_v2', num_workers=None, policy_id=None, runtime_engine=None, single_user_name=None, spark_conf={}, spark_env_vars={}, spark_version='14.0.x-scala2.12', ssh_public_keys=[])], continuous=None, control_run_state=None, email_notifications=None, format=None, health=None, max_concurrent_runs=None, max_retries=None, min_retry_interval_millis=None, name='job-stock-prices', notification_settings=None, parameters=[], retry_on_timeout=None, run_as=None, schedule=None, tags={}, tasks=[JobTask(variables={}, condition_task=None, depends_ons=None, description=None, email_notifications=None, existing_cluster_id=None, health=None, job_cluster_key='main', libraries=None, max_retries=None, min_retry_interval_millis=None, notebook_task=JobTaskNotebookTask(variables={}, notebook_path='/.laktory/jobs/ingest_stock_prices.py', base_parameters=None, source=None), notification_settings=None, pipeline_task=None, retry_on_timeout=None, run_if=None, run_job_task=None, sql_task=None, task_key='ingest', timeout_seconds=None), JobTask(variables={}, condition_task=None, depends_ons=[JobTaskDependsOn(variables={}, task_key='ingest', outcome=None)], description=None, email_notifications=None, existing_cluster_id=None, health=None, job_cluster_key=None, libraries=None, max_retries=None, min_retry_interval_millis=None, notebook_task=None, notification_settings=None, pipeline_task=JobTaskPipelineTask(variables={}, pipeline_id='${resources.dlt-pl-stock-prices.id}', full_refresh=None), retry_on_timeout=None, run_if=None, run_job_task=None, sql_task=None, task_key='pipeline', timeout_seconds=None)], timeout_seconds=None, trigger=None, webhook_notifications=None)}, databricks_metastoredataaccesses={}, databricks_metastores={}, databricks_networkconnectivityconfig={}, databricks_notebooks={}, databricks_dltpipelines={'pl-stock-prices': DLTPipeline(resource_name_='pl-stock-prices', options=ResourceOptions(variables={}, depends_on=[], provider=None, ignore_changes=None, aliases=None, delete_before_replace=True, import_=None, parent=None, replace_on_changes=None), lookup_existing=None, variables={}, access_controls=[], allow_duplicate_names=None, catalog=None, channel='PREVIEW', clusters=[], configuration={}, continuous=None, development='${vars.is_dev}', edition=None, libraries=[PipelineLibrary(variables={}, file=None, notebook=PipelineLibraryNotebook(variables={}, path='/pipelines/dlt_brz_template.py'))], name='pl-stock-prices', notifications=[], photon=None, serverless=None, storage=None, target=None)}, databricks_schemas={}, databricks_secrets={}, databricks_secretscopes={}, databricks_serviceprincipals={}, databricks_sqlqueries={}, databricks_tables={}, databricks_users={}, databricks_volumes={}, databricks_vectorsearchendpoints={}, databricks_vectorsearchindexes={}, databricks_warehouses={}, databricks_workspacefiles={}, pipelines={}, providers={}) terraform=Terraform(variables={}, backend=None)
'''
Functions¤
get_env
¤
get_env(env_name, inject_vars=True)
Complete definition the stack for a given environment. It takes into account both the default stack values and environment-specific overwrites.
PARAMETER | DESCRIPTION |
---|---|
env_name |
Name of the environment
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
EnvironmentStack
|
Environment definitions. |
Source code in laktory/models/stacks/stack.py
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 |
|
to_pulumi
¤
to_pulumi(env_name=None)
Create a pulumi stack for a given environment env
.
PARAMETER | DESCRIPTION |
---|---|
env_name |
Target environment. If |
RETURNS | DESCRIPTION |
---|---|
PulumiStack
|
Pulumi-specific stack definition |
Source code in laktory/models/stacks/stack.py
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 |
|
to_terraform
¤
to_terraform(env_name=None)
Create a terraform stack for a given environment env
.
PARAMETER | DESCRIPTION |
---|---|
env_name |
Target environment. If |
RETURNS | DESCRIPTION |
---|---|
TerraformStack
|
Terraform-specific stack definition |
Source code in laktory/models/stacks/stack.py
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 |
|
laktory.models.StackResources
¤
Bases: BaseModel
Resources definition for a given stack or stack environment.
ATTRIBUTE | DESCRIPTION |
---|---|
databricks_dbfsfiles |
Databricks DbfsFiles |
databricks_catalogs |
Databricks Catalogs |
databricks_clusters |
Databricks Clusters |
databricks_dashboards |
Databricks Dashboards |
databricks_directories |
Databricks Directories |
databricks_externallocations |
Databricks External Locations
TYPE:
|
databricks_groups |
Databricks Groups |
databricks_jobs |
Databricks Jobs |
databricks_metastores |
Databricks Metastores |
databricks_networkconnectivityconfig |
Databricks Network Connectivity Config |
databricks_notebooks |
Databricks Notebooks |
databricks_dltpipelines |
Databricks DLT Pipelines
TYPE:
|
databricks_schemas |
Databricks Schemas |
databricks_secretscopes |
Databricks SecretScopes
TYPE:
|
databricks_serviceprincipals |
Databricks ServicePrincipals
TYPE:
|
databricks_sqlqueries |
Databricks SQLQueries |
databricks_tables |
Databricks Tables |
providers |
Providers
TYPE:
|
databricks_users |
Databricks Users |
databricks_vectorsearchendpoint |
Databricks Vector Search Endpoint
|
databricks_vectorsearchindex |
Databricks Vector Search Index
|
databricks_volumes |
Databricks Volumes |
databricks_warehouses |
Databricks Warehouses |
databricks_workspacefiles |
Databricks WorkspacFiles
TYPE:
|
pipelines |
Laktory Pipelines |
laktory.models.stacks.stack.EnvironmentSettings
¤
Bases: BaseModel
Settings overwrite for a specific environments
ATTRIBUTE | DESCRIPTION |
---|---|
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:
|
variables |
Dictionary of variables made available in the resources definition. |
laktory.models.stacks.stack.EnvironmentStack
¤
Bases: BaseModel
Environment-specific stack definition.
ATTRIBUTE | DESCRIPTION |
---|---|
backend |
IaC backend used for deployment.
TYPE:
|
description |
Description of the stack
TYPE:
|
name |
Name of the stack. If Pulumi is used as a backend, it should match the name of the Pulumi project.
TYPE:
|
organization |
Organization
TYPE:
|
pulumi |
Pulumi-specific settings
TYPE:
|
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:
|
terraform |
Terraform-specific settings
TYPE:
|
variables |
Dictionary of variables made available in the resources definition. |
laktory.models.stacks.stack.Pulumi
¤
Bases: BaseModel
config: Pulumi configuration settings. Generally used to configure providers. See references for more details. outputs: Requested resources-related outputs. See references for details.
References
- Pulumi configuration
- Pulumi outputs