Skip to main content

Module plan

Module plan 

Source
Expand description

Setup plan types — mode, steps, and metadata for bundle lifecycle operations.

Structs§

AccessChangeSelection
Access rule change selection.
PackDefaultSelection
Selection for setting a pack as default.
PackListing
Pack catalog listing entry.
PackRemoveSelection
Selection for removing a pack.
QaQuestion
A question in the wizard QA spec.
QaSpec
QA spec returned by the wizard mode query.
ResolvedPackInfo
Resolved pack information after fetching from a registry.
SetupExecutionReport
Report from executing a setup plan.
SetupPlan
A complete setup plan with ordered steps and metadata.
SetupPlanMetadata
Metadata carried alongside the plan for execution.
SetupStep
A single step in the setup plan.
TenantSelection
Tenant + optional team + allow-list paths.

Enums§

AccessOperation
Access rule change operation.
PackScope
Pack scope for default assignments and removal.
RemoveTarget
Remove targets for a remove plan.
SetupMode
The operation mode for a setup plan.
SetupStepKind
The kind of operation a setup step performs.
UpdateOp
Update operations that can be combined in an update plan.

Functions§

load_catalog_from_file
Load a pack catalog from a JSON/YAML file.
spec
Return the QA spec (questions) for a given setup mode.
step
Build a step with a kind, description, and key-value details.