UI Package Deploy Routing Refactor #1265
Merged
Conversation
This file contains 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
demo-routing.mp4 |
Noxsios
requested review from
mike-winberry,
Racer159,
jeff-mccoy and
YrrepNoj
as code owners
jeff-mccoy
reviewed
Jan 28, 2023
jeff-mccoy
reviewed
Jan 28, 2023
jeff-mccoy
reviewed
Jan 28, 2023
jeff-mccoy
reviewed
Jan 28, 2023
jeff-mccoy
reviewed
Jan 28, 2023
jeff-mccoy
reviewed
Jan 28, 2023
✅ Deploy Preview for zarf-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Madeline-UX
previously approved these changes
Jan 30, 2023
Noxsios
added a commit
that referenced
this pull request
Mar 8, 2023
## Description
This change completely reworks the navigation flow for deploying
packages via the UI.
The current method is hardcoded to be `/initialize/{operation}`, the new
flow enables for **both** the init package, as well as any package to be
deployed via the UI utilizing the same flow.
1. UI opens to `/`
2. If uninitialized, user clicks `Initialize Cluster` link
3. --> `/package/deploy?path=init` (for init **ONLY**, the path provided
is `init`, otherwise path is a URL encoded full path to a zarf package)
4. UI queries backend `/packages/find-init` and returns init package
data
5. Package data is loaded into `pkgStore`
6. If no errors are encountered --> `/package/[name]/configure` where
`[name]` is a URI encoded string from the package name; e.g.
`zarf-package-init-package-git-server-arm64.tar.zst -->
/package/init-package-git-server-arm64/configure`
7. Deployment flow from here is unchanged as the previous flow was 90%
ready as a generic package deployment flow (still some work to be done
with this flow, but for now it works well enough)
This opens the door to a potential use case where a user might only open
the UI to deploy a single package, then close it, ie: `zarf package
deploy [name].tar.zst --open-ui`, which would provide a URL:
`http://localhost:{port}/deploy?path={path to package}`
## Type of change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [X] New feature (non-breaking change which adds functionality)
- [ ] Other (security config, docs update, etc)
## Checklist before merging
- [x] Test, docs, adr added or updated as needed
- [X] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed
---------
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
This change completely reworks the navigation flow for deploying packages via the UI.
The current method is hardcoded to be
/initialize/{operation}, the new flow enables for both the init package, as well as any package to be deployed via the UI utilizing the same flow./Initialize Clusterlink/package/deploy?path=init(for init ONLY, the path provided isinit, otherwise path is a URL encoded full path to a zarf package)/packages/find-initand returns init package datapkgStore/package/[name]/configurewhere[name]is a URI encoded string from the package name; e.g.zarf-package-init-package-git-server-arm64.tar.zst --> /package/init-package-git-server-arm64/configureThis opens the door to a potential use case where a user might only open the UI to deploy a single package, then close it, ie:
zarf package deploy [name].tar.zst --open-ui, which would provide a URL:http://localhost:{port}/deploy?path={path to package}Type of change
Checklist before merging