2022-06-15 21:50:44 +00:00
**Table of Contents**
2019-04-03 21:06:20 +00:00
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE - RUN doctoc TO UPDATE -->
2020-04-06 18:18:19 +00:00
2019-04-03 21:06:20 +00:00
- [Vault UI ](#vault-ui )
2022-06-15 21:50:44 +00:00
- [Ember CLI Version Matrix ](#ember-cli-version-matrix )
2019-04-03 21:06:20 +00:00
- [Prerequisites ](#prerequisites )
2022-06-15 21:50:44 +00:00
- [Running a Vault Server ](#running-a-vault-server )
2019-04-03 21:06:20 +00:00
- [Running / Development ](#running--development )
- [Code Generators ](#code-generators )
- [Running Tests ](#running-tests )
- [Linting ](#linting )
- [Building Vault UI into a Vault Binary ](#building-vault-ui-into-a-vault-binary )
2019-08-28 21:47:43 +00:00
- [Further Reading / Useful Links ](#further-reading--useful-links )
2019-04-03 21:06:20 +00:00
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
# Vault UI
2018-04-03 14:16:57 +00:00
This README outlines the details of collaborating on this Ember application.
2022-04-15 17:47:55 +00:00
## Ember CLI Version Matrix
| Vault Version | Ember Version |
| ------------- | ------------- |
2022-10-18 15:46:02 +00:00
| 1.13.x | 4.4.0 |
2022-04-15 17:47:55 +00:00
| 1.10.x | 3.28.5 |
| 1.9.x | 3.22.0 |
| 1.8.x | 3.22.0 |
| 1.7.x | 3.11 |
2018-04-03 14:16:57 +00:00
## Prerequisites
You will need the following things properly installed on your computer.
2022-10-18 15:46:02 +00:00
* [Git ](https://git-scm.com/ )
* [Node.js ](https://nodejs.org/ )
* [Yarn ](https://yarnpkg.com/ )
* [Ember CLI ](https://cli.emberjs.com/release/ )
* [Google Chrome ](https://google.com/chrome/ )
2018-04-03 14:16:57 +00:00
2020-04-06 18:18:19 +00:00
In order to enforce the same version of `yarn` across installs, the `yarn` binary is included in the repo
2019-10-25 21:00:45 +00:00
in the `.yarn/releases` folder. To update to a different version of `yarn` , use the `yarn policies set-version VERSION` command. For more information on this, see the [documentation ](https://yarnpkg.com/en/docs/cli/policies ).
2021-06-16 14:00:50 +00:00
## Running a Vault Server
2022-04-15 17:47:55 +00:00
Before running Vault UI locally, a Vault server must be running. First, ensure
Vault dev is built according the the instructions in `../README.md` . To start a
2021-06-16 14:00:50 +00:00
single local Vault server:
- `yarn vault`
To start a local Vault cluster:
- `yarn vault:cluster`
These commands may also be [aliased on your local device ](https://github.com/hashicorp/vault-tools/blob/master/users/noelle/vault_aliases ).
2018-04-03 14:16:57 +00:00
## Running / Development
2018-11-14 18:57:03 +00:00
2018-04-19 21:08:41 +00:00
To get all of the JavaScript dependencies installed, run this in the `ui` directory:
2019-04-03 21:06:20 +00:00
- `yarn`
2018-04-19 21:08:41 +00:00
If you want to run Vault UI and proxy back to a Vault server running
on the default port, 8200, run the following in the `ui` directory:
2019-10-25 21:00:45 +00:00
- `yarn start`
2018-04-19 21:08:41 +00:00
This will start an Ember CLI server that proxies requests to port 8200,
and enable live rebuilding of the application as you change the UI application code.
Visit your app at [http://localhost:4200 ](http://localhost:4200 ).
If your Vault server is running on a different port you can use the
long-form version of the npm script:
`ember server --proxy=http://localhost:PORT`
2018-04-03 14:16:57 +00:00
2022-02-24 20:04:40 +00:00
To run yarn with mirage, do:
- `yarn start:mirage handlername`
Where `handlername` is one of the options exported in `mirage/handlers/index`
2018-04-03 14:16:57 +00:00
### Code Generators
2020-04-06 18:18:19 +00:00
Make use of the many generators for code, try `ember help generate` for more details. If you're using a component that can be widely-used, consider making it an `addon` component instead (see [this PR ](https://github.com/hashicorp/vault/pull/6629 ) for more details)
2018-04-03 14:16:57 +00:00
Ui/replication status discoverability (#8705)
* Sidebranch: add new route on DR secondary (#8640)
* setup, not complete
* update routing
* clean up
* add test
* add link from status menu
* clean up
* fixes per pr comments
* revert back to two if statements due to refresh bug
* Sidebranch: Setup Replication Page as component to be consumed in all pages for project (#8661)
* setup, not complete
* update routing
* clean up
* add test
* add link from status menu
* clean up
* fixes per pr comments
* setup dashboard with contextual components, and toggle
* setup option to show tabs or not
* handle conditional nav menu
* pass in whole model object
* rename to replication-page
* clean up
* clean up based on pr feedback
* fix linting error
* Sidebranch: setup replication dashboard with scss and initial card components (#8670)
* setup replication dashboard with scss and initial card components
* sync with Noelles changes and clean up the inner grid container inside the selectable card
* set up nested contextual components for selectable-cards
* setup component for table row
* address walk through notes
* remove name selectable from card component as it is not selectable
* add missing space
* Ui/dr primary/initial page setup (#8671)
* add helperText param to InfoTableRow
* initial page setup
* format card with padding and correct number of rows
* style card titles with margin
* move styles inside replication class; add todos
* move replication-summary styles into core app so hot reloading works
* prevent known secondaries card from being cut off on the right hand side
* make cards have the correct column span
* make code elements inside tables black
* WIP - start VltTable component
* simplify css
* renamed VltTable to ReplicationTable and use divs instead of table elements
* fix position of known secondaries
* use table element for secondaries card
* add todo
* move replication components to replication engine
* Revert "move replication components to replication engine"
This reverts commit 2228b8392199a1376815dc8b7642de438aad68b5.
* move ReplicationPrimaryCards to components
* remove hover box shadow since cards are not selectable yet
* only apply padding to replication selectable-cards
* specify replication vlt-table in classname
* move replication toggle and toggle into core addon
* remove extra toolbar border
* remove duplicate css
* move ReplicationTableRows to core addon and use them on DR primary page
* clean up todos
* add jsdoc comments
* rename ReplicationTable to KnownSecondaries
* update replicaiton table api to accept flexible data
* rename replicationAttrs to data
* move replication components to core addon
* Ui/dr primary components (#8711)
* populate table with actual secondary ids
* add todo
* make KnownSecondariesCard component
* move KnownSecondariesCard styles to own file
* add EmptyState when there are no known secondaries
* fix known secondaries manage link
* fix Add Secondary link; bring in capabilities model to repliation index route so we can check for adding secondaries
* fix JSDOC comments and updata data to replicationAttrs
* Sidebranch: DR Secondary Dashboard - pr4 (#8706)
* setup styling for delta
* clean up
* replication table remove and rename model to data
* remove old replication header component now that it is in addons
* move replication secondary card component
* calc delta
* clean up
* remove unused components that are now in addon
* address pr comments
* remove test
* fix failing test
* address pr comments
* attempting to fix test
* move to computed components
* fix test error
* fix state of null error
* Sidebranch: DR Secondary Dashboard state message handlers (#8741)
* setup styling for delta
* clean up
* replication table remove and rename model to data
* remove old replication header component now that it is in addons
* move replication secondary card component
* calc delta
* clean up
* remove unused components that are now in addon
* address pr comments
* remove test
* fix failing test
* address pr comments
* attempting to fix test
* initial setup before merge updates
* move to computed components
* fix test error
* fix state of null error
* clean up
* setup alert banner and documentation link
* setup alert banner with second icon
* remove underscore to dash
* add in missing error messages
* add connection-state shutdown
* add storybook update to alert banner
* pr comments
* move css class to helper class
* address pr comments
* add in connection states correct endpoint
* Ui/dr dashboard tests (#8732)
* initial test setup
* use margin when there are no knownsecondaries
* set up replication tests in ember engine
* set knownSecondaries
* move tests to host app and set resolver
* finish known-secondaries-card-test
* make knownSecondaries array match the API response
* add known secondaries table test
* oops, remove stories directory
* wip - replication table rows test
* remove extra code
* finish replication table rows tests
* add | Enterprise | to test module
* remove unncessary assertion:
* show dynamic state glyph (#8747)
* show dynamic state glyph
* show state glyph after state
* move LearnLink into core addon
* make ReplicationDocLink component
* prevent double lines at the bottom of the dashboard
* Sidebranch: dr-secondary-dashboard-pr7 (#8792)
* move dr to higher level component and setup isDisabled for error state when dr mode is disabled.
* add in error messages final
* refactor transistion on submit handler focused on dr secondary
* handle transition
* update empty state component to include icon and add empty state to details page
* fix spelling
* address pr comments
* merge with replication branch
* remove component structure for replication-secondary-card
* compute title and error message
* make specific empty state messages
* fix test
* address pr comments
* regenerate the storyboook for empty state
* Replication Primary Dashboard: handle errors (#8845)
* use h3 instead of code elements
* use correct property names for StateDisplay
* WIP
* remove todo
* move cluster states into a map; make status menu icon match cluster state
* show error in state card using the same state map in the cluster model
* whitespace
* move cluster-states into a helper and update usage
* use circle success icon for stream-wals because that is the ideal state
* more refactoring of cluster state display
* use new cluster-states helper
* whitespace
* use clusterStates helper in replication secondary card
* remove extra import
* add default values for when state isn't recognized
* make sure that state exists before getting state details from clusterStates helper
* be more strict when state cannot be found
* use brace expansion to fix linting error
* add tests for error states
* fix text wrapping issue on secondary cards; make titles match mocks
* use unknown if metric isn't foudn
* remove extra border on selectable card when there is an error
* use outline square in status menu for error
* Ui/replication/refactor dashboard components (#8878)
* use ReplicationDashboard component
* move syncing and alert banners into dashboard component
* only show primary cluster addr if dashboard is for a secondary
* use ReplicationPage and Dashboard
* move isSecondary to page component
* remove duplication
* remove dead code
* refactored table rows
* make sure dashboards update data when we are switching between mclusterModes and replicationTypes
* clarified replicationMode and clusterMode
* remove extra margin
* get rid of data
* remove syncProgress
* remove Enterprise filter from tests so component tests are run
* Ui/replication/primary reindexing (#8906)
* fix typo
* fetch replication/mode/status and pass to dashboard component
* add reindexing stage to AlertBanner; use real value for isReindexing
* remove dr since we don't need it anymore
* add indentation
* remove TODO
* capitalize reindexing_stage and make progress 0 by default
* remove Toggle since we don't need it anymore
* get allllll the variables at once
* only run secondary details test on enterprise
* Sidebranch: component and acceptance tests (#8903)
* address secondary card overflow issue
* setup replicaiton header test
* address secondary card overflow issue
* setup replication secondary card test
* setup replicaiton header test
* setup replicaiton page test
* setup replication secondary card test
* setup replication dashboard test
* setup replicaiton page test
* remove unused code
* fix overflow
* finish test for rep dashboard
* update rep secondary card test
* finish rep header test
* fix rep table rows and header test
* fix header test
* fix missing data-test-primary-cluster
* add to secondary test
* remove pauseTest
* add to enterprise replication test
* add mode to dr secondary test
* remove pauseTest
* add enterprise to test
* amend per pr commments
* re organize rep secondary card test
* adjust error heights with design input
* move const around in rep secondary card test
* move const around and message for rep dashboard test
* amend per pr review comments
* remove styling from grid-item-left
* remove dup hasErrorClass key
* quick fix
* test failure fix
* fix test due to merge
* remove hasErrorClass
* modify test message
* Sidebranch: remove delta, toggle, and make auto-refresh (#8945)
* change styling
* remove replication toggle
* modifications for auto refresh and final removal of delta and last wal
* fix refresh issue by removing replicationMode on this.reset which conflicts with the same property being set on the cluster model
* remove comments
* add unknown placeholder
* add auto refresh to other components and remove mention of toggle
* remove meep and primary cluster heading area
* ensure status menu displays replication state, not just one (#8959)
* Add Replication Reindexing Progress Bar (#8975)
* whitespace
* rename consts
* rename variables
* test that dashboard shows a reindexing alert banner
* standardize shamir and ui wizard progress bar
* make new progressbar component
* just kidding, we can use the html5 progress bar
* make top margins consistent across primary and secondary dashboards
* clean up AlertBanner JSDocs and markdown
* show a progress bar inside an AlertBanner if cluster is reindexing
* add example AlertBanner with Progress Bar
* add reindexing tests
* add a tiny left margin to progress bars inside alert banners
* keep old class names in wizard to prevent bug, but keep consistent progress background color
* use spacing variables
* remove extra border when secondary card has an error
* make card header sizes and weight consistent
* Sidebranch: Performance Secondary Dashboard (#8956)
* setup rep dashboard to dynamically take in the component to render and dynamically setup the css based on mode of cluster
* conditional pass in the correct props to the Dashboard.card component and add margin to reindexing alertBanner
* update replication dashboard test
* add performance secondary test and clean up replication-secondary-card test
* fix message
* replace cluster-id with secondaryId
* remove reindexing test as its a duplicate of the branch noelle is working on
* cleanup
* address pr comments
* small test fixes
* add secondaryId to header test
* fix tests description
* Ui/replication/test update (#8995)
* make sure progress bar updates and animates
* ensure dashboard updates when replication mode has changed
* make sure we update isSyncing when state has changed
* wip - console log statements to see if components are getting new attrs
* Revert "wip - console log statements to see if components are getting new attrs"
This reverts commit d05219ba6c14c64a9f2e867892476faf7dad4659.
* style progress bar in mozilla; allow testing the progress bar in storybook
* test that primary and secondary card container don't display at the same time
* prepare KnownSecondariesTable for backend compatibility (#9029)
* Ui/replication mgmt action block (#9053)
This does some low-impact work to prepare for the refactor of replication-actions. Includes:
- Move modal to addon in lib/core
- Update modal to take a "type" param which changes the header color + icon
- Add tests for modal changes
- Add action-block style only component
- Add styles-only replication-action grid that the action-blocks will live inside of
* Sidebranch: address transition issues on replication engine and actions (#9010)
* small formatting changes
* change findRecord to peekRecord so it keeps track of the changing data.
* add styling such that when page is loading it does not spread across the whole page
* help with reload and styling on replication route
* initial setup for new flow that handles adding a perf secondary, and also some on a dr secondary
* clean up
* add loader on rep page for situations when data is still loading, and add loading mode in header, seperate from the modeForUrl used in other places to help transistion
* fix transitionTo when coming from different replication.mode vs replication.index route
* set default of mode for radio checkboxes after removing from DEFAULTS var
* reset and cont using onEnable because TransitionTo is not working inside of component
* remove console
* the reason we were getting transition errors :(
* remove modeObjecT
* fix error by removing peek record from application and moving it lower down in a property replicationAttrs
* Readd back space
* this one really does fix the issue
* add back peek record and add conditional to isLoadingData
* figure out cluster id from service instead of hardcoded
* fix capabilities-self error by adding a 1 sceond delay for when transition from replication.index to replication.mode.index on enable performance secondary
* remove attempt to circumvent the peekRecord in application
* add to replication page tests and clarify replicationMode to formattedReplicationMode, it's super confusing when seeing replicationMode being duplicated throughout the computed components. this clarifies its computed only for formatting
* fix repetive conditional
* capture the state when either dr.mode or performance.mode are undefined, which happens during a transition. If this is the case add a loader on the replicationindex page.
* address some pr comments
* small change
* add bootstrapping mode to test
* add Replication Learn Links to wizard (#9106)
* Ui/summary dashboard (#9079)
* move key value to lib/core/addon so I can use inside replication engine
* setup summary dasbhoard on replication summary component
* set title for summary dashboard
* do not show replication table rows on summary dashboard
* show that last_wal updates every 10 seconds
* show replication table rows on individual dashboards, but not summary
* remove extra bottom border on replication-dashboard
* add replicationDetailsSummary object and replication-summary-card
* setup structure and data calcs of replication summary card
* fix links and styling on summary card
* breadcrumbs
* match state title on summary dashboard to individual dashboards
* add margin below replication header
* update breadcrumbs to show replication mode
* align details link right
* add margin below tabs in replication header
* user helper-text to make card text styling consistent across dashboards
* remove unneeded code
* add bottom border to summary state
* add bottom margin to summary dashboard
* add negative margins to bring values closer to related cell
* fix failing test due to data-test attribute change and make storybook component for replication-summary-card
* setup replication summary card test. I suspect we'll move the hasError test to the dashboard where the error will show around the state display
* add to replication acceptance test for new summary dashboard
* remove pauseTest
* add is-active to li element
* clean up
* dashboard test and clean up
* addressing pr comments
* fix replication/null/status error
* add JSDocs for rep page and rep dash
* more pr cleanup
* remove conditional and fix styling blue link
* fix conditional on when loading summary dashboard to check for primary on both. wrap code in div so it lands on another line.
Co-authored-by: Noelle Daley <adriannenoelle@gmail.com>
* change message with bold 'not' if primary (#9112)
* Add JSDocs to components (#9125)
* jsdocs
* remove todo that is no longer relevant
* clean up wording
* wordsmithing
* fix spelling
* example for clusterMode
* Replication Management Sidebranch: Replication Action Disable (#9061)
Set up dr-secondary management page with new action flow
* Create confirmation-modal component
* Refactor replication-dr-secondary splash page to replication manage page
* Refactor replication-action-disable component to use confirmation modal
* Add details/manage tab to replication-dr-secondary section
* Refactor Replication Action: Promote to use modal flow (#9122)
* Ui/replication mgmt/reindex action (#9126)
* Replication Management Sidebranch: Replication Action Disable (#9061)
* Ui/replication mgmt/recover action (#9127)
* Replication Management Sidebranch: Replication Action Recover (#9061)
* Close link-to tag in header (#9139)
Fixes bad merge conflict
* UI: Fix replication management tests (#9136)
* do not show replication mode or id when replication isn't enabled
* fix broken tag
* fill in confirmation text when disabling replication in tests
* fix typo
* fix demote primary test selector
* add test selectors and update tests to match new format
* fill in Performance when disabling performance secondary
* Ui/replication mgmt/update primary action (#9149)
* Update Primary replication action uses modal flow
* Update modal max-height to accommodate for the navbar
* Ui/secondary token flow dr (#9150)
* setup token modal flow
* calc expirationDate
* fix date-format test after moving it in addon
* fix icon conditional in modal title
* decode token to get epoch expiration date and convert
* handle clicking outside of modal
* remove extra copy button
* add modal check in rep acceptance test
* look only at day and month and remove console
* fix spelling
* cleanup
* replace dr with variable
* make string check longer in test
* fix test variables
* refactor enterprise test for secondary token flow
* make cluster model property replicationModeForDisplay to handle all cases where we were either conditionally displaying the DR, Disaster Recovery, etc. or where we were hardcoding it into the hbs. For situations where it was DR before, I am now keeping it more consistent and using Disaster Recovery as on the manage page we do not show the Diaster Recovery (DR) anywhere.
* set initial value for ttl picker to fix issue where itwas setting seconds to minutes
* clean up
* add comment about ttl picker
* Add known primaries info table (#9152)
* replace primaryClusterAddr with knownPrimaryClusterAddrs
* rename state to Status; fix css layout
* add InfoTable component
* only show label column if there is a label
* add grid-item-middle class
* whitespace
* fix grid layout
* die tagName, die
* set table max-height
* prep InfoTable for Storybook
* ensure cards always have the same height
* remove duplicate max height since vlt-table already has max-height
* add InfoTable tests
* add InfoTable to Storybook
* organize grid item css; rename for consistency
* add sticky header to table
* add sticky-header class to keep table styles in scope
* whoops, do not use fake data
* Ui/rep design updates (#9169)
* show secondaryId in table rows
* show primary_cluster_addr in table rows
* remove cluster Ids from replication headers
* Ui/fix enable overflow (#9173)
* only show primary_cluster_addr for primary
* fix overflow on replication index
* remove display from cluster-states because it is not used anywhere
* fix missing replication mode from description
* add comments
* use helper to consolidate replication descriptions
* fix text wrapping on medium screen sizes
* Ui/replication mgmt/demote action (#9168)
* Replication demote action uses modal flow
Co-authored-by: Noelle Daley <adriannenoelle@gmail.com>
Co-authored-by: Angel Garbarino <argarbarino@gmail.com>
* Ui/replication merge cleanup 2 (#9212)
* replace with replicationModeForDisplay that is defined on the cluster
* fix spelling on replication and confirmed with design for placeholder when Not defined
* remove extra div with box class
* change manage link to take you to the secondaries manage as it's within the known secondaries card
* fix scroll always showing by adding auto, and decreasing the height. WIP
* add empty state to known_primary_cluster_addrs
* address pr comments
* Add real connected state and API address (#9219)
* fix title of secondary card
* show connected status
* fix tests
* fix enterprise test (#9229)
* fix enterprise test
* add n
* add another n
* Ui/replication mgmt/generate token action (#9187)
Generate operation token flow from replication DR Secondary. Clicking 'Cancel' on the modal after the operation has started results in cancelling generate operation and restarting the process.
* use none set instead of not defined
Co-authored-by: Noelle Daley <noelledaley@users.noreply.github.com>
Co-authored-by: Chelsea Shaw <chelshaw.dev@gmail.com>
Co-authored-by: Noelle Daley <adriannenoelle@gmail.com>
2020-06-18 21:52:43 +00:00
eg. a reusable component named foo that you'd like in the core engine
- `ember g component foo --in lib/core`
- `echo "export { default } from 'core/components/foo';" > lib/core/app/components/foo.js`
2018-04-03 14:16:57 +00:00
### Running Tests
2018-04-19 21:08:41 +00:00
Running tests will spin up a Vault dev server on port 9200 via a
pretest script that testem (the test runner) executes. All of the
acceptance tests then run, proxing requests back to that server.
2018-04-03 14:16:57 +00:00
2019-12-18 17:12:44 +00:00
- `yarn run test:oss`
- `yarn run test:oss -s` to keep the test server running after the initial run.
2018-11-14 18:57:03 +00:00
- `yarn run test -f="policies"` to filter the tests that are run. `-f` gets passed into
[QUnit's `filter` config ](https://api.qunitjs.com/config/QUnit.config#qunitconfigfilter-string--default-undefined )
2018-04-03 14:16:57 +00:00
2018-09-25 16:28:26 +00:00
### Linting
2022-04-15 17:47:55 +00:00
- `yarn lint`
- `yarn lint:fix`
2018-09-25 16:28:26 +00:00
2018-04-19 21:08:41 +00:00
### Building Vault UI into a Vault Binary
2018-11-14 18:57:03 +00:00
2021-08-18 15:05:11 +00:00
We use the [embed ](https://golang.org/pkg/embed/ ) package from Go 1.16+ to build
the static assets of the Ember application into a Vault binary.
2018-04-03 14:16:57 +00:00
2018-04-19 21:08:41 +00:00
This can be done by running these commands from the root directory run:
`make static-dist`
`make dev-ui`
2018-04-03 14:16:57 +00:00
2018-04-19 21:08:41 +00:00
This will result in a Vault binary that has the UI built-in - though in
a non-dev setup it will still need to be enabled via the `ui` config or
setting `VAULT_UI` environment variable.
2018-04-03 14:16:57 +00:00
## Further Reading / Useful Links
2022-10-18 15:46:02 +00:00
* [ember.js ](https://emberjs.com/ )
* [ember-cli ](https://cli.emberjs.com/release/ )
* Development Browser Extensions
* [ember inspector for chrome ](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi )
* [ember inspector for firefox ](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/ )
