idproject
int64 7.76k
28.8M
| issuekey
int64 675k
128M
| created
stringlengths 19
32
| title
stringlengths 4
226
| description
stringlengths 2
154k
⌀ | storypoints
float64 0
300
⌀ |
|---|---|---|---|---|---|
7,128,869 | 31,873,580 |
2020-03-11 14:17:25.231
|
Request access: persist and show outgoing access request
|
**As a** administrator
<br>**I want** see that there's an access request for a service
<br>**so** that I know my access status per service
**:desktop_computer: How to demonstrate**
1. Prepare the DB so every status is visible in the directory
1. Open the Review App
1. Navigate to the directory page
1. There is a status column with the status for every service
**:white\_check\_mark: Acceptance criteria**
1. It should be possible to request access from the Directory
1. Outgoing access requests are persisted in the management-api using Etcd.
1. Add extra column to the directory list with the status request of the request.
1. The management api exposes an endpoint with all data required for the Services list in the UI.
**:link: Reference links**
1. https://www.sketch.com/s/89b1e1ac-ec61-482a-bc78-8d1b811bf210/a/JgzOy9
| 5 |
7,128,869 | 31,873,431 |
2020-03-11 14:14:10.584
|
Request access: create an access request
|
**As a** administrator
<br>**I want** request access to a service
<br>**so** that I can use the service when I get permission
**:desktop_computer: How to demonstrate**
1. After clicking on "Request access" in the management-ui an access request is logged in the stdout of the management-api
**:white\_check\_mark: Acceptance criteria**
Todo:
- Add drawer
- Add button "Request access" in drawer and in row of service
- The management-ui passes the request to the management-api (API)
**E2E tests**
- Press button and see pending state
**:link: Reference links**
1. https://www.sketch.com/s/89b1e1ac-ec61-482a-bc78-8d1b811bf210/a/pMoKvG
| 5 |
7,128,869 | 31,598,205 |
2020-03-05 08:34:38.766
|
Management: services list
|
**As a** administrator
<br>**I want** see a list of services running in my NLX deployment
<br>**so** that I know what is runnning
**:desktop_computer: How to demonstrate**
1. Navigate to services
1. View list of services
1. Open service list with wifi turned off (should generate an error)
1. Open an empty service list to verify empty state
**:white\_check\_mark: Acceptance criteria**
1. Services is available in the navigation
1. Display name
1. Display authorization type
1. ~~Display status~~ not available from API
1. ~~Display api spec type~~ not available from API
1. Display progress icon when loading
1. Display error message when loading the overview fails
1. Add empty state when no services are available
1. Do not implement search and setting button
**:link: Reference links**
Design:
https://sketch.cloud/s/eDOWa/a/zPE5ka
<br><br>
Empty state pattern: (from in/outways, but is the same for all tables)<br>
https://sketch.cloud/s/eDOWa/a/3Y9ldz
<br><br>
Loading state pattern: (from in/outways, but is the same for all tables)<br>
https://sketch.cloud/s/eDOWa/a/8RnoEa
<br><br>
Interactive state table tokens:
<br><br>
// Table<br>
$colorBorderTable $colorPaletteGray800<br>
$colorBorderTableFocus $colorFocus<br>
$colorBackgroundTableHover $colorBackgroundAlt<br>
$colorBackgroundTableActive $colorPaletteGray800<br><br>
Working example van een ander design system (qua sortering, inclusief animerend pijltje :wink:):<br>
https://www.carbondesignsystem.com/components/data-table/code/<br><br>
| 5 |
7,128,869 | 31,598,171 |
2020-03-05 08:33:48.546
|
Management: inway details
|
**As a** administrator
<br>**I want** so the details of my inways
<br>**so** that I can verify they are configurated correctly
**:desktop_computer: How to demonstrate**
1. Select a inway from the in/outway overview
**:white\_check\_mark: Acceptance criteria**
Create drawer with:
1. Display name
1. Display type in/outway
1. Display IP-adres
1. Display Hostname
1. Display Self address
1. Display Version
1. Display service list (showing the name of each service)
1. Do not implement clickable service list
**Questions**
1. Show we display certifcate information?
- We can do so in a follow up story.
1. Can you navigate to service details from service list?
- Yes.
1. Disable sorting in service list?
- Yes, the list can not be sorted.
**:link: Reference links**
1. https://sketch.cloud/s/eDOWa/a/1pzP3n
| 5 |
7,128,869 | 31,598,142 |
2020-03-05 08:33:00.561
|
Management: inways
|
**As a** administrator
<br>**I want** to have an overview of all the inway
<br>**so** that I can see whats running on my environment
**:desktop_computer: How to demonstrate**
1. Navigate to inways (button is named only inway opposed to what the design says)
1. Open overview with wifi turned off (should generate an error)
1. Open overview without inway configured to verify empty state
**:white\_check\_mark: Acceptance criteria**
1. Only show the logical inways (so aggregate multiple instances to one)
1. Add inway into menu
1. Display type (inway)
1. Display name
1. Display hostname
1. Display status
1. Display number of services
1. Display version
1. Display progress icon when loading
1. Display error message when loading the overview fails
1. Add empty state when no inway are available
1. Do not implement search
1. Do not implement sorting
1. Path should be /in-outways
**:link: Reference links**
1. https://sketch.cloud/s/eDOWa/a/nPV5g0
1. https://sketch.cloud/s/eDOWa/a/3Y9ldz
| 5 |
7,128,869 | 31,598,107 |
2020-03-05 08:32:03.532
|
Management: directory list
|
**As a** administrator
<br>**I want** to see a list of all services available on the NLX network
<br>**so** that I know which APIs I can use
**:desktop_computer: How to demonstrate**
1. Navigate to directory
1. View list of services from the directory-url
1. Open directory with wifi turned off (should generate an error)
1. Open an empty directory list to verify empty state
**:white\_check\_mark: Acceptance criteria**
1. Add directory to navigation
1. Display organization
1. Display service name
1. Display status
1. Display API-type
1. ~~Display environment~~ (will be done as part of https://gitlab.com/commonground/nlx/nlx/-/issues/911)
1. Display progress icon when loading
1. Display error message when loading fails
1. Display empty state when no services are available
1. Do not implement search
1. Do not implement authorization column
**Questions**
- Do we implement sorting?
- ~~It would be great if we can mark the list services endpoint on the outway [public and stable](https://docs.nlx.io/use-nlx/new-releases) as well. Applications can then use this special endpoint to implement introspection features. @sergei-maertens would be very happy with this feature.~~ will be picked up in #924
**:wrench: Proposed technical solution**
- We add an endpoint on the outway that shows the list of services in the directory
- The management-api retrieves the list of services in the directory through the outway
**:link: Reference links**
1. https://sketch.cloud/s/eDOWa/a/JgzOy9
| 5 |
7,128,869 | 31,598,052 |
2020-03-05 08:30:25.428
|
Implement 404 page
|
**As a** _user_
<br>**I want** _goal_
<br>**so** _purpose_
**:desktop_computer: How to demonstrate**
1. Enter a non-existing url (eg: `<base_url>/asdf`) and see 404 page
**:white\_check\_mark: Acceptance criteria**
Depends on:
- page template
Todo:
- implement design
- show 404 page when a route is invalid / not found
**:link: Reference links**
1. https://sketch.cloud/s/eDOWa/a/PEzbMP
| 1 |
7,128,869 | 31,597,770 |
2020-03-05 08:29:00.679
|
Implement page template
|
**As a** _user_
<br>**I want** _goal_
<br>**so** _purpose_
**:desktop_computer: How to demonstrate**
1.
**:white\_check\_mark: Acceptance criteria**
Todo:
- fetch requirements from Peter about what sections should be scrollable / fixed
- user account info at top
- gemeente + environment info at top
- sidebar including only the link 'NLX Management' (links to root),
**:link: Reference links**
1. https://sketch.cloud/s/eDOWa/a/rPQ5lD
| 5 |
7,128,869 | 31,597,658 |
2020-03-05 08:27:42.778
|
Implement authentication mechanism
|
**As a** system administrator
<br>**I want** login to management using open-id connect
<br>**so** securely manage NLX
**:desktop_computer: How to demonstrate**
1. in style
**:white\_check\_mark: Acceptance criteria**
1. remove username password
1. add open-id connect
1. docker-compose example with dex
1. developer documentation, no user documentation yet
**:link: Reference links**
Use appstore history
1. https://sketch.cloud/s/eDOWa/a/7L27xY
| 5 |
7,128,869 | 31,597,604 |
2020-03-05 08:26:13.565
|
Implement E2E test tooling
|
**As a** _user_
<br>**I want** _goal_
<br>**so** _purpose_
**:desktop_computer: How to demonstrate**
1.
**:white\_check\_mark: Acceptance criteria**
- E2E-test setup using BrowserStack and initial test (see setup Appstore)
- a11y-test setup using axe + test welcome page (see setup DON)
**:link: Reference links**
1.
- can we run an actual instance of the management-ui as part of a Review App? Can we give BrowserStack access to it? -> yes, in review app
| 3 |
7,128,869 | 31,597,540 |
2020-03-05 08:24:54.101
|
Implement Welcome page
|
**As a** _user_
<br>**I want** _goal_
<br>**so** _purpose_
**:desktop_computer: How to demonstrate**
1.
**:white\_check\_mark: Acceptance criteria**
- setup CI/CD
- setup fresh CRA in 'nlx-management'
- implement welcome page
- path: /login
- out of scope: login button, should be done as part of the dex story
- create separate `@commonground/linting package` with our shared linting configuration. As a base [this repo](https://github.com/publicJorn/eslint-config-jorn) can be used. It's a copy of react-scripts. No specific work was done for it yet. (we'll base it on standardjs) **@publicJorn**
**:link: Reference links**
1. https://sketch.cloud/s/eDOWa/a/7L27xY
| 8 |
7,128,869 | 31,597,435 |
2020-03-05 08:22:37.460
|
Extract components from Appstore to CG Design System
|
**As a** _user_
<br>**I want** _goal_
<br>**so** _purpose_
**:desktop_computer: How to demonstrate**
1.
**:white\_check\_mark: Acceptance criteria**
- remove components from CG DS which we don't use in DON and Appstore
- provide default theme.js
- add global styling, Typography and Button components
- take Peter his thoughts into account (https://sketch.cloud/s/D9YpW)
- update [DON](https://gitlab.com/commonground/developer.overheid.nl/-/issues/194) & [Appstore](https://gitlab.com/commonground/appstore/appstore/-/issues/170) so they use these components
**:link: Reference links**
1. https://gitlab.com/commonground/appstore/appstore/issues/165
**:hammer_and_wrench: Technical solution:**
* [x] Chart what components are currently used in our apps
* [x] Remove all unused components
* [x] Update dependencies
* Add the following anew
* [x] Global styling (extendable)
* [x] Theming (extendable)
* [x] Typography (Discuss: in global styling or as components?)
* [ ] ~~Grid~~
* [x] Button
* [x] Create tests with [RTL](https://testing-library.com/docs/react-testing-library/)
| 8 |
7,128,869 | 31,037,261 |
2020-02-19 18:07:57.734
|
Add abstraction layer (txlog-api) between inway/outway and txlog-db
|
Currently inways and outways directly write via a Postgres interface to the txlog-db. It would be great to introduce a layer of abstraction here (txlog-api), so the database is more pluggable and security is enhanced.
Currently, only `ListRecords` is implemented.
:bangbang: This is a breaking change, since you need to specify an extra flag with the TXLog API address to the Inway & Outway. We can make this backwards compatible by supporting both a `TXLOG API` address and a `TXLOG Postgres DSN`. The current issue assumes we **WILL** make this backwards compatible.
**Todo**
- implement write call to create a single record
- update Outway and Inway
- support using both the txlog Postgres DSN flag and the txlog API flag
- attempt to use CQRS pattern?
| 8 |
7,128,869 | 30,983,776 |
2020-02-18 17:20:29.103
|
Display a warning in NLX inway/outway when permissions of the private key are too broad
|
For security reasons we would like to check if the key file is not too open. If they are, NLX should display a warning.
| 1 |
7,128,869 | 30,963,229 |
2020-02-18 10:34:12.431
|
Improve documentation on using the G1 root CA certificate
|
- Document to use the G1 root CA certificate instead of the use of an intermediate certificate.
| 1 |
7,128,869 | 30,962,610 |
2020-02-18 10:19:21.428
|
Display helpful error message when loading wrong certificate
|
### User story
*For components that load certificates: inway, outway, directory*
As a **developer**
<br>I want to **see why the provided certificate is not valid**
<br>so that **I know what the problem is**
### How to demonstrate
* Load certificate that is not signed by the provided root cert
* Should display, that the cert is only valid for '$ca_1', and not for provided '$ca_2'
**:hammer\_and\_wrench: Proposed technical solution**
* Read information about provided certificates and display it
| 2 |
7,128,869 | 30,961,957 |
2020-02-18 10:08:18.210
|
Add support for intermediate certificates in chain
|
As a **user**
<br>I want to **use a certificate that is signed by an intermediate certificate**
<br>so that **I can use PKI Overheid certificates**
---
Problem right now is that the eg. the inway only offers the leaf certificate in the TLS handshake. The other party, eg. the directory, can verify that certificate because the intermediate certificates are missing. The directory only has the root certificate.
**:movie_camera: How to demonstrate**
* -
* -
**:mag_right:(Test) scenarios**<br>
*Title*<BR>
Given demo env
When using cert without intermdiate
Then it should keep working
**:white\_check\_mark: Acceptance criteria**
1. Update NLX documentation about [going prod](https://docs.nlx.io/use-nlx/request-a-production-cert)
1. Unit Tests
1. NLX works with intermediate certificates between all NLX components
**:hammer\_and\_wrench: Proposed technical solution**
* Load all the certificates, including the intermediate, and use them during TLS handshake
* Use full chain cert files
* See: !1207
**:link: Reference links**
*
| 5 |
7,128,869 | 28,363,181 |
2019-12-12 12:42:48.040
|
Do not run acc build and deploy for tags
| null | 1 |
7,128,869 | 28,326,571 |
2019-12-11 18:30:02.937
|
Failing Go tests due to expired certificates
|
Our Go tests failed because the test certificates expired. Updated the test certificates with an expiry of 200 years, also added an upgrade script to update the certs when necessary.
| 2 |
7,128,869 | 28,279,267 |
2019-12-10 16:46:27.941
|
More granular authorization on inways using certificate pinning
|
### User story
As an **ops person**
<br>I want to **be able to authorize more granularly on inways**
<br>so that **I can improve the security of the NLX system in general**
NLX currently offers a way to whitelist organizations based on an organization name. This is really easy, but also introduces a large attack vector as every trusted certificate that is handed out for an organization can automatically be used in the context of NLX.
To allow more granular authorizations, we would like to introduce authorizations based on the `subjectPublicKeyInfo` field in the certificate. This has the following benefits:
- This restricts the certificates from a particular organization that can be used to setup NLX connections.
- This allows organizations to compartiment their security by having different security zones.
- This protects the NLX system of compromised CA's by pinning to specific public keys of certificates.
Of course this results in more administrative work by the inway administrator, but we can probably solve this partially by implementing good UX confirmation flows as described in #742. This could be a great follow-up story.
**:white\_check\_mark: Acceptance criteria**
1. The service-config.toml and config API are extended to support authorization based on public keys
1. We describe authorization based on the public key as the preferred way of authorization in production in the docs
1. When multiple authorization options are set, they all need to match before authorization is confirmed.
1. Remain backwards compatible and announce deprecation for the old way of authorizing in the service-config.toml.
1. Documentation about this feature is added to the docusaurus
**:wrench: Proposal**
*service-config.toml*
```toml
[services.postman-echo]
endpoint-url = "https://postman-echo.com/"
documentation-url = "https://docs.postman-echo.com/"
authorization-model = "whitelist"
[[services.postman-echo.authorization-whitelist]]
organization-name = "Gemeente Utrecht"
public-key = "sha256:GX6v14r7KP+TTQPzzmg3XgcaEVfcsCgUx6TfDCHTu5M="
[[services.postman-echo.authorization-whitelist]]
public-key = "sha256:/YAbDkjkJ6/2961u8Mun+Y8RVygDbSSoH5ZiSSdeCsU=" # Gemeente Amsterdam
[[services.postman-echo.authorization-whitelist]]
organization-name = "Gemeente Haarlem"
```
We could for example use a SHA-256 hash of the public key, similar to the [HTTP Public Key Pinning](https://developer.mozilla.org/en-US/docs/Web/HTTP/Public_Key_Pinning) (HPKP) header (thanks @hugoboos).
Example similar to HPKP:
```bash
openssl x509 -in org.crt -pubkey -noout | openssl pkey -pubin -outform der | openssl dgst -sha256 -binary | base64
GX6v14r7KP+TTQPzzmg3XgcaEVfcsCgUx6TfDCHTu5M=
```
Or skip the base64 step:
```bash
openssl x509 -in org.crt -pubkey | openssl pkey -pubin -outform der | openssl dgst -sha256
197eafd78afb28ff934d03f3ce68375e071a1157dcb02814c7a4df0c21d3bb93
```
| 5 |
7,128,869 | 28,024,204 |
2019-12-06 15:00:26.786
|
Restructure Helm charts and upgrade Helm to v3
|
As a **Developer**
<br>I want to **deploy using Helm v3**
<br>so that **I can use up to date tooling**
**:white\_check\_mark: Acceptance criteria**
1. The charts can be used with Helm 3
1. The charts can be used by ourselves for development / testing purposes, but also by users
1. The charts are structured per (set of) component(s)
1. It is possible to install multiple releases in the same Kubernetes namespace
1. Documentation is updated accordingly
1. A review app is limited to one Kubernetes namespace
**:pencil2: Proposed structure**
*Central*
- directory
- certportal
- docs
*Organization*
- inway
- outway
- insight
- management
Reference information
- Check out Helm repository of signals application
## Tasks
### Update to Helm v3
* [x] Update deployment Docker image
* [x] Update deployments
* [x] NLX deployment
* [x] AppsStore deployment
* [x] DON deployment
* [x] Migrate clusters
* [x] Review
* [x] Migrate releases
* [x] Remove Tiller
* [x] Delta
* [x] Migrate releases
* [x] cgn-prod
* [x] go-nlx-io-prod
* [x] hackathon-services
* [x] nlx-demo
* [x] nlx-acc
* [x] nlx-preprod-directory
* [x] nlx-prod-directory
* [x] nlx-io-prod
* [x] nlx-prod-demo
* [x] Remove Tiller
### Restructure charts
#### Core
- [x] Directory UI
- [x] Directory
- [x] Directory monitor
- [x] Docs
#### Organisation
- [x] Inway
- [x] Outway
- [x] Unsafe CA
- [x] Config API
- [x] Transaction log
- [x] Auth service
- [x] NLX Management
#### Demo
- [x] Insight API
- [x] Insight UI
- [x] Cert portal
- [x] Demo application
- [x] IRMA server
#### Support
- [x] Review page
| 8 |
7,128,869 | 27,394,081 |
2019-11-21 09:44:41.890
|
Migrate docs.nlx.io to Docusaurus 2
|
As a developer
<br>I want to use only one documentation tool
<br>so that I can fix bugs only once
### How to demonstrate
* Show a screenshot of the previous version
* Navigate to the new version
* Show that they look mostly the same
### (Test) scenarios
*Same look and feel*
Given the documentation site
When I visit it
Then looks and feels similar to the previous edition
*No external CSS and JS*
Given the documentation site
When it is loaded in the browser
Then it loads only resources from the documentation site itself and algolia
**:white\_check\_mark: Acceptance criteria**
1. docs.nlx.io is served using Docusaurus 2
1. It has the same look and feel as the Docusaurus 1 implementation
1. No CCS and JS files are loaded from external CDNs
1. CSP Rules allow for no external css or js files
**:hammer\_and\_wrench: Proposed technical solution**
* Follow the [migration documentation](https://docusaurus-2.netlify.com/docs/migrating-from-v1-to-v2/) for Docusaurus 2
| 2 |
7,128,869 | 27,058,303 |
2019-11-14 16:05:16.988
|
The support link in the menu is not working any more
|
*Expected behaviour*
* When I click on the Support button I get the support page
*Actual behaviour*
* I get a 404
**:clipboard: Steps to reproduce**
1. Go to nlx.io
1. Click on support
**:beetle: Cause**
* This is caused due to restructuring of the docs
---
| 1 |
7,128,869 | 27,046,096 |
2019-11-14 10:18:51.687
|
Display friendly error pages
|
### User story
As a **user**
<br>I want to **see a nice error page instead of the default nginx error page**
<br>so that **I know what is wrong and have options to further navigate the websie**
The [documentation website](https://docs.nlx.io) shows the default nginx error pages in case of an http error:
**:white\_check\_mark: Acceptance criteria**
1. add 404 custom page containing a user friendly error message
1. all 404 errors must redirect to this page
1. custom page must include NLX logo and a link back to docs.nlx.io root
1. the scope of this page is docs.nlx.io
**:hammer\_and\_wrench: Proposed technical solution**
* create new page in docusaurus which is not present in navigation
**:link: Reference links**
*
| 2 |
7,128,869 | 27,024,068 |
2019-11-13 16:33:58.973
|
Alter TTL for directory entries to 86.400 seconds
|
As a **maintainer**
<br>I want to **clean up the directory by removing off-line services**
<br>so that **the directory content stays relevant**
### How to demonstrate
*
*
### (Test) scenarios
*Title*<BR>
Given <BR>
When <BR>
Then <BR>
**:white\_check\_mark: Acceptance criteria**
1. Directory regularly cleans up offline services after being unreachable for set Time To Live (in seconds)
1. Set Time To Live to 1 day (86.400 seconds)
1. Documentation **(!)**
1. Tests
**:hammer\_and\_wrench: Proposed technical solution**
*
**:link: Reference links**
*
| 1 |
7,128,869 | 27,016,170 |
2019-11-13 13:53:52.027
|
Repair benchmark setup
|
Benchmark cluster shows 100% errors for transactions due to logs that fill up every few days.
We need to fix this 'future proof':
- Postgres dedicated (not in docker)
- Ansible roles to deploy correctly
| 3 |
7,128,869 | 26,931,883 |
2019-11-11 11:06:47.559
|
Service permissions are not propagated correctly when using config-api
| null | 1 |
7,128,869 | 26,844,542 |
2019-11-08 09:54:37.753
|
Display in- and outway versions in dashboard
|
**As a** maintainer
<br>**I want to** see which versions of the inway & outway are being used
<br>**so that** I can make better decisions about release management and communicate about them
---
### (Test) scenarios
*Title*<BR>
Given the stats api and version info available in the database<BR>
When I open the grafana dashboard<BR>
Then I see one line graph per environment with a counter of inways and on for the outways per version <BR>
**:white\_check\_mark: Acceptance criteria**
1. The NLX Grafana dashboard should show a graph with the version of the inways and outways being used.
1. One line per version representing usage over time (x axis = time, y axis = count)
1. Display a graph for the inways and one for the outways. Show both graphs for all environments (DEMO, pre-PROD & PROD).
For inspiration:
**:hammer\_and\_wrench: Proposed technical solution**
* use /stats endpoint to the inspection api to pull data to display/mine OR use influx idea of Hugo
**:link: Reference links**
*
| 3 |
7,128,869 | 26,701,458 |
2019-11-05 09:41:40.003
|
Store inway and outway version in use per environment
|
### User story
**As a** maintainer
<br>**I want to** store the versions of inways and outways per environment
<br>**so that** I can make better decisions about release management and communicate about them
---
### (Test) scenarios
*Title*<BR>
Given an inway<BR>
When the inway registers itself<BR>
Then the inway will send the version to the directory and that is stored in the database<BR>
Given an outway<BR>
When the outway fetches the inways from the directory<BR>
Then the outway will send the version to the directory and that is stored in the database<BR>
Given the /stats endpoint
When the /stats endpoint is requested
Then the raw data is returned to the client
**:white\_check\_mark: Acceptance criteria**
1. all inways and outways in demo, pre-prod and prod are added
1. there must be an endpoint which is used to get the version info
**:hammer\_and\_wrench: Proposed technical solution**
* for the inway we move the inspection of the version from the monitor to the registration
* for the outway we add it as parameter in the request to the directory
* we store both versions in the directory for the inways, we add the version of the outways in a new table
* add /stats endpoint to the inspection api. use this endpoint to add stats to the database and pull data to display/mine OR use influx idea
**:link: Reference links**
*
| 5 |
7,128,869 | 26,249,675 |
2019-10-23 20:09:51.582
|
Notify system administrators of updates and breaking changes
|
***Needs a new refinements since this will depend on #867***<br>
New:
* Generate notifications as all notifications in new NLX Management
* Allow users to configure how they want to be notified
---
**As a** system administrator
<br>**I want to** know when I need to update NLX and when breaking changes are introduced
<br>**so that** I can stay secure and up-to-date
**:white\_check\_mark: Acceptance criteria**
1. receivers are technical email addresses of inways
1. Is part of the pipeline, we send out a notification when a new release is made
1. must be a distinct list of email addresses (distinct over the three environments - demo, pre-prod and prod)
1. support@nlx.io is the from address
1. fixed email content with a variable latest version inclusive a remark how to unsubscribe
1. add unsubscribed mail addresses table (not in a public repro) which is used to remove those addresses from the mailinglist
**:hammer\_and\_wrench: Proposed technical solution**
* Implement mail job which fetches all inway email addresses and mails a template mail where version and change log link is added.
* auto fill mailing list with email addresses of inways (in the directory)
* its a new component within our cluster
* When we hand out certificates for the demo, pre-prod and prod environment we register one or more contacts
**Not in this story**
* addresses of outways
* for future reference mayne: subscription page, link to this page in the documentation in docusaurus
| 8 |
7,128,869 | 26,248,978 |
2019-10-23 19:32:06.256
|
Revisit the development workflow
|
We would like to revisit our current development workflow and make some changes to the CI:
* [x] Discuss the development workflow
* [x] Document the changes
* [x] Make changes to the CI
| 2 |
7,128,869 | 26,009,369 |
2019-10-16 15:53:53.585
|
Fix Let's Encrypt certificate limit on review cluster
|
We are hitting the Let's Encrypt domain rate-limit for nlx.io.
- We would like to move reviews to *.nlx.reviews to not impact nlx.io certificate handouts any more.
- We would like to request wildcard certificates for *.nlx.reviews.
| 2 |
7,128,869 | 25,914,364 |
2019-10-14 15:26:37.901
|
Add Review App URL overview page
|
**As a** reviewer and/or approver
<br>**I want to** be able to use an overview page with all relevant Review App urls
<br>**so that** I don't have to search for them in the deployment job console logs
---
Right now it's not easy to find the URL's necessary to review and / or approve the Review App deployment. Those are generated by Review App and can be found in de deployment job log.
**:white\_check\_mark: Acceptance criteria**
1. Create a release specific page with all Review App URL's that are served by Ingress
1. Deploy this page only in case of a Review App deployment
1. Starting a Review App from Merge Request page opens this new page in browser.
1. Don't spend any time on layout, just the URL's in order of deployment will do
**:hammer\_and\_wrench: Proposed technical solution**
*
**:link: Reference links**
* [Project Definition of Done](https://gitlab.com/commonground/nlx/nlx/blob/master/CONTRIBUTING.md#4-2-definition-of-done)
*
| 3 |
7,128,869 | 25,913,737 |
2019-10-14 15:05:47.461
|
Optimize build times by parallelisation and caching
|
**As a** maintainer
<br>**I want to** see my builds succeed quickly
<br>**so that** I can focus on coding
**:white\_check\_mark: Acceptance criteria**
1. Builds of dependencies are done in parallel
1. Builds of code that does not change are available from cache
1. Significant reduction of build times
**:hammer\_and\_wrench: Proposed technical solution**
* Use Kaniko https://skaffold.dev/docs/how-tos/builders/#dockerfile-in-cluster-with-kaniko
* Check if all Docker layers are cached correctly
**:link: Reference links**
* [Project Definition of Done](https://gitlab.com/commonground/nlx/nlx/blob/master/CONTRIBUTING.md#4-2-definition-of-done)
| 5 |
7,128,869 | 25,848,177 |
2019-10-11 11:06:18.850
|
Don't strip data-subjects in outway
|
In #694 we discovered that outways strip data-subject headers from calls. This means that the inway cannot log this header, resulting in inability to disclose logs via Insight API.
When fixing this, update the header docs as well.
*Expected behaviour*
* data-subject header should not be stripped
*Actual behaviour*
* data subject is stripped by outway
**:clipboard: Steps to reproduce**
1. (reproducibility is very important)
1.
1.
**:beetle: Cause**
* (if cause is known, details here)
* (if you can pinpoint a piece of code, link to line number)
**:mag: Details**
(Paste any relevant logs - please use code blocks to format console output, logs, and code)
(Add screenshots using `Attach a file`)
---
| 1 |
7,128,869 | 25,758,193 |
2019-10-09 10:55:35.090
|
Replace Hugo docs with Docusaurus
|
We'd like to improve our documentation as part of #505.
- replace hugo docs with Docusaurus (Helm charts, Docker images, Skaffold...)
- use documentation files as is in Docusaurus. we can cleanup/style in a next iteration
- add current content as part of the English language
- marketing pagina stays at is
- use default Docusaurus, but use the NLX colors
- keep the current links in the navbar
- tested in Chrome, Firefox and Safari
**For further reference**
- Can and how will we toggle between Linux, Mac OS & Windows environments?
See https://facebook.github.io/react-native/docs/getting-started
| 8 |
7,128,869 | 25,594,841 |
2019-10-03 16:50:35.176
|
Dashboard with NLX in numbers
|
**As a** maintainer
<br>**I want to** know how many organisations & services are active on the provided environments
<br>**so that** I have a measure of success and growth
**:white\_check\_mark: Acceptance criteria**
1. Grafana dashboard with graphs per indicator:
* Cumulative number of organisations over time
* Cumulative number of services over time
1. Above graphs for every provided environment (test, accept, preprod, prod, demo)
1. Interval is every 24-hours at 06:00
1. Above graphs all with x-axis covering the same date range: from date $first_organisation_in_production_environment until $today
1. Backups will be done as part of #777
---
Example
1.
**:hammer\_and\_wrench: Proposed technical solution**
* Fetch data using a cron job in Grafana / Influx DB node
* Fetch data using the public Directory API endpoints (/list-organizations, /list-services)
**:link: Reference links**
* https://directory.demo.nlx.io/api/directory/list-organizations
* https://directory.demo.nlx.io/api/directory/list-services
* [Project Definition of Done](https://gitlab.com/commonground/nlx/nlx/blob/master/CONTRIBUTING.md#4-2-definition-of-done)
* [Ansible roles for the benchmark cluster](https://gitlab.com/commonground/nlx/benchmark)
| 3 |
7,128,869 | 25,532,915 |
2019-10-02 08:29:06.783
|
Extend demo environment
|
**As a** potential user
<br>**I want to** see the most important concepts of NLX in action
<br>**so that** I can decide if I want to use NLX
---
Current demo shows Insight API concept with IRMA. We need more demo's, to be able to show every relevant concept in a permanent online environment.
For this, we extend the current demo UI with a navigation structure to browse through several demo's. Each demo
Let's start with an overview page that, to start with, contains just the insight demo.
**:white\_check\_mark: Acceptance criteria**
1. Permanent online Demo landing page explaining NLX at demo.nlx.io
1. Landing page offers the insight demo as an option, with room to expand
1. In a separate demo repository: https://gitlab.com/commonground/nlx/demo
1. Hosted in its own namespace, but using API's from the demo environment (demo's run with demo certs)
**:hammer\_and\_wrench: Proposed technical solution**
* A separate Helm chart with the name nlx-demo that provides all demo-related components
* This Helm chart is automatically deployed through `.gitlab-ci.yml`
* There are no separate environments for nlx-demo, only one production environment
| 8 |
7,128,869 | 25,297,062 |
2019-09-25 12:29:36.160
|
Set inway default authorization model to whitelist
|
**As an** user
<br>**I want** my inway to use the whitelist authorization model by default
<br>**so that** I don't accidentally publish private APIs to everyone on the NLX network.
**:white\_check\_mark: Acceptance criteria**
1. Inway uses whitelist authorization model by default
1.
**:hammer\_and\_wrench: Proposed technical solution**
*
**:link: Reference links**
* [Project Definition of Done](https://gitlab.com/commonground/nlx/nlx/blob/master/CONTRIBUTING.md#4-2-definition-of-done)
*
| 1 |
7,128,869 | 25,296,663 |
2019-09-25 12:21:51.248
|
Add information about support in docs
|
**As a** user of NLX
<br>**I want to** know how to get support
<br>**so that** I don't feel alone when I have a problem
**:white\_check\_mark: Acceptance criteria**
1. Update existing menu item Support
1. Add contact as subpage of Support
1. Add support@nlx.io e-mail to contact page
1. Add https://community.commonground.nl to contact page
1. Add https://gitlab.com/commonground/nlx/nlx to contact page
1. Move common errors to subpagina of support
1. Add link to Support section as part of the navbar (for the marketing website, directory ui, insight ui, docs)
**:hammer\_and\_wrench: Proposed technical solution**
*
**:link: Reference links**
* [Project Definition of Done](https://gitlab.com/commonground/nlx/nlx/blob/master/CONTRIBUTING.md#4-2-definition-of-done)
*
| 2 |
7,128,869 | 25,291,707 |
2019-09-25 09:47:52.996
|
Docs: how to implement whitelist authorization on inways
|
**As a** user
<br>**I want to** know how to create an authorization whitelist for my inway
<br>**so that** I can prevent unwanted access to my API's
**:white\_check\_mark: Acceptance criteria**
1. Description of how use the authorization whitelist functionality of the inway in the docs
1. Just the config via .toml, management UI documentation follows later
**:hammer\_and\_wrench: Proposed technical solution**
*
**:link: Reference links**
* [Project Definition of Done](https://gitlab.com/commonground/nlx/nlx/blob/master/CONTRIBUTING.md#4-2-definition-of-done)
*
| 2 |
7,128,869 | 25,101,470 |
2019-09-23 07:04:10.467
|
Replace IRMA server
|
**As a** maintainer
<br>**I want to** move our product to use the new IRMA server
<br>**so that** our demo keeps working
---
Note: related to #750 as the whole relevant code base will be moved there.
**:white\_check\_mark: Acceptance criteria**
1. Use the new IRMA server
1. Purge the old one from our code
---
We got notice from the IRMA team:
```
The irma_api_server is now officially deprecated, and to those still using it this is a last call to move away from the irma_api_server to its successor, the irma server command (see https://irma.app/docs/irma-server/). In particular this means the following:
- The irma_api_server is now no longer able to handle attribute based signatures due to a recent change in how the IRMA app produces these, and this will not be fixed, nor will any other feature or fix be applied to the irma_api_server.
- The privacybydesign/irma_api_server docker image will be deleted one month from now.
```
**:hammer\_and\_wrench: Proposed technical solution**
*
**:link: Reference links**
* [Project Definition of Done](https://gitlab.com/commonground/nlx/nlx/blob/master/CONTRIBUTING.md#4-2-definition-of-done)
*
| 2 |
7,128,869 | 24,944,922 |
2019-09-18 13:15:41.604
|
Add explanation about config-api and management UI in the NLX ecosystem to docs
|
**As an** aspiring NLX administrator
<br>**I want to** know what the config-api and management UI are
<br>**so that** I can use them to my benefit
**:white\_check\_mark: Acceptance criteria**
1. Documentation about what the config-api and management UI are
1. Documentation about how to install
**:hammer\_and\_wrench: Proposed technical solution**
*
**:link: Reference links**
* [Project Definition of Done](https://gitlab.com/commonground/nlx/nlx/blob/master/CONTRIBUTING.md#4-2-definition-of-done)
**Acceptance by:** Eelco
| 3 |
7,128,869 | 24,944,899 |
2019-09-18 13:15:09.576
|
Add explanation about IRMA / insight-api in the NLX ecosystem to docs
|
**As an** aspiring NLX administrator
<br>**I want to** know what IRMA and the insight-api are
<br>**so that** I can use them to my benefit
**:white\_check\_mark: Acceptance criteria**
1. Information about the role of IRMA and the insight-api in the NLX ecosystem
**:hammer\_and\_wrench: Proposed technical solution**
*
**:link: Reference links**
* [Project Definition of Done](https://gitlab.com/commonground/nlx/nlx/blob/master/CONTRIBUTING.md#4-2-definition-of-done)
*
**Acceptance by:** Eelco
| 3 |
7,128,869 | 24,942,396 |
2019-09-18 13:01:20.264
|
Add basic-auth to management ui in Traefik
|
**As a** developer/ops
<br>**I want to** restrict access to the management ui's of our voorbeeld organizations
<br>**so that** hackers have no joy
**:white\_check\_mark: Acceptance criteria**
1. Add basic auth to traefik Ingress
1. Sub-domain management.* requires authentication
**:hammer\_and\_wrench: Proposed technical solution**
Traefik ingress annotations:
```
ingress.kubernetes.io/auth-type: basic
ingress.kubernetes.io/auth-secret: "basic-auth"
```
Secret:
```
apiVersion: v1
kind: Secret
metadata:
name: basic-auth
namespace: <namespace where the ingress lives>
type: Opaque
data:
auth: #base64 encoded user:password as htpasswd
```
**:link: Reference links**
* [Project Definition of Done](https://gitlab.com/commonground/nlx/nlx/blob/master/CONTRIBUTING.md#4-2-definition-of-done)
**Acceptance by:** Geert
| 2 |
7,128,869 | 24,941,927 |
2019-09-18 12:47:29.335
|
Configure insight/irma in the management UI
|
**As a** user
<br>**I want to** configure insight/irma for my organization
<br>**so that** users can view log records that contain attributes they own.
**:white\_check\_mark: Acceptance criteria**
1. insight-api address is configurable in the management UI, values are saved to the config-api/etcd.
1. IRMA server address is configurable in the management UI, values are saved to the config-api/etcd.
1. Create new API call on directory-registration-api, to modify organization-level values such as irma-api, insight-api
1. Let config-api use new directory-registration-api method to update organization-level values.
**:hammer\_and\_wrench: Proposed technical solution**
*
**:link: Reference links**
* [Project Definition of Done](https://gitlab.com/commonground/nlx/nlx/blob/master/CONTRIBUTING.md#4-2-definition-of-done)
*
| 5 |
7,128,869 | 24,696,576 |
2019-09-11 16:10:21.655
|
Further reading subsection is empty
|
Further reading menu items shopws not the expected list of pages
*Expected behaviour*
* https://docs.nlx.io/further-reading/ should show a list of all child items
*Actual behaviour*
* Shows just 1 item
---
Depends on move to Gatsby, suggestion to do this first
**:clipboard: Steps to reproduce**
1. Go to https://docs.nlx.io/further-reading/
**:beetle: Cause**
* (if cause is known, details here)
* (if you can pinpoint a piece of code, link to line number)
**:mag: Details**
(Paste any relevant logs - please use code blocks to format console output, logs, and code)
(Add screenshots using `Attach a file`)
---
| 1 |
7,128,869 | 24,461,545 |
2019-09-04 13:16:24.807
|
Upgrade organization helm chart to start config-api and use it from inway
|
* Enable config-api for RDW
* Add k8s Job to reset etcd data and insert services into etcd using nlxctl
* Enable config-api for inway in RDW
| 3 |
7,128,869 | 24,460,960 |
2019-09-04 13:03:44.207
|
Move "Compliancy with EU regulations" page to compliancy section
|
**As a** PO
<br>**I want to** see the Compliancy with EU regulations page moved
<br>**so that** it doesn't distract from the clear documentation
---
**:white\_check\_mark: Acceptance criteria**
1. Move page to a new "Compliancy" section
1. Format .md to make the layout better readable (@spreeker made this already)
Current docs: https://docs.nlx.io/introduction/compliancy/
| 1 |
7,128,869 | 24,458,860 |
2019-09-04 12:01:26.137
|
Configure PKI-O EV certificates on www.nlx.io
|
**As a** end-user
<br>**I want to** have EV certificates on www.nlx.io
<br>**so that** it looks more secure
**:white\_check\_mark: Acceptance criteria**
1. EV certificates are configured on www.nlx.io
| 1 |
7,128,869 | 117,592,401 |
2022-10-26 09:32:22.439
|
Bug: OIDC token to big for cookie store
|
OIDC tokens can become larger then 4kb which is the maximum size for a item in the cookie store. Currently Gemeente Utrecht is reaching this limit. We should store a reference to the token in the cookie store and store the complete token in the database.
| 5 |
7,128,869 | 116,639,021 |
2022-10-11 08:23:10.334
|
Write delegation transaction log record in the consumer log too
|
The information is available in the DB & API. The info should be shown in the UI.
| 2 |
7,128,869 | 116,560,595 |
2022-10-10 08:23:45.037
|
Rework feedback when synchronisation of access request fails
|
**As a** _user_
<br>**I want** _goal_
<br>**so** _purpose_
The toasters showing an error when synchronizing access requests are currently too intrusive for the user.
**:white\_check\_mark: Acceptance criteria**
1. Do not poll the synchronization endpoint for the service detail pane (overview page only is sufficient)
1. Show a warning icon in the 'Access' column, when an organization is not reachable
1. Remove all toasters as feedback
1. In the service detail pane, display a warning icon and reason why synchonization failed
1. Ensure we only poll once every 3 seconds. Currently the poller starts multiple times when opening / closing the detail pane. Or opening / closing the directory overview page.
Voorstel feedback:
- Interne fout: raadpleeg eigen systeembeheerder
- Geen organisatie Inway bekend bij `<org x>`
- Organisatie Inway van `<org x >` niet bereikbaar
- Interne fout bij `<org x>`
**:link: Reference links**
1.
| 5 |
7,128,869 | 116,326,542 |
2022-10-05 14:14:44.923
|
Include transaction log in the E2E tests
|
We do not validate the creation of transaction logs in our E2E this has caused a bug like https://gitlab.com/commonground/nlx/nlx/-/issues/1630 to be possible.
In a perfect world we should test that:
1. The consuming org creates a transaction log record with the direction `out`
2. The providing org creates a transaction log record with the direction `in`
3. In case of delegation a transaction log record should contain "x on behalf of y"
| 5 |
7,128,869 | 115,760,724 |
2022-09-26 08:11:35.843
|
Document how to add a new role via the DB
|
- document that we might add permissions in the future and where to find these (link to go-file)
| 1 |
7,128,869 | 115,760,480 |
2022-09-26 08:06:58.437
|
Document how to add a user with role to Management
|
^ To start, choose a template
| 1 |
7,128,869 | 114,018,802 |
2022-08-29 10:58:40.416
|
Remove scheduler
|
**As a** user
<br>**I want** _goal_
<br>**so** _purpose_
_Chosen solution: NLX management takes over the job of the scheduler_
**:desktop_computer: How to demonstrate / e2e test(s):**
1. Create access request
2. Revoke access request
3. Sync access request state
4. Retrieve access proof
5. Add an order should still work
**:white\_check\_mark: Acceptance criteria**
1. Scheduler for access requests should be removed
1. Management UI, directory overview: should display checkmark if at least one Outway has access to the service (poll every 5 seconds)
1. Management UI, directory service detail: should display access status per Outway (poll every 5 seconds)
1. Update documentation in `technical-docs/sequence-diagrams`
**Technical notes**
- add API endpoint to synchronize the access requests.
- re-fetch service details if the synchronization was successful
- update E2E tests to execute the synchronize API endpoint if a request has been updated
- Move logic for sending an access request from the scheduler to the send call
**:link: Reference links**
1.
| 13 |
7,128,869 | 113,616,265 |
2022-08-22 09:02:29.187
|
Change implementation of NLX error messages
|
**As a** implementator of the NLX standard
<br>**I want** to know which error messages I should return
<br>**so** that I can implement the standard.
NLX added error codes and error messages to the components see issue https://gitlab.com/commonground/nlx/nlx/-/issues/1557. With the chosen implementation all the possible error codes are contained in a single file which makes it easy for anyone implementing the standard to get a overview of the error codes.
The actual error message is not part of the standard. The fields with extra information are.
This allows implementors to define error messages in their own language. But we ensure all relevant fields are provided by the standard.
Example: `permission denied, organization <ORG> or public key fingerprint <PUBLIC_KEY> is not allowed access.`
`<ORG>` and `<PUBLIC_KEY>` are defined in the standard required to be part of the message.
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. Move error messages to the same file as the error codes
**:link: Reference links**
1.
| 3 |
7,128,869 | 113,284,568 |
2022-08-15 11:18:29.241
|
OIDC: correctly handle different notations of the audience in the Access Token
|
Dex stores the audience as a string in the Access Token, Keycloak stores it as an array of strings. Both approaches are valid but the Management API can only handle the audience as a string. We should fix this.
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1.
**:link: Reference links**
1. https://github.com/coreos/go-oidc/blob/2d47dd95152744f41009de5797efe6cc07832a41/oidc/oidc.go#L475
| 2 |
7,128,869 | 111,845,845 |
2022-07-19 10:11:47.388
|
Update "Request a production certificate" section of the docs
|
The current Openssl command doesn't add a SAN to the CSR. Go has deprecated the CommonName field in the certificate and uses the SAN instead. Without a SAN go cannot validate the certificate.
New command (openssl 1.1.1 required):
```
openssl req -addext "subjectAltName = DNS:mijn.inway.nl" -utf8 -nodes -sha256 -newkey rsa:4096 -keyout org.key -out org.csr
```
| 1 |
7,128,869 | 111,765,099 |
2022-07-18 07:31:32.319
|
Remove Outway in NLX Management
|
**As a** NLX user
<br>**I want** to remove an Outway in NLX Management
<br>**so** that I can remove the second Outway entry that appears after I change the name of the Outway
This is feedback from Wego4it from the Hackathon.
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
**Technical proposal**
- add API endpoint to remove Outway
- Add remove button to Management UI
- Make sure only admin is allowed to perform this
- Add E2E test
**:link: Reference links**
1.
| 5 |
7,128,869 | 111,564,671 |
2022-07-13 08:48:11.952
|
Run txlog-api migrations in Helm chart
|
**As a** NLX user
<br>**I want** that txlog database migrations are done when I update my Kubernetes deployment to the latest version
<br>**so** that I can automate updating my deployment
Currently the txlog database migrations are done by manually running a job in Kuberenetes for which we provide a template( `technical-jobs/txlog-api-job-migrations.yaml`). This makes automating NLX deployment updates not as easy as it could be.
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
Technical solution:
Use the same approach as the Managment API; Include running the migrations in the txlog-api binary and add it as a init container to the txlog-api deployment chart.
**:white\_check\_mark: Acceptance criteria**
1.
**:link: Reference links**
1.
| 3 |
7,128,869 | 111,107,605 |
2022-07-04 08:31:01.491
|
Inject NLX headers for clients who do not include them
|
Not all clients are able to add the correct NLX http headers to the request to the Outway. although we prefer that the client provides them themselves, a client which can't be changed for whatever reason still needs to be able to work with NLX. Old vs new principle. So in NLX management a sort of general header config per service should be possible which adds the headers to the request.
The outway must have this general config in memory and apply it when necessary.
Add documentation page similar to the [url rewrite](https://docs.acc.nlx.io/reference-information/rewrite-base-url) in which we provide a example of a proxy that adds order headers to the request.
| 3 |
7,128,869 | 110,526,921 |
2022-06-22 07:19:42.344
|
Automate updating NLX version numbers in the example Helm value files
|
Docs: https://docs.nlx.io/try-nlx/helm/preparation
Use Semantic Release to update these values when tagging a new release.
We already have a script in place for the charts.
| 2 |
7,128,869 | 110,464,455 |
2022-06-21 09:57:09.740
|
Update Bitnami PostgreSQL chart in NLX Try Me
|
We currently use version 10.x.x of the bitnami postgres chart in the Try Me guide. Our guide is incompatible with the latest version of the bitnami postgres chart.
Release notes v11: https://docs.bitnami.com/kubernetes/infrastructure/postgresql/administration/upgrade/
Docs: https://docs.nlx.io/try-nlx/helm/postgresql
Check the NLX Haven add-on too.
Once the upgrade is completed, we should upgrade to future versions as part of the maintenance maister job.
| 5 |
7,128,869 | 110,283,848 |
2022-06-17 10:00:44.413
|
Add docs on re-writing OpenAPI spec base URLs
|
Add Nginx-template + Dockerimage file for the 'madrid-proxy'.
These have been added to the MR for the OGC demo, see https://gitlab.com/commonground/nlx/nlx/-/merge_requests/3680
1. Move relevant files to separate repo
2. Link to the repo in the docs as part of 'Reference information'
3. Done
| 2 |
7,128,869 | 110,283,793 |
2022-06-17 09:59:50.611
|
Test GRPC through NLX
|
Test locally using a local gRPC service. The result of this test should be a yes/no.
If no: Create a new issue with changes needed to make NLX support gRPC.
If yes: create movie to proof we support gRPC
**Out of scope:**
- add test to demo-environments
| 3 |
7,128,869 | 109,863,875 |
2022-06-09 15:20:13.222
|
Add fixed error codes to nlx error messages
|
We created a clear distinction between NLX errors and API errors. Now add fixed error codes to the error messages and document that fixed list of error codes with a description so that clients can process based on fixed codes in stead of possibly changing descriptions.
When the Outway/Inway returns a NLX specific error message (status code 540), the body of the response should contain both an error message and an error code. All the possible errors should be in 1 file so we have a clear overview.
| 8 |
7,128,869 | 108,681,215 |
2022-05-17 12:51:23.481
|
RBAC for NLX Management
|
**As a** NLX user
<br>**I want** a flexible RBAC system
<br>**so** that I am able to setup roles which match my organization structure
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. Actions which are possible with the Management API are translated to permissions
1. Assign permissions to the admin role
2. API endpoint should check if the endpoint can be used by the authenticated user/role
3. Enable passing credentials to NLX CTL (to pass to the API) (figure out if this should be a JWT or something else)
4. Basic auth should keep working
**Technical notes**
1. Assign a key to every API-endpoint / page in UI. These can then be assigned to roles. Eg. `permissions.service.add`.
**:link: Reference links**
1.
| 21 |
7,128,869 | 108,677,686 |
2022-05-17 11:52:48.476
|
Add more users to Dex
|
- currently, we only have 'admin'
- add extra users with the same role as 'admin'.
Add locally, for review and acc.
Add script to easily add new users (on the fly during the hackathon) (with admin or read-only role)
| 3 |
7,128,869 | 108,615,249 |
2022-05-16 13:43:52.945
|
Add OPA to demo setup
|
**As a** NLX promoter
<br>**I want** to be able to demo the OPA integration
<br>**so** that I can show people how the OPA intergration works
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. Add a client secret to the parkeerrechten admin interface
2. If a request fails because of OPA the error message in the UI should reflect that
3. Add links to `auth-opa/inway`and `auth-opa/outway` to the links page
**:link: Reference links**
1.
| 3 |
7,128,869 | 108,227,027 |
2022-05-09 08:32:07.973
|
Als gemeente Stijns wil ik alle inwoners van alle gemeenten kunnen zien
|
**As a** gemeente Stijns
<br>**I want** alle inwoners van alle gemeenten kunnen zien
<br>**so** we can use this during the hackathon
**:white\_check\_mark: Acceptance criteria**
- [x] replace current [demo basisregister-fictieve-personen API (Flask)](https://gitlab.com/commonground/nlx/demo/-/tree/main/basisregister-fictieve-personen) with a CRUD API (Golang)
- [x] introduce a database (simple scheme, put all data in a single column of type JSON)
- [x] the current API should still work (GET `/natuurlijke_personen`)
- [ ] introduce UI which lists all records from the fictieve-personen-api for the current municipality
---
**Out of scope**
- [ ] return the address of a persoon [in the same format as Haal Centraal](https://vng-realisatie.github.io/Haal-Centraal-BRP-bevragen/swagger-ui#/Ingeschreven%20Personen/GetIngeschrevenPersoon) (search for `verblijfplaats`)
**:link: Notities**
1. UI bij Stijns, API bij RvRD
| 5 |
7,128,869 | 106,573,454 |
2022-04-13 09:42:01.766
|
All errors which an Outway can receive when working with orders
|
^ To start, choose a template
| 8 |
7,128,869 | 106,572,528 |
2022-04-13 09:25:47.506
|
Make clear separation between NLX errors and API errors
|
Use the following HTTP status codes for the http endpoint on the NLX outway so that the apis calling the outway know that it's a NLX error instead of a error from the service itself.
- ~~502~~ 540 Bad Gateway - The server was acting as a gateway or proxy and received an invalid response from the upstream server.
- ~~504~~ 541 Gateway Timeout - The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.
- 542 Unauthorized -
~~We also could use the [`Proxy-Status`](https://tools.ietf.org/id/draft-ietf-httpbis-proxy-status-01.html#rfc.section.2) header, but its still a draft~~
Current possible errors:
- 400 Bad Request
- 401 Unauthorized
- 500 Internal Server Error
- 501 Not Implemented
- 503 Service Unavailable
Proposal:
540 - 559 reserved codes for NLX
- 540 Bad Request
- 541 Unauthorized
- 550 Internal Server Error
- 551 Not Implemented
- 553 Service Unavailable
Or just one reserved code:
- 540 NLX Gateway Error
| 5 |
7,128,869 | 106,442,361 |
2022-04-11 11:43:46.281
|
Use sqlc in the directory API
|
Use sqlc in the directory API so that the strucs needed to communicate with the database are auto-generated.
The same setup should be used as in the txlog-api.
| 8 |
7,128,869 | 105,817,045 |
2022-03-31 11:52:09.120
|
Upgrade React to v18
|
# TODO
- decouple management ui from shared eslint config
- decouple directory ui from shared eslint config
- decouple design system from shared eslint config
- upgrade design system to react v18
- upgrade management ui to react v18
- upgrade directory ui to react v18
---
[React v18](https://reactjs.org/blog/2022/03/29/react-v18.html) has been released, we should upgrade from v17 to v18.
However, there's a couple of projects tight together, which requires a coordinated effort in order to upgrade.
There's other dependencies that come along with this upgrade. Eg. `@testing-library/user-event`, `jest`, Create React App etc.
Projects that should upgrade first:
- https://gitlab.com/commonground/core/eslint-config
- https://gitlab.com/commonground/core/eslint-config-cra-standard-prettier
Then:
- https://gitlab.com/commonground/core/design-system
Then:
- https://gitlab.com/commonground/nlx/demo (contains multiple UIs)
- https://gitlab.com/commonground/nlx/nlx.io
- https://gitlab.com/commonground/nlx/nlx (contains multiple UIs)
| 8 |
7,128,869 | 104,991,312 |
2022-03-17 10:24:00.729
|
Enable configuring the Management API proxy address separately from the Organization Inway address
|
**As a** user
<br>**I want** to be able to use a single predictable port (`443` or `8443`) for my Inway and the management traffic going through the Inway
<br>**so** I can use my current setup using Otomi don't have to expose a custom port (port+1) for NLX
Currently, the Management API proxy address is derived from the Organization Inway address (port + 1).
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. When registering an Inway to the Directory, the Management API proxy address must be registered separately from the Organization Inway address
1. The management API proxy address flag should be required
1. The Inway data and management addresses stored in the directory should include portnumbers
1. I want to be able to expose both the Inway and the Inway Management API proxy on the same port and use domainnames to differentiate traffic. (eg. the Inway is registered at `https://my-inway.gemeente.nl` and the Management API Proxy is registered at `https://my-inway-proxy.gemeente.nl`)
1. Document extra flag in the commit message in such a way that it is clear to our users how they can use the new flag when upgrading (eg. clearly state the required upgrade path in the commit)
1. Ensure Try me is updated accordingly
**Proposed workflow**
1. Build this
1. Ensure its not a breaking change (keep track of time) (except for orders)
1. Release
Note: the estimation of this issue is without the work for making it non-breaking
**Remaining questions about breaking changes:**
- what if (existing) Inways do not register a management API Proxy address to the directory?
**:link: Reference links**
1.
| 8 |
7,128,869 | 104,860,713 |
2022-03-15 15:46:59.543
|
Implement auth plugin for the Outway
|
We have implemented the auth plugin in the Outway so that it can communicate with an OPA server. Implement the same plugin for the Inway and make Outway auth plugin production ready.
Include demo of OPA-server for the demo environment for the Parkeervergunningen Admin.
Enable stripping custom headers for requests from the Outway to the Inway. So the headers can be used by OPA but not intercepted by the Inway.
- [ ] add tests
- [ ] change docs
- [ ] include links to OPA-server to the links overview page
The same should happen for the Inway as part of #1502+
| 8 |
7,128,869 | 100,843,071 |
2022-01-18 13:50:30.441
|
Implement E2E-tests: access a service using an outway
|
**As a** user
<br>**I want** to access a service using an outway
<br>**so** ?
**:desktop_computer: How to demonstrate / e2e test(s):**
```gherkin
Scenario: Access a service using an outway
Given "Gemeente Stijns" has an outway
And "Gemeente Stijns" has access to "basis-register-fictieve-kentekens" of "RvRD"
When the outway of "Gemeente Stijns" calls the service "basis-register-fictieve-kentekens" from "RvRD"
Then "Gemeente Stijns" receives a successful response
```
**:white\_check\_mark: Acceptance criteria**
1. Implement the scenario as described above
**:link: Reference links**
1.
| 5 |
7,128,869 | 100,842,522 |
2022-01-18 13:42:34.845
|
Implement E2E-tests: use an order to access a service
|
**As a** user
<br>**I want** to use an order access a service from the Management UI
<br>**so** ?
**:desktop_computer: How to demonstrate / e2e test(s):**
```gherkin
Scenario: Use an order to access service
Given "Vergunningsoftware BV" has the default Outway running
And "Vergunningsoftware BV" has an active order with reference "order-ref-1" from "Gemeente Stijns" for service "basis-register-fictieve-kentekens" of "RvRD"
When the default Outway of "Vergunningsoftware BV" calls the service "basis-register-fictieve-kentekens" via the order of "Gemeente Stijns" with reference "order-ref-1"
Then "Vergunningsoftware BV" receives a successful response
```
**:white\_check\_mark: Acceptance criteria**
1. Implement the scenario as described above
1. Extract multiple gives from a single given
1. Update previously created scenarios to use the extracted givens
**:link: Reference links**
1.
| 5 |
7,128,869 | 99,083,487 |
2021-12-15 13:04:02.907
|
Self healing managmentAPI settings to directory
|
**As a** NLX participant
<br>**I want** the directory to be fully self healing for inways, outways and organizational information
<br>**so** when the directory is available again after failure, all the necessary information will be automatically added again and peace is restored in the land of NLX
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. organizational email address is send to the directory periodically
1. test scenario: remove a previously added email address and see if it will return again
1. same sync period as inways and outways
**:link: Reference links**
1.
| 5 |
7,128,869 | 98,670,554 |
2021-12-08 13:35:28.936
|
Add simple acceptance of NLX Terms & conditions to NLX management
|
**As a** NLX maintainer
<br>**I want** to be able to explicitly accept the NLX terms and conditions for this NLX ecosystem
<br>**so** I announce that I'm participating and accountable for my own organization
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. After login in, a user should see the Terms & Conditions (T&C) screen if they have not yet been approved for the organization of this Management API
1. When a user clicks 'Approve', this should be stored in the Management API
1. An audit log should be added when approving the T&C
1. The Directory API should accept an URL where the T&C are hosted
1. If this URL is not specified, the T&C should not be shown after authentication
1. Add E2E test for accepting T&C
1. This change should be communicated to NLX demo users
1. Update docs to include approving T&C
**:link: Reference links**
[Gebruiksvoorwaarden_NLX_maart_2020.pdf](/uploads/97a8a5a52b375353653138ecefe32491/Gebruiksvoorwaarden_NLX_maart_2020.pdf)
| 8 |
7,128,869 | 97,873,935 |
2021-11-24 11:34:16.232
|
Register organization email address
|
**As a** NLX user
<br>**I want** to know if there is a (breaking) change upcoming
<br>**so** that I can make sure my NLX setup keeps working
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. Add field for organization email address in NLX management
1. Show BIG modal in NLX management while the organization email address is empty
1. The organization email address should be stored in the directory
1. Describe the organization email field in the docs
**:link: Reference links**
1.
| 5 |
7,128,869 | 97,871,328 |
2021-11-24 11:01:15.862
|
Inway and Outway directory registration
|
**As a** NLX user
<br>**I want** see which organizations are using this NLX network
<br>**so** that I can determine the value of this NLX network for my organization.
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. Of an outway the following information is stored in the directory:
* Organization
* Outway name
* Version
* Created at
* Updated at
1. Add overview to directory UI
1. The overview displays a list of organizations participating on the NLX network
1. For each organization is displayed whether the organization offers services, consumes services or both.
column width:
- organization widest
- date only what's needed
- inways, outlays and services all the same width
**:link: Reference links**
1.
| 8 |
7,128,869 | 97,814,622 |
2021-11-23 14:27:52.026
|
Implement E2E scenarios
|
We have descripted several E2E scenarios using gherkin(https://cucumber.io/docs/gherkin/). These scenaro's should be implemented using the Cucumber framework.
We implemented the e2e scenario for creating the a service using Playwright but we decided we want to switch to Selenium because Selenium supports more browsers and offers support for running the test in paralel.
**:white\_check\_mark: Acceptance criteria**
1. Use Selenium
1. All Givens should use the management API directly instead of using the browser (recommented by Selenium because the browser is slow https://www.selenium.dev/documentation/test_practices/overview/)
1. Rewrite the Playwright implementation for "Create Service"(`testing/e2e/src/steps`) with Selenium
1. The test should run in the pipeline
1. Scenarios should run independend from eachother
1. Try to use our BrowserStack account to setup the tests with BrowserStack. If this does not work use Selenium images.
1. Update BrowserStack account to teamcore@vng.nl
1. Add browser image to the dev docker compose file so we can run the test localy.
```
browser:
image: selenium/standalone-chrome:4.1.1
shm_size: 2gb
ports:
- 4444:4444
```
The following scenario's should be implemented:
1. Delete an inway #1458
1. Unset organisation inway #1459
1. Create an order
1. Create a service
1. Delete a service #1460
An example of how to use Cucumber in combination with Selenium: https://github.com/browserstack/cucumber-js-browserstack. Please note this example uses BrowserStack which we won't use so any configuration regarding BrowserStack in this example can be ignored.
| 13 |
7,128,869 | 97,529,259 |
2021-11-18 08:14:35.799
|
Request access for a certificate
|
**As a** NLX user
<br>**I want** to select the certificate for which I want to request access
<br>**so** that specific certificate is included in the access request.
### How to handle the UI part of it
1. directory
- the quick action button is removed
- the status column only contains errors/warnings of one of underlaying the access requests
1. Service detailpage
1. Access request confirmation modal
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. If a organization does not have an outway, when opening the service detail view we should display a message something like "Please configure a outway to request access"
TODO:
1. [x] Include certificate in RequestAccess call
1. [x] Include certificate in GetAccessRequestState call
1. [x] Include certificate in GetAccessProof call
1. [x] Include certificate fingerprint in ListAccessGrantsForService call
1. [x] Include certificate fingerprint in ListIncomingAccessRequests call
1. [x] Include certificate fingerprint in ListOutgoingAccessRequests call
1. [x] For an access proof retrieve outways attached to a certificate
1. [x] Add certificate fingerprint to the outway database table
1. [x] Remove stacktrace from front-end
1. [x] The get service detail call should include a array of access requests and access grants instead of a single object
1. [x] Add access per certificate to orders on the back-end
1. [x] Update plantuml if necessary
1. [x] implement UI for listing outways with / without access
1. [x] implement UI for confirming requesting access
1. [x] display error message on directory if one of the access requests failed to send
1. [x] enable selecting outway / public key fingerprint with service when adding an order
1. [x] claim per service
1. [x] restrict selecting only a single Outway per service when creating an order (FE & API)
1. [ ] When in a eco system of old, pre-this-change versions, the eco system should continue to work
1. [x] Add extra Outway & certificate to dev, review and acc environment, so we can test this functionality
TODOs after merging the MR:
1. [ ] Update sequence diagrams for ordeders, see epic: &27+
**Test scenario for backwards compatibility**
> bestaande verbinding -> ene partij doet upgrade -> verbinding zou moeten blijven werken
```
// 1.
// review cluster weggooien
// alle deployments deployem voor 0.124
// access request maken & goedkeuren voor een service (gemeente stijns moet toegang hebben tot rvrd)
// order toevoegen en testen met curl (toegang tot rvrd delegeren naar vergunningsoftware)
// handmatig via k9s de directory updaten naar de review tag (2d6b6fb9) [van registry.nlx.reviews/commonground/nlx/nlx/nlxio/management-api:2d6b6fb9]
// controleren of we met het toegangsverzoek nog steeds toegang hegbben
// handmatig via k9s de rvrd updaten naar de review tag (2d6b6fb9) [van registry.nlx.reviews/commonground/nlx/nlx/nlxio/management-api:2d6b6fb9]
// toegang rechtstreeks & via order testen
// -> rechtstreekse toegang werkt. toegang via order faalt, de outway laat weten: 'nlx-inway: no access'. vermoedelijk omdat de structuur van de claim is aangepast.
// 2.
// review cluster weggooien
// alle deployments deployem voor 0.124
// access request maken & goedkeuren voor een service (gemeente stijns moet toegang hebben tot rvrd)
// order toevoegen en testen met curl (toegang tot rvrd delegeren naar vergunningsoftware)
// handmatig via k9s de directory updaten naar de review tag (2d6b6fb9) [van registry.nlx.reviews/commonground/nlx/nlx/nlxio/management-api:2d6b6fb9]
// controleren of we met het toegangsverzoek nog steeds toegang hegbben
// handmatig via k9s de gemeente stijns updaten naar de review tag (2d6b6fb9) [van registry.nlx.reviews/commonground/nlx/nlx/nlxio/management-api:2d6b6fb9]
// toegang rechtstreeks & via order testen
```
** Questions **
1. Can we keep the history of access requests/grants in the auditlog?
1. This will either be breaking change or we need to add if/else to most calls concerning access request/grants. If we decide to make this a breaking change it will only affect setups were the consumer and provider use a different version of NLX. This has been discussed during our review. Conduction was the only stakeholder with active NLX installations. Their response: Mag een breaking change zijn, dan is het duidelijk voor iedereen.
Alleen last van voor demodam, maar dat cluster ligt er momenteel uit, dus momenteel geen last van. Als het weer up gaat, dan zal Robert updates moeten doorvoeren.
1. Should requests between NLX components contain the version of the component? This information could be used to give our users more specific error messages.
**:link: Reference links**
| 21 |
7,128,869 | 97,356,866 |
2021-11-15 13:58:25.806
|
The organization owning the outway must be able to revoke access
|
It is not possible for a consumer to 'quit' or 'cancel' and ongoing access request. This potentially result in unnecessary activities (time spend by the owner of the service to assess the request) and when something is wrong at the owner side (the Inway) an access request with an error state will exists indefinitely (or at least until the owner fixes its problem). In order to have control over the access requests, it's necessary to be able to delete an request. Since you might delete a request which was actually already granted by the owner (the consumer just doesn't know that yet), it must also be possible to then cancel access from the consumer side of things. And if that's an option, then we just as easily can add that functionality to the UI making it explicitly possible.
Acceptance criteria:
- Add two buttons
- one for cancelling access as a consumer (when you already had access)
- must result in removing the access grant and maybe the proof -> figure it out
- showing the correct status for the access of the specific outway -> back to no access again with the messages/status access cancelled by 'Ingetrokken door [user]' including time stamp
- adding an audit log entry at the consumer side
- add the request access button
- one for canceling an access request as a consumer
- The cancelling access request button is only visible when at the supplier side the access is not granted (could be that the revoke action hasn't synchronized yet)
- remove the access request on both sides
- add audit record
- the status of the access of the specific outway must be No access including 'geannuleerd door [user]' and a timestamp
- add the request access button
- Add end to end tests
- Check and update documentation when necessary
TODO:
- [x] Make split in audit log between action start and action end
- [x] Add database integration tests
- [x] Update Management UI
- [x] Update Inway
- [ ] Syncer moet approved access state niet opniuew updaten
- [x] Sequence diagram
- [ ] Check if there are changes to convert GORM to sqlc
| 13 |
7,128,869 | 97,347,326 |
2021-11-15 12:53:31.441
|
Add serialnumber to CSR
|
As a NLX demo user
I want to be able to add the subject serialnumber to my CSR
So that I am able to predict my URL's
Acceptation Criteria
- [x] Add instructions on how to add a subject serial number in the docs
- [x] Add instructions on how to add subject serial number to an existing CSR
- [ ] Communicate this change to team Haven
- [x] The certportal should use the subject serial number in the CSR. If there is no subject serial number present, generate a random serial number
- [x] Verify that access requests still work after adding a subject serialnumber to an existing CSR. (DOES NOT WORK)
| 3 |
7,128,869 | 97,217,641 |
2021-11-12 08:06:54.619
|
Help user distinct own services from other services
|
**As a** NLX management user
<br>**I want** to have a clear distinction between my own services and those from others
<br>**so** I can easily find the service I'm looking for
**:desktop_computer: How to demonstrate / e2e test(s):**
1. Open NLX management
1. See button 'Mijn services'
1. Click on that button
1. See the page name 'Mijn services'
1. See button 'Directory'
1. Open Directory
1. See that the organization name of your own services is yellow. The others are the original color
**:white\_check\_mark: Acceptance criteria**
1. Services vertalen naar Mijn services
3. Color the organization name of my own services yellow in the directory
**:link: Reference links**
1.
| 2 |
7,128,869 | 96,502,327 |
2021-11-01 09:59:20.918
|
Remove an inway using the NLX management UI
|
**As a** system manager
<br>**I want** to be able to remove inways
<br>**so** that unused inways are no longer visible in NLX management
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. Add delete button to the Inway details screen
1. Ask for confirmation before deleting the inway
1. If the inway is still offering services display this in the confirmation dialog
1. If deleted inway is the organization inway and your are still offering service display the "No organization set" warning.
**:link: Reference links**
1.
| 5 |
7,128,869 | 96,246,525 |
2021-10-27 12:03:06.184
|
Refactor database layer to adapters in the directory API
|
**As a** NLX developer
<br>**I want** seperate my database logic from my business logic
<br>**so** that the project remains easy to maintain
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. Split database and business logic into seperate layers
1. Add postgres folder to adapter folder
**:link: Reference links**
1.
| 5 |
7,128,869 | 95,352,982 |
2021-10-13 11:52:38.191
|
Create workaround for Earthly
|
Currently, using `earthly +all` fails on Mac OS.
Create a Docker image with the prerequisites installed, which can be used to generate the same files.
| 3 |
7,128,869 | 95,351,162 |
2021-10-13 11:26:34.273
|
Add Parkeerrechten admin & viewer to ACC
|
So we can test the order flows on ACC and include these test scenario's as part of our definition of done.
Make sure the DNS-records for the demo-gemeente's are added.
Research if we can introduce a wildcard DNS-record for the domains.
| 5 |
7,128,869 | 95,345,193 |
2021-10-13 09:57:39.831
|
Do not require trailing slash for outway URLs
|
**As a** NLX user
<br>**I want** my request to work when I do not add a trailing slash
<br>**so** that I do not get confused when my URL seems correct but fails
requested by steven gort
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
1. `localhost/12345678901234567890/servicename` should work
1. `localhost/12345678901234567890/servicename/` should work
**:link: Reference links**
1.
| 3 |
7,128,869 | 94,524,020 |
2021-09-29 10:14:26.438
|
Create database fixtures using our own repository interfaces in the directory API
|
**As a** developer
<br>**I want** to add test data for our database integration tests using our own repository interfaces
<br>**so** that we do not depend on a specific database
Additional benefits:
* We can safely run our database integration tests in a transaction which allows us to run the test in parallel without running the directory inspection API and directory registration API tests in different databases.
* We no longer depend on an external tool to add our test data (https://github.com/go-testfixtures/testfixtures/)
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
2.
**:white\_check\_mark: Acceptance criteria**
1.
**:link: Reference links**
1.
| 8 |
7,128,869 | 94,446,055 |
2021-09-28 12:21:55.873
|
View latest transaction log records in NLX management
|
**As a** NLX maintainer
<br>**I want** to have access to the latest transaction logs
<br>**so** I can see what's currently going on
**:desktop_computer: How to demonstrate / e2e test(s):**
1.
**:white\_check\_mark: Acceptance criteria**
- [x] Enable getting the transaction log via the application-overview page (add link per organization)
- [x] Transaction log API returns records as JSON / GRPC
- [x] Add connection string to the managementAPI as a flag
- [x] The page should tell the user that he/she didnt activate the transaction logging
- [x] Show the latest 100 records in NLX management (Make sure this is communicated to the user -> if easy peasy cheap: then use the variable containing the limit... otherwise just type it in the text*)
- [ ] Change the transaction documentation
- [x] Change the management API documentation in the guide
- [x] Change the current Logs icon in the UI to: Audit log
- [x] Add new logs icon with the text: Transactions log
- [x] Use internal certs as authorization on the API
* text above: De laatste 100 records in de transaction log van jouw in- en outways
**row must resemble:**
tijd | binnenkomend van | organisatie | service
tijd | uitgaand naar | organisatie | service
**:link: Reference links**
1. https://links.acc.nlx.io
| 13 |
7,128,869 | 93,711,089 |
2021-09-15 11:55:38.611
|
Document the usage of subject serialnumber
|
Request a demo certificate
* describe that the serialnumber is used by NLX as the organization identifier
Provide an API
* update URLs used in `Quering your own API's` section
Request a production certifiate
* describe that the serialnumber is used by NLX as the organization identifier
_For Subject.SerialNumber specification, see https://gitlab.com/commonground/nlx/nlx/-/issues/1376_
| 2 |
7,128,869 | 93,711,034 |
2021-09-15 11:54:37.055
|
Use subject serialnumber in the Inspection API, Management API, Inway and Outway
|
Directory Inspection API + Management API + Inway + Outway
**Acceptatie criteria**
- [ ] The directory inspection API returns serialnumber in the ListServices call
- [ ] Outway should use serialnumber to find services
- [ ] The serial number should be added to access request and orders (later on we will display these in the UI)
Directory-inspection-api
* return serialnumber in list services call
Management-api
* add serialnumber to access_requests_incoming
* add serialnumber to access_requests_outgoing
* user serialnumber as organization identifier in access grants
* use serialnumber as delagatee in orders
* use serialnumber in order_services
Management API & UI
* Replace the inputfield of organization name with subject serialnumber when creating an order
* Use subject serialnumber to create an access request
* add serialnumber to auditlogs
Inway
* store serialnumber in TX log
* the check if there is an access grant for an organization should happen on serialnumber instead of organizationname
* the check if a received claim is owned by the sender should happen on serialnumber instead of organizationname
Outway
* parse serialnumber from url
* use serialnumber as identifier in the hashmap for services
* store serialnumber in TX log
* use serialnumber to retrieve order token instead of organization name
* use serialnumber as identifier in the hashmap for delegation claims
| 13 |
7,128,869 | 93,710,882 |
2021-09-15 11:52:47.508
|
Use subject serialnumber in the directory registration API
|
Directory Registration API
Directory-registration-api
* store serialnumber in register service call
**Acceptatie criteria**
- [ ] The directory will keep storing the organizationname and add the serialnumber
| 5 |
7,128,869 | 93,710,799 |
2021-09-15 11:51:26.834
|
Add database integration tests for the inspection API
|
* Add database integration tests
* Do not extract domain from the database layer
This preparation is needed for when we're introducing the subject serialnumber in the management API.
| 3 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.