A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | Purpose | |||||||||||||||||||||||||
2 | The "Architectural PoC Preview" environment has been setup to give the Folio community greater insight into the progress of the architectural proof of concept, and to allow community members to gain first hand experience using it. This document serves as a way to collect feedback and questions in a single location. | |||||||||||||||||||||||||
3 | ||||||||||||||||||||||||||
4 | Scope | |||||||||||||||||||||||||
5 | • Keycloak - Replaces home-grown authN/Z with standard protocols, e.g. OIDC | |||||||||||||||||||||||||
6 | • Kong API gateway - Proxies requests from outside the system. Modules communicate directly with one another with the help of sidecars (see below) | |||||||||||||||||||||||||
7 | • Module Sidecars - These enable direct module to module communication w/o needing to change module code. These work in conjunction with Keycloak to enforce authorization, tenant entitlement checks, etc. | |||||||||||||||||||||||||
8 | • Role based access controls - Replacement of permissions/permissionSets with capabilities/capabilitySets and roles. | |||||||||||||||||||||||||
9 | • Manager components - These new components are used to administer the system at the application level | |||||||||||||||||||||||||
10 | • Mod-scheduler - Handles the static timer calls defined in module descriptors and allows for dynamic timers | |||||||||||||||||||||||||
11 | • Formalized applications | |||||||||||||||||||||||||
12 | • Updated "Settings -> Software Versions" page - Incorporates applications via a new hierarchical layout: applications -> modules -> interfaces | |||||||||||||||||||||||||
13 | • Poppy Bugfest data | |||||||||||||||||||||||||
14 | • Poppy CSP1 versions of modules. | |||||||||||||||||||||||||
15 | ||||||||||||||||||||||||||
16 | Out of Scope | |||||||||||||||||||||||||
17 | • Application-specific UI Bundles | |||||||||||||||||||||||||
18 | • Bounded Contexts / shared database access across modules | |||||||||||||||||||||||||
19 | • Enhanced Consortia Support - While we have integrated with ECS, this deployment is single-tenant for simplicity | |||||||||||||||||||||||||
20 | • Policies - Role based policies are included and used behind the scenes, but other (Time-based, etc. policies are not yet available) | |||||||||||||||||||||||||
21 | • Ideal grouping of modules into applications - Currently there are only a few very large applications, eventually these will be split up into smaller applications more closely aligned with functional areas of Folio. | |||||||||||||||||||||||||
22 | ||||||||||||||||||||||||||
23 | Expectations / Known Issues | |||||||||||||||||||||||||
24 | • This is a work in progress, we're still working through issues with certain applications. As such you will notice that not all functionality is available at the moment. | |||||||||||||||||||||||||
25 | • Poppy bugfest data is present in this environment, but no cleanup of that data has been done, nor has extensive testing been performed against this environment. | |||||||||||||||||||||||||
26 | • Editing users will not work in some cases due to the way user data was loaded. However, any new users should be editable. | |||||||||||||||||||||||||
27 | • Presently, the ability to delete roles via the UI is not yet implemented. | |||||||||||||||||||||||||
28 | • The ability to manage role/user assignments is possible from the "ui authorization roles" section in settings, but not yet available in the users app. The goal is to eventually allow these assignments to be managed from both perspectives | |||||||||||||||||||||||||
29 | • Some parts of "Settings -> Developer" have not been updated and do not work at the moment. | |||||||||||||||||||||||||
30 | • This environment is not intended for particularly heavy loads or performance testing. It's not setup for high availability | |||||||||||||||||||||||||
31 | • To save hosting costs, this environment is paused on the weekends (0:00 Saturday ET - 0:00 Monday ET) | |||||||||||||||||||||||||
32 | • Aside from changes to stripes-core and a few minor changes in places like ui-users, existing modules have not been changed. | |||||||||||||||||||||||||
33 | • Some edge APIs are available, but they have not been thoroughly tested, e.g. patron, oaipmh, orders, rtac | |||||||||||||||||||||||||
34 | • Please use Chrome when using this environment. We are aware of some issues with Firefox, and possibly other browsers. | |||||||||||||||||||||||||
35 | ||||||||||||||||||||||||||
36 | Environment Details | |||||||||||||||||||||||||
37 | URL: | https://arch-poc.int.aws.folio.org/ | ||||||||||||||||||||||||
38 | Username: | folio | ||||||||||||||||||||||||
39 | Password: | folio | ||||||||||||||||||||||||
40 | API Key: | eyJzIjoiNGRPdHRDVFNnQiIsInQiOiJmczA5MDAwMDAwIiwidSI6IkVCU0NPRWRnZSJ9 | ||||||||||||||||||||||||
41 | Edge URL: | https://edge-pbfe2.int.aws.folio.org | ||||||||||||||||||||||||
42 | ||||||||||||||||||||||||||
43 | ||||||||||||||||||||||||||
44 | ||||||||||||||||||||||||||
45 | ||||||||||||||||||||||||||
46 | ||||||||||||||||||||||||||
47 | ||||||||||||||||||||||||||
48 | ||||||||||||||||||||||||||
49 | ||||||||||||||||||||||||||
50 | ||||||||||||||||||||||||||
51 | ||||||||||||||||||||||||||
52 | ||||||||||||||||||||||||||
53 | ||||||||||||||||||||||||||
54 | ||||||||||||||||||||||||||
55 | ||||||||||||||||||||||||||
56 | ||||||||||||||||||||||||||
57 | ||||||||||||||||||||||||||
58 | ||||||||||||||||||||||||||
59 | ||||||||||||||||||||||||||
60 | ||||||||||||||||||||||||||
61 | ||||||||||||||||||||||||||
62 | ||||||||||||||||||||||||||
63 | ||||||||||||||||||||||||||
64 | ||||||||||||||||||||||||||
65 | ||||||||||||||||||||||||||
66 | ||||||||||||||||||||||||||
67 | ||||||||||||||||||||||||||
68 | ||||||||||||||||||||||||||
69 | ||||||||||||||||||||||||||
70 | ||||||||||||||||||||||||||
71 | ||||||||||||||||||||||||||
72 | ||||||||||||||||||||||||||
73 | ||||||||||||||||||||||||||
74 | ||||||||||||||||||||||||||
75 | ||||||||||||||||||||||||||
76 | ||||||||||||||||||||||||||
77 | ||||||||||||||||||||||||||
78 | ||||||||||||||||||||||||||
79 | ||||||||||||||||||||||||||
80 | ||||||||||||||||||||||||||
81 | ||||||||||||||||||||||||||
82 | ||||||||||||||||||||||||||
83 | ||||||||||||||||||||||||||
84 | ||||||||||||||||||||||||||
85 | ||||||||||||||||||||||||||
86 | ||||||||||||||||||||||||||
87 | ||||||||||||||||||||||||||
88 | ||||||||||||||||||||||||||
89 | ||||||||||||||||||||||||||
90 | ||||||||||||||||||||||||||
91 | ||||||||||||||||||||||||||
92 | ||||||||||||||||||||||||||
93 | ||||||||||||||||||||||||||
94 | ||||||||||||||||||||||||||
95 | ||||||||||||||||||||||||||
96 | ||||||||||||||||||||||||||
97 | ||||||||||||||||||||||||||
98 | ||||||||||||||||||||||||||
99 | ||||||||||||||||||||||||||
100 |