Skip to content

docs: Complete removal of deprecated Allocation API references#557

Closed
github-actions[bot] wants to merge 1 commit intomainfrom
docs/complete-allocation-removal-20260109-163311-13b702c9-2c18dfed02258e57
Closed

docs: Complete removal of deprecated Allocation API references#557
github-actions[bot] wants to merge 1 commit intomainfrom
docs/complete-allocation-removal-20260109-163311-13b702c9-2c18dfed02258e57

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot commented Jan 9, 2026

Summary

This PR completes the documentation cleanup following PR #554, which removed the deprecated Allocation API types from the CRD reference documentation. This PR addresses remaining references found in the Go code and integration documentation.

Changes Made

API Type Documentation (api/v1alpha1/variantautoscaling_types.go)

  • Updated VariantAutoscalingStatus godoc comment to remove mention of "current allocation"
  • Now accurately reflects that the status only contains "desired optimized allocation and actuation status"

Integration Documentation

  • HPA Integration (docs/integrations/hpa-integration.md): Added clarifying note about debug log examples
  • KEDA Integration (docs/integrations/keda-integration.md): Added clarifying note about debug log examples

The debug log examples in both integration guides show internal optimizer data structures (like currentAlloc and desiredAlloc) from an older version that used model-based scaling. These are internal implementation details, not the public API types that were removed in PR #554. Added notes to clarify that current versions use saturation-based scaling with different internal representations.

Related Issues

Testing

  • Documentation changes reviewed for accuracy
  • No code changes requiring functional testing
  • All references to removed API types properly documented

Documentation Quality

This PR follows the documentation standards outlined in the Update Docs workflow:

  • ✅ Clear and accurate technical writing
  • ✅ Maintains consistency with existing documentation style
  • ✅ Provides context for historical examples
  • ✅ Uses progressive disclosure (notes/warnings for important context)

Note: This is an automated documentation update created by the Update Docs workflow.

AI generated by Update Docs

- Update VariantAutoscalingStatus godoc comment to remove mention of 'current allocation'
- Add clarifying notes to HPA and KEDA integration docs about log format changes
- Mark debug log examples as illustrative from older model-based scaling version

Follow-up to PR #554 which removed Allocation types from CRD reference docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant