Wych Register for AU Data Holder Testing
Table of Contents
This Wych register for AU Data Holder Testing (Register) represents the ACCC’s AU register service, this version has been designed to support Data Holder testing and so while on an API level it is similar to the ACCC’s service it is fundamentally different in a number of key ways.
The register can be shared by multiple Data Holder instance and multple Data Holder Tester instances. The main consideration here is that the Data Holders must be able to talk to the Register and vise-versa and the Register must be co-located with the Tester instances as they share a configuration data store.
Requirements #
The register requires a PostgreSQL 14+ relational database. Registry can utilise the same PostgreSQL service as the other non-production service but requires a separate schema. The schema can be set in the search path to faciliate easy of connection.
The PostgreSQL jdbc syntax is:
jdbc:postgresql://[host]:[port]/[db-name]?currentSchema=[db-schema]
This can be organised as a database per app or a schema per database.
jdbc:postgresql://localhost:5432/au-register?currentSchema=public
jdbc:postgresql://localhost:5432/testing?currentSchema=au-register
Repository #
The register can be pulled from the following repository. Check Changelog for the latest version.
docker pull wychaustralia.azurecr.io/au-register:[version]
Docker #
For the register to start you will need to set the following properties. If you are setting these as environment variables then use the UPPERCASE and replace . (dot) with _ (underscore).
Config #
Key | Description |
---|---|
WYCH_BASE_URL | The URL of this application, a self reference e.g. https://register.host.tld |
WYCH_REGISTER_AUTH_URL | The URL of register auth application, no trailing slash. e.g. https://auth.register.host.tld |
WYCH_DATASOURCE_JDBC_URL | The database JDBC URL in the form jdbc:postgresql://{{host}}}:{{port}}}/{{db_name}}} |
WYCH_DATASOURCE_USERNAME | The database users name |
WYCH_DATASOURCE_PASSWORD | The database users password |
IT_WYCH_KEYSTORE_LOCATION | The location of the keys store. Defaults to config/authority.keystore |
IT_WYCH_KEYSTORE_PASSWORD | The password for the key store and the certificate keypair Defaults to password |
SSL_CERTIFICATE_NAME | The name of the certificate to load, this defaults to authority |
While the first three properties may be obvious the forth will point to Register Auth service. This is the url of the service and this enables the service to discover and talk to each other.
Compose #
Here is a sample docker compose - this sets up the required DB and configures the Register service.
|
|
Changelog #
tag | changelog | digest |
---|---|---|
1.9.0 | Making certificate id configurable. New config value ssl.certificate.name has been introduced. If omitted will default to certificate named authority . |
032d33 |
1.8.0 | Embedding the keystore | 6d9917 |
1.7.0 | Providing default keystore | 988791 |
1.6.0 | Reducing config requirements | 7b32b2 |
1.5.0 | {{< alert >}} Bugfix issues caused by compatibility mode, requires au-dataholder-tester >=1.55.0. {{< /alert >}} | e892f1 |
1.4.0 | Moving native image to compatibility mode for x86, x64 and ARM architectures | 6f5c94 |
1.3.0 | Adding new endpoints for multi-tenancy management | c0d889 |
1.2.0 | Expanding tracing | c1ab95 |
1.1.0 | Enabling advanced messaging | 493d04 |
1.0.20 | Maintenance release, patching dependencies | cdeb33 |
1.0.19 | Standardiseing API and security modules | e96047 |
1.0.18 | Extending automated test coverage | 1bc7d1 |
1.0.17 | Simplifying application root | c2719a |
1.0.16 | Enabling certificate generation and signing capabilities | 1d2f49 |
1.0.15 | Security patching and updates | a6e5ad |
1.0.14 | Enabling TLS support | fa844e |
1.0.13 | Release alignment | 898e86 |
1.0.12 | Configuration bug fixes | a16e24 |
1.0.11 | Simplifying and standardising config keys | 9c94b0 |
1.0.10 | Enabling external release | 8f00cb |