Skip to main content

Module engine

Module engine 

Source
Expand description

Setup engine — orchestrates plan building and execution for create/update/remove workflows.

This is the main entry point that consumers (e.g. greentic-operator) use to drive bundle setup.

Structs§

LoadedAnswers
Loaded answers from a JSON/YAML file.
SetupConfig
Configuration for the setup engine.
SetupEngine
The setup engine orchestrates plan → execute for bundle lifecycle.
SetupRequest
The request object that drives plan building.

Functions§

apply_create
Build a plan for create mode.
apply_remove
Build a plan for remove mode.
apply_update
Build a plan for update mode.
auto_install_provider_packs
Search sibling bundles for provider packs referenced in setup_answers and install them into this bundle if missing.
build_metadata
Build metadata for a plan.
build_metadata_with_ops
Build metadata with explicit update operations.
compute_simple_hash
Compute a simple hash for a string (used for digest placeholders).
dedup_sorted
Deduplicate and sort a list of strings.
domain_from_provider_id
Extract domain from a provider ID (e.g. “messaging-telegram” → “messaging”).
emit_answers
Emit an answers template JSON file.
encrypt_secret_answers
Encrypt secret values in the answers document.
execute_add_packs_to_bundle
Execute the AddPacksToBundle step.
execute_apply_pack_setup
Execute the ApplyPackSetup step.
execute_build_flow_index
Execute the BuildFlowIndex step.
execute_copy_resolved_manifests
Execute the CopyResolvedManifest step.
execute_create_bundle
Execute the CreateBundle step.
execute_remove_provider_artifacts
Remove provider artifacts and config directories.
execute_resolve_packs
Execute the ResolvePacks step.
execute_validate_bundle
Execute the ValidateBundle step.
execute_write_gmap_rules
Execute the WriteGmapRules step.
extract_default_from_help
Extract default value from help text.
find_provider_pack_source
Search known locations for a provider pack file.
get_pack_target_dir
Determine the target directory for a pack based on its ID.
infer_default_value
Infer a default value for a setup question.
infer_update_ops
Infer update operations from request content.
load_answers
Load answers from a JSON/YAML file.
normalize_tenants
Normalize tenant selections (sort and deduplicate allow_paths).
print_plan_summary
Print a human-readable plan summary.
prompt_secret_answers
Prompt user to fill in secret values interactively.