Skip to content

Enhance stack handling with state_reason field #1420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
beyhan merged 1 commit into from
Jan 28, 2026
Merged

Enhance stack handling with state_reason field #1420

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions toc/rfc/rfc-0045-enhance-stack-handling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,20 +127,18 @@ The `state` of the stack will directly influence the behavior of the CF API:
- If the state is `RESTRICTED`, staging a *new* application will fail with an error.
- If the state is `DISABLED`, staging or restaging *any* application will fail with an error.

To improve communication with developers, the existing `description` field of a stack will be leveraged. The content of the `description` field should be included in any warning or error message related to the stack's state. This allows operators to provide context, migration guides, or links to further documentation.
To improve communication with developers, an additional field e.g `state_reason` of a stack object should be leveraged. The content of the `state_reason` field should be included in any warning or error message related to the stack's state. This allows operators to provide context, migration guides, or links to further documentation.

For example, a deprecation warning could look like this:

```
WARNING: The stack 'cflinuxfs3' is DEPRECATED and will be removed in the future.
Description: This stack is based on Ubuntu 18.04, which is no longer supported. Please migrate your applications to 'cflinuxfs4'. For more information, see: <link-to-docs>.
WARNING: The stack 'cflinuxfs3' is DEPRECATED and will be removed in the future: "This stack is based on Ubuntu 18.04, which is no longer supported. Please migrate your applications to 'cflinuxfs4'. For more information, see: <link-to-docs>."
```

And an error message for a disabled stack:

```
ERROR: Staging failed. The stack 'cflinuxfs3' is DISABLED and can no longer be used for staging.
Description: This stack is based on Ubuntu 18.04, which is no longer supported. Please migrate your applications to 'cflinuxfs4'. For more information, see: <link-to-docs>.
ERROR: Staging failed. The stack 'cflinuxfs3' is DISABLED and can no longer be used for staging:"This stack is based on Ubuntu 18.04, which is no longer supported. Please migrate your applications to 'cflinuxfs4'. For more information, see: <link-to-docs>."
```

This approach provides a clear and explicit way for operators to manage the lifecycle of stacks and communicate changes to users effectively.
Expand Down