Feature full Stack deployment lifecycle resources (groups → runs → steps → states → diagnostics) - #191
Merged
Merged
Conversation
…mples. Updated include-opt for stack deployment run models for list/show and Changelog
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add full Stack deployment lifecycle resources (groups → runs → steps → states → diagnostics)
Why this change is needed
The pytfe SDK had no coverage for the operational side of HCP Terraform Stacks. The existing
client.stacksandclient.stack_configurationsresources let you create and read a stack, but nothing let you inspect or drive a deployment once it started — no way to list deployment groups, track individual runs, advance a pending operator step, read the current state, or investigate a diagnostic. This PR fills that gap completely.What was changed
8 new resource services wired into
TFEClient:client.stack_deploymentslist(stack_id)client.stack_deployment_groupslist,read,read_by_name,approve_all_plans,rerunclient.stack_deployment_runslist,read,approve_all_plans,cancelclient.stack_deployment_stepslist,read,advance,list_diagnostics,download_artifactclient.stack_stateslist,read,download_descriptionclient.stack_configuration_summarieslistclient.stack_deployment_group_summarieslistclient.stack_diagnosticsread,acknowledgeNew and updated models (models):
StackDeployment,StackDeploymentListOptions,StackDeploymentIncludeOptStackDeploymentGroup,DeploymentGroupStatus,StackDeploymentGroupListOptions,StackDeploymentGroupRerunOptions,StackDeploymentGroupStatusCounts,StackDeploymentGroupSummary,StackDeploymentGroupSummaryListOptionsStackDeploymentRun,DeploymentRunStatus,StackDeploymentRunListOptions,StackDeploymentRunReadOptions,StackDeploymentRunIncludeOpt(5 values, all snake_case per API spec)StackDeploymentStep,DeploymentStepStatus,StackDeploymentStepArtifactType,StackDeploymentStepIncludeOpt,StackDeploymentStepListOptions,StackDeploymentStepReadOptions,StackDiagnostic,StackDiagnosticListOptionsStackConfigurationSummary,StackConfigurationSummaryListOptions,StackConfigurationSummaryGroupStatus,StackConfigurationSummaryRunStatusstack_state.py(new file) —StackState,StackStateComponent(correct wire fields:address,component-address,instance-correlator,component-correlator,resource-instance-count),StackStateListOptionsNew errors in
errors.py:InvalidStackDeploymentGroupIDError,InvalidStackDeploymentRunIDError,InvalidStackDeploymentStepIDError,InvalidStackStateIDError,InvalidStackDiagnosticIDErrorInclude param correctness fix:
StackDeploymentRunIncludeOptandStackDeploymentStepIncludeOptuse snake_case values (e.g."stack_deployment_group","stack_approval") matching the HCP Terraform API — not hyphenated strings.Notable implementation decisions
StackStateComponentis a separate model fromStackComponent(used in stack-configurations). The state variant carries per-instance tracking fields (instance-correlator,resource-instance-count) rather than config fields (name,expanded,removed). Verified against the live API wire format.StackConfigurationSummaryincludes two nested rollup objects —group_status_summaryandrun_status_summary— that the API returns but go-tfe does not model. These give a quick view of how many deployment groups/runs succeeded, failed, or were abandoned for each configuration.stack_configuration_summariesandstack_deployment_group_summariespagination is standard (not non-paginated), so_list()is used normally.Testing
relationshipsblock)st-GTFErQVpEN) running 3 deployments (dev/staging/prod)Testing plan
External links
Output from tests
Including output from tests may require access to a TFE instance. Ignore this section if you have no environment to test against.
Rollback Plan
Changes to Security Controls
PCI review checklist
I have documented a clear reason for, and description of, the change I am making.
If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
If applicable, I've documented the impact of any changes to security controls.
Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.
If you have any questions, please contact your direct supervisor, GRC (#team-grc), or the PCI working group (#proj-pci-reboot). You can also find more information at PCI Compliance.