Skip to content

Commit

Permalink
Release v12.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
treydock committed Jul 12, 2024
1 parent 1e252e5 commit 8efef3f
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 29 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).

## [v12.0.0](https://github.com/treydock/puppet-module-keycloak/tree/v12.0.0) (2024-07-12)

[Full Changelog](https://github.com/treydock/puppet-module-keycloak/compare/v11.2.0...v12.0.0)

### Changed

- BREAKING: Support Keycloak 25 [\#316](https://github.com/treydock/puppet-module-keycloak/pull/316) ([treydock](https://github.com/treydock))
- Implement webauthn extra origins & Raise KeyCloak version to 24.0.5 in acceptance tests [\#313](https://github.com/treydock/puppet-module-keycloak/pull/313) ([TuningYourCode](https://github.com/TuningYourCode))

### Added

- Implement password policy property [\#315](https://github.com/treydock/puppet-module-keycloak/pull/315) ([TuningYourCode](https://github.com/TuningYourCode))

## [v11.2.0](https://github.com/treydock/puppet-module-keycloak/tree/v11.2.0) (2024-06-19)

[Full Changelog](https://github.com/treydock/puppet-module-keycloak/compare/v11.1.1...v11.2.0)
Expand Down
65 changes: 37 additions & 28 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ Data type: `String`

Version of Keycloak to install and manage.

Default value: `'22.0.0'`
Default value: `'25.0.1'`

##### <a name="-keycloak--package_url"></a>`package_url`

Expand Down Expand Up @@ -230,7 +230,7 @@ Data type: `String[1]`

Java package name, only used when `java_declare_method` is `class`

Default value: `'java-17-openjdk-devel'`
Default value: `'java-21-openjdk-devel'`

##### <a name="-keycloak--java_home"></a>`java_home`

Expand All @@ -239,23 +239,23 @@ Data type: `Stdlib::Absolutepath`
Java home path. This value is used when `java_declare_method` is `class`
as well as to set JAVA_HOME environment variable for the Keycloak service.

Default value: `'/usr/lib/jvm/java-17-openjdk'`
Default value: `'/usr/lib/jvm/java-21-openjdk'`

##### <a name="-keycloak--java_alternative_path"></a>`java_alternative_path`

Data type: `Stdlib::Absolutepath`

Java alternative path, only used when `java_declare_method` is `class`

Default value: `'/usr/lib/jvm/java-17-openjdk/bin/java'`
Default value: `'/usr/lib/jvm/java-21-openjdk/bin/java'`

##### <a name="-keycloak--java_alternative"></a>`java_alternative`

Data type: `String[1]`

Java alternative, only used when `java_declare_method` is `class`

Default value: `'/usr/lib/jvm/java-17-openjdk/bin/java'`
Default value: `'/usr/lib/jvm/java-21-openjdk/bin/java'`

##### <a name="-keycloak--service_name"></a>`service_name`

Expand Down Expand Up @@ -358,7 +358,7 @@ Default value: `{}`

##### <a name="-keycloak--hostname"></a>`hostname`

Data type: `Variant[Stdlib::Host, Enum['unset','UNSET']]`
Data type: `Variant[Stdlib::Host, Stdlib::HTTPUrl, Stdlib::HTTPSUrl, Enum['unset','UNSET']]`

hostname to set in keycloak.conf
Set to `unset` or `UNSET` to not define this in keycloak.conf
Expand Down Expand Up @@ -1729,8 +1729,6 @@ Default value: `true`

webOrigins

Default value: `[]`

#### Parameters

The following parameters are available in the `keycloak_client` type.
Expand Down Expand Up @@ -2081,8 +2079,8 @@ Manage a Keycloak flow
**Autorequires**
* `keycloak_realm` defined for `realm` parameter
* `keycloak_flow` of `flow_alias` if `top_level=false`
* `keycloak_flow` of `flow_alias` if other `index` is lower and if `top_level=false`
* `keycloak_flow_execution` if `flow_alias` is the same and other `index` is lower and if `top_level=false`
* `keycloak_flow` of `flow_alias` if other `priority` is lower and if `top_level=false`
* `keycloak_flow_execution` if `flow_alias` is the same and other `priority` is lower and if `top_level=false`

#### Examples

Expand All @@ -2100,7 +2098,7 @@ keycloak_flow { 'browser-with-duo':
```puppet
keycloak_flow { 'form-browser-with-duo under browser-with-duo on test':
ensure => 'present',
index => 2,
priority => 20,
requirement => 'ALTERNATIVE',
top_level => false,
}
Expand All @@ -2122,9 +2120,9 @@ The basic property that the resource should be in.

Default value: `present`

##### `index`
##### `priority`

execution index, only applied to top_level=false, required for top_level=false
execution priority, only applied to top_level=false, required for top_level=false

##### `requirement`

Expand Down Expand Up @@ -2200,8 +2198,8 @@ Manage a Keycloak flow
**Autorequires**
* `keycloak_realm` defined for `realm` parameter
* `keycloak_flow` of value defined for `flow_alias`
* `keycloak_flow` if they share same `flow_alias` value and the other resource `index` is lower
* `keycloak_flow_execution` if `flow_alias` is the same and other `index` is lower
* `keycloak_flow` if they share same `flow_alias` value and the other resource `priority` is lower
* `keycloak_flow_execution` if `flow_alias` is the same and other `priority` is lower

#### Examples

Expand All @@ -2212,7 +2210,7 @@ keycloak_flow_execution { 'auth-cookie under browser-with-duo on test':
ensure => 'present',
configurable => false,
display_name => 'Cookie',
index => 0,
priority => 10,
requirement => 'ALTERNATIVE',
}
```
Expand All @@ -2224,7 +2222,7 @@ keycloak_flow_execution { 'auth-username-password-form under form-browser-with-d
ensure => 'present',
configurable => false,
display_name => 'Username Password Form',
index => 0,
priority => 10,
requirement => 'REQUIRED',
}
```
Expand All @@ -2245,7 +2243,7 @@ keycloak_flow_execution { 'duo-mfa-authenticator under form-browser-with-duo on
"duomfa.groups" => "duo"
},
requirement => 'REQUIRED',
index => 1,
priority => 20,
}
```

Expand All @@ -2271,9 +2269,9 @@ The basic property that the resource should be in.

Default value: `present`

##### `index`
##### `priority`

execution index
execution priority

##### `requirement`

Expand Down Expand Up @@ -3497,6 +3495,10 @@ otpPolicyType

Default value: `totp`

##### `password_policy`

passwordPolicy

##### `permanent_lockout`

Valid values: `true`, `false`
Expand Down Expand Up @@ -3693,6 +3695,12 @@ webAuthnPolicyCreateTimeout

Default value: `0`

##### `web_authn_policy_extra_origins`

webAuthnPolicyExtraOrigins

Default value: `[]`

##### `web_authn_policy_passwordless_acceptable_aaguids`

webAuthnPolicyPasswordlessAcceptableAaguids
Expand Down Expand Up @@ -3729,6 +3737,12 @@ webAuthnPolicyPasswordlessCreateTimeout

Default value: `0`

##### `web_authn_policy_passwordless_extra_origins`

webAuthnPolicyPasswordlessExtraOrigins

Default value: `[]`

##### `web_authn_policy_passwordless_require_resident_key`

Valid values: `No`, `Yes`, `not specified`
Expand Down Expand Up @@ -4190,16 +4204,11 @@ Struct[{
Optional['transaction-xa-enabled'] => Boolean,
Optional['features'] => Array[String[1]],
Optional['features-disabled'] => Array[String[1]],
Optional['hostname'] => Stdlib::Host,
Optional['hostname-admin'] => Stdlib::Host,
Optional['hostname-admin-url'] => String[1],
Optional['hostname'] => Variant[Stdlib::Host, Stdlib::HTTPUrl, Stdlib::HTTPSUrl],
Optional['hostname-admin'] => Variant[Stdlib::HTTPUrl, Stdlib::HTTPSUrl],
Optional['hostname-backchannel-dynamic'] => Boolean,
Optional['hostname-debug'] => Boolean,
Optional['hostname-path'] => String[1],
Optional['hostname-port'] => Stdlib::Port,
Optional['hostname-strict'] => Boolean,
Optional['hostname-strict-backchannel'] => Boolean,
Optional['hostname-strict-https'] => Boolean,
Optional['hostname-url'] => String[1],
Optional['http-enabled'] => Boolean,
Optional['http-host'] => Stdlib::Host,
Optional['http-max-queued-requests'] => Integer,
Expand Down
2 changes: 1 addition & 1 deletion metadata.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "treydock-keycloak",
"version": "11.2.0",
"version": "12.0.0",
"author": "treydock",
"summary": "Keycloak Puppet module",
"license": "Apache-2.0",
Expand Down

0 comments on commit 8efef3f

Please sign in to comment.