c8229cc0d6
Almost two years ago, we began referring to the project as Fleet, but there are many occurences of the term "Kolide" throughout the UI and documentation. This PR attempts to clear up those uses where it is easily achievable. The term "Kolide" is used throughout the code as well, but modifying this would be more likely to introduce bugs.
1.7 KiB
Fleet Redux Implementation
Fleet uses Redux for application state management.
React components themselves can manage state, but Redux makes it easy to share
state throughout the app by being the single source of truth (such as keeping track of the entities returned by the API).
To learn more about Redux visit http://redux.js.org.
Redux State Structure
Overview
The shape of the application's Redux state is as follows:
{
app: {
...
},
auth: {
...
},
components: {
...
},
entities: {
...
},
loadingBar: {
...
},
notifications: {
...
},
persistentFlash: {
...
},
redirectLocation: {
...
},
routing: {
...
},
}
App State
App state contains information about the general app setup and information. It
contains a config object with data on the user's organization and Fleet
setup. Additionally, the app state in Redux controls rendering the side
navigation as a mobile view, and displaying the Kolide jagged background image
located on specific pages such as the login page.
Auth State
Auth state contains data on the current user.
Component State
Component state contains data specific to React components.
Entities State
The entities state holds data on specific entities such as users, queries, packs, etc. They follow a similar configuration that can be found here.
Notifications State
The notifications state contains data that informs the rendering of flash messages.
Redirect Location State
The redirect location state contains information about where to redirect a user after login, specifically when they attempt to access an authenticated route when logged out and then log in.