Skip to content
This repository has been archived by the owner on Aug 12, 2024. It is now read-only.

Revisit the BundleDeployment API's UX after the latest API overhaul #331

Open
timflannagan opened this issue May 6, 2022 · 3 comments
Open
Assignees
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. needs-grooming priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Milestone

Comments

@timflannagan
Copy link
Contributor

timflannagan commented May 6, 2022

Follow-up to #293 which overhauled the BundleDeployment API to support the dynamic creation of Bundle contents.

Goal: revisit the status.installedBundleName and the custom printer columns.

Currently, the UX around the BD's printer column output can be confusing, especially in the case where a generated BundleA was successfully created/unpacked/installed, and the BD was updated with a different desired configuration, and the generated BundleB fails to unpack/install. In this case, the printer columns signal that there's still a successful installation as BundleA is still active, which can be confusing.

One implementation may be centered around using the Deployment/ReplicaSet status fields to derive printer columns (e.g. Ready/Available/etc.), and refactor the BD's printer columns to use boolean types to help communicate the current state of a resource vs. relying on string values which are difficult to accurately portray the full picture of the current state.

@timflannagan timflannagan added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label May 6, 2022
@timflannagan timflannagan added this to the v0.5.0 milestone May 6, 2022
@tylerslaton tylerslaton self-assigned this May 13, 2022
@exdx
Copy link
Member

exdx commented May 26, 2022

UX may include a numeric status: 0/1 or 1/2 available during a pivot that fails.

The UX may be informed by a higher level component (like deppy) handling this status and keeping the rukpak layer straightforward.

@timflannagan timflannagan modified the milestones: v0.5.0, v0.6.0 May 31, 2022
@timflannagan
Copy link
Contributor Author

Related to #403 which can be a short term UX win.

@timflannagan timflannagan modified the milestones: v0.6.0, backlog May 31, 2022
@oceanc80 oceanc80 changed the title Revisit the BundleInstance API's UX after the latest API overhaul Revisit the BundleDeployment API's UX after the latest API overhaul Aug 22, 2022
@github-actions
Copy link

This issue has become stale because it has been open 60 days with no activity. The maintainers of this repo will remove this label during issue triage or it will be removed automatically after an update. Adding the lifecycle/frozen label will cause this issue to ignore lifecycle events.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. needs-grooming priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Development

No branches or pull requests

3 participants