Skip to content

Commit

Permalink
PIA Release 1.39.0
Browse files Browse the repository at this point in the history
  • Loading branch information
hzi-pia-ci committed Sep 30, 2024
1 parent 30c397e commit 1b7bd69
Show file tree
Hide file tree
Showing 207 changed files with 8,700 additions and 4,263 deletions.
172 changes: 128 additions & 44 deletions THIRD_PARTY_LICENSES
Original file line number Diff line number Diff line change
Expand Up @@ -42573,7 +42573,7 @@ Apache License
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2015-2020 Apache Cordova
Copyright 2015-2024 Apache Cordova

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -77087,6 +77087,74 @@ The above copyright notice and this permission notice shall be included in all c

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

################################################################################
# package-json-from-dist (BlueOak-1.0.0) [https://github.com/isaacs/package-json-from-dist]
################################################################################

All packages under `src/` are licensed according to the terms in
their respective `LICENSE` or `LICENSE.md` files.

The remainder of this project is licensed under the Blue Oak
Model License, as follows:

-----

# Blue Oak Model License

Version 1.0.0

## Purpose

This license gives everyone as much permission to work with
this software as possible, while protecting contributors
from liability.

## Acceptance

In order to receive this license, you must agree to its
rules. The rules of this license are both obligations
under that agreement and conditions to your license.
You must not do anything with this software that triggers
a rule that you cannot or will not follow.

## Copyright

Each contributor licenses you to do everything with this
software that would otherwise infringe that contributor's
copyright in it.

## Notices

You must ensure that everyone who gets a copy of
any part of this software from you, with or without
changes, also gets the text of this license or a link to
<https://blueoakcouncil.org/license/1.0.0>.

## Excuse

If anyone notifies you in writing that you have not
complied with [Notices](#notices), you can keep your
license by taking all practical steps to comply within 30
days after the notice. If you do not do so, your license
ends immediately.

## Patent

Each contributor licenses you to do everything with this
software that would otherwise infringe any patent claims
they can license or become able to license.

## Reliability

No contributor can revoke this license.

## No Liability

***As far as the law allows, this software comes as is,
without any warranty or condition, and no contributor
will be liable to anyone for any damages related to this
software or this license, under any kind of legal claim.***

################################################################################
# packet-reader (MIT) [https://github.com/brianc/node-packet-reader]
################################################################################
Expand Down Expand Up @@ -79668,30 +79736,31 @@ THE SOFTWARE.

A parser for [.properties](http://en.wikipedia.org/wiki/.properties) files written in javascript. Properties files store key-value pairs. They are typically used for configuration and internationalization in Java applications as well as in Actionscript projects. Here's an example of the format:

# You are reading the ".properties" entry.
! The exclamation mark can also mark text as comments.
website = http://en.wikipedia.org/
language = English
# The backslash below tells the application to continue reading
# the value onto the next line.
message = Welcome to \
Wikipedia!
# Add spaces to the key
key\ with\ spaces = This is the value that could be looked up with the key "key with spaces".
# Unicode
tab : \u0009
```properties
# You are reading the ".properties" entry.
! The exclamation mark can also mark text as comments.
website = http://en.wikipedia.org/
language = English
# The backslash below tells the application to continue reading
# the value onto the next line.
message = Welcome to \
Wikipedia!
# Add spaces to the key
key\ with\ spaces = This is the value that could be looked up with the key "key with spaces".
# Unicode
tab : \u0009
```
*(taken from [Wikipedia](http://en.wikipedia.org/wiki/.properties#Format))*

Currently works with any version of node.js.

## The API

- `parse(text)`: Parses `text` into key-value pairs. Returns an object containing the key-value pairs.
- `read(path[, callback])`: Opens the file specified by `path` and calls `parse` on its content. If the optional `callback` parameter is provided, the result is then passed to it as the second parameter. If an error occurs, the error object is passed to `callback` as the first parameter. If `callback` is not provided, the file specified by `path` is synchronously read and calls `parse` on its contents. The resulting object is immediately returned.
- `createEditor([path][, options][, callback]])`: If neither `path` or `callback` are provided an empty editor object is returned synchronously. If only `path` is provided, the file specified by `path` is synchronously read and parsed. An editor object with the results in then immediately returned. If both `path` and `callback` are provided, the file specified by `path` is read and parsed asynchronously. An editor object with the results are then passed to `callback` as the second parameters. If an error occurs, the error object is passed to `callback` as the first parameter. The following options are supported:
- `options.separator`: The character used to separate key/values. Defaults to "=".
- `options.path`: Treated the same way as the optional `path` argument. If both are provided the arguement wins.
- `options.callback`: Treated the same way as the optional `callback` parameter. If both are provided the arguement wins.
- `options.path`: Treated the same way as the optional `path` argument. If both are provided the argument wins.
- `options.callback`: Treated the same way as the optional `callback` parameter. If both are provided the argument wins.
- `editorFromString(text[, options])`: creates an `Editor` object from the text string passed in
- `Editor`: The editor object is returned by `createEditor`. Has the following API:
- `get(key)`: Returns the value currently associated with `key`.
- `set(key, [value[, comment]])`: Associates `key` with `value`. An optional comment can be provided. If `value` is not specified or is `null`, then `key` is unset.
Expand All @@ -79700,20 +79769,26 @@ Currently works with any version of node.js.
- `addHeadComment`: Added a comment to the head of the file.
- `toString`: Returns the string representation of this properties editor object. This string will be written to a file if `save` is called.

## Getting node-properties-parser
## Getting properties-parser

The easiest way to get node-properties-parser is with [npm](http://npmjs.org/):
The easiest way to get node-properties-parser is with [npm](https://www.npmjs.com/package/properties-parser):

npm install properties-parser

Alternatively you can clone this git repository:

git://github.com/xavi-/node-properties-parser.git

For type definitions use [npm](https://www.npmjs.com/package/@types/properties-parser):

npm install --save @types/properties-parser

## Developed by

* Xavi Ramirez

## License

This project is released under [The MIT License](http://www.opensource.org/licenses/mit-license.php).

################################################################################
Expand Down Expand Up @@ -93488,31 +93563,6 @@ The above copyright notice and this permission notice shall be included in all c

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

################################################################################
# string.prototype.codepointat (MIT) [https://github.com/mathiasbynens/String.prototype.codePointAt]
################################################################################

Copyright Mathias Bynens <https://mathiasbynens.be/>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

################################################################################
# string.prototype.trim (MIT) [https://github.com/es-shims/String.prototype.trim]
################################################################################
Expand Down Expand Up @@ -96742,6 +96792,40 @@ TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

################################################################################
# uglify-js (BSD-2-Clause) [https://github.com/mishoo/UglifyJS]
################################################################################

UglifyJS is released under the BSD license:

Copyright 2012-2024 (c) Mihai Bazon <[email protected]>

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

* Redistributions of source code must retain the above
copyright notice, this list of conditions and the following
disclaimer.

* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials
provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER “AS IS” AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

################################################################################
# uid-number (ISC) [https://github.com/isaacs/uid-number]
################################################################################
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.38.1
1.39.0
1 change: 1 addition & 0 deletions ci/generated.yml
Original file line number Diff line number Diff line change
Expand Up @@ -139,5 +139,6 @@
- psa.utils.repo-tool
openapi:
- psa.server.eventhistory
- psa.service.personaldataservice
- psa.service.questionnaireservice
- psa.service.userservice
7 changes: 6 additions & 1 deletion docs/adding-tsoa-to-an-existing-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,12 @@
"yaml": true,
"basePath": "/api/v1",
"version": "1",
"tags": [],
"tags": [
{
"name": "Example Service",
"description": "Operations related to the example services domain."
}
],
"securityDefinitions": {
"jwt-public": {
"type": "oauth2",
Expand Down
20 changes: 19 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Configuration

PIA is designed to be configurable for different environments and use cases. See [Options](#options) for a list of all
possible configuration values.

You can also use the [interactive bash script](deployment.md#preparation), which will ask for each configuration value and
generate an overlay and adjacent files. If you already have a custom overlay, but want to change or extend your
configuration, create a separate overlay and compare your own version with the newly generated one.

### Customizing header logo

You can customize the header logo of your PIA instance. This is not done by setting a configuration option but by
customizing your overlay and providing the necessary logo files.
This will be done for you when using the [interactive bash script](deployment.md#preparation).

See the [deployment documentation creating and configuring your own logo](deployment.md#customizing-header-logo) for
further information.

## Options

PIA is designed to be configurable for different environments and use cases. These are the available configuration options:

| key | description | possible values | required |
Expand Down Expand Up @@ -29,4 +47,4 @@ PIA is designed to be configurable for different environments and use cases. The
| `modysIdentifierTypeId` | Identifier type id to be used to fetch participant data from external MODYS | number | no |
| `modysRequestConcurrency` | Count of maximum concurrend requests towards an external MODYS instance | number | no |

See the [deployment documentation](../docs/deployment.md#deploying-for-the-first-time) to learn more about how to actually set up the configuration.
See the [deployment documentation](deployment.md) to learn more about how to actually set up the configuration.
21 changes: 21 additions & 0 deletions docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,27 @@ Execute all commands on your deployment machine.

Now your deployment configuration is ready to be deployed 🎉

## Customizing header logo

> ⚠️ The logo file must be a JPEG image with a maximum size of 100 KB. Keep it as small as possible.

If you did not specify a logo file during creating your custom overlay, you can add the necessary configuration and files manually:

1. Name your logo file `logo.jpeg` and copy it to `k8s/deployment/overlays/<your-deployment-name>`.
2. Create a compressed version: `gzip < logo.jpeg > logo.jpeg.gz`
3. Add the following configuration to your overlays `kustomization.yaml` file:

```yaml
components:
- ../../components/customize-logo
configMapGenerator:
- name: pia-logo
files:
- ./logo.jpeg
- ./logo.jpeg.gz
```

## Deploying

Deploy PIA to your cluster by running the following command from the `k8s` directory (while replacing `<your-deployment-name>` with the name of your deployment directory):
Expand Down
Loading

0 comments on commit 1b7bd69

Please sign in to comment.