Skip to content

Commit 7d297df

Browse files
Zak-KentZak-Kent
committed
(maint) Remove deprecated database_ssl and read_database_ssl params
1 parent 8fb9598 commit 7d297df

10 files changed

Lines changed: 16 additions & 131 deletions

File tree

‎README.md‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -404,15 +404,6 @@ The password for the database user. Defaults to `puppetdb`, ignored for
404404
The name of the database instance to connect to. Defaults to `puppetdb`, ignored
405405
for `embedded` database.
406406

407-
#### `database_ssl` (DEPRECATED)
408-
409-
If true, PuppetDB will use SSL to connect to the postgres database. Defaults to
410-
`false`, ignored for `embedded` database. Setting up proper trust- and keystores has to
411-
be managed outside of the PuppetDB module.
412-
413-
This parameter is deprecated and will be retired in a future release. Please use
414-
the `jdbc_ssl_properties` parameter with the value `?ssl=true`.
415-
416407
#### `jdbc_ssl_properties`
417408

418409
The text to append to the JDBC connection URI. This should begin with a '?'
@@ -571,12 +562,6 @@ supported in PuppetDB >= 1.6.
571562
The name of the read database instance to connect to. Defaults to `puppetdb`.
572563
This option is supported in PuppetDB >= 1.6.
573564

574-
#### `read_database_ssl`
575-
576-
If true, PuppetDB will use SSL to connect to the postgres read database
577-
(defaults to false). Setting up proper trust- and keystores has to be managed
578-
outside of the PuppetDB module. This option is supported in PuppetDB >= 1.6.
579-
580565
#### `read_log_slow_statements`
581566

582567
This sets the number of seconds before an SQL query to the read database is

‎manifests/init.pp‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@
2929
$database_username = $puppetdb::params::database_username,
3030
$database_password = $puppetdb::params::database_password,
3131
$database_name = $puppetdb::params::database_name,
32-
$database_ssl = $puppetdb::params::database_ssl,
3332
$jdbc_ssl_properties = $puppetdb::params::jdbc_ssl_properties,
3433
$database_listen_address = $puppetdb::params::postgres_listen_addresses,
3534
$database_validate = $puppetdb::params::database_validate,
@@ -53,7 +52,6 @@
5352
$read_database_username = $puppetdb::params::read_database_username,
5453
$read_database_password = $puppetdb::params::read_database_password,
5554
$read_database_name = $puppetdb::params::read_database_name,
56-
$read_database_ssl = $puppetdb::params::read_database_ssl,
5755
$read_database_jdbc_ssl_properties = $puppetdb::params::read_database_jdbc_ssl_properties,
5856
$read_database_validate = $puppetdb::params::read_database_validate,
5957
$read_log_slow_statements = $puppetdb::params::read_log_slow_statements,
@@ -103,7 +101,6 @@
103101
database_username => $database_username,
104102
database_password => $database_password,
105103
database_name => $database_name,
106-
database_ssl => $database_ssl,
107104
jdbc_ssl_properties => $jdbc_ssl_properties,
108105
database_validate => $database_validate,
109106
database_embedded_path => $database_embedded_path,
@@ -129,7 +126,6 @@
129126
read_database_username => $read_database_username,
130127
read_database_password => $read_database_password,
131128
read_database_name => $read_database_name,
132-
read_database_ssl => $read_database_ssl,
133129
read_database_jdbc_ssl_properties => $read_database_jdbc_ssl_properties,
134130
read_database_validate => $read_database_validate,
135131
read_log_slow_statements => $read_log_slow_statements,

‎manifests/params.pp‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
$database_name = 'puppetdb'
3232
$database_username = 'puppetdb'
3333
$database_password = 'puppetdb'
34-
$database_ssl = undef
3534
$jdbc_ssl_properties = ''
3635
$database_validate = true
3736
$database_max_pool_size = undef
@@ -57,7 +56,6 @@
5756
$read_database_name = 'puppetdb'
5857
$read_database_username = 'puppetdb'
5958
$read_database_password = 'puppetdb'
60-
$read_database_ssl = undef
6159
$read_database_jdbc_ssl_properties = ''
6260
$read_database_validate = true
6361
$read_log_slow_statements = '10'

‎manifests/server.pp‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
$database_username = $puppetdb::params::database_username,
2626
$database_password = $puppetdb::params::database_password,
2727
$database_name = $puppetdb::params::database_name,
28-
$database_ssl = $puppetdb::params::database_ssl,
2928
$jdbc_ssl_properties = $puppetdb::params::jdbc_ssl_properties,
3029
$database_validate = $puppetdb::params::database_validate,
3130
$database_embedded_path = $puppetdb::params::database_embedded_path,
@@ -48,7 +47,6 @@
4847
$read_database_username = $puppetdb::params::read_database_username,
4948
$read_database_password = $puppetdb::params::read_database_password,
5049
$read_database_name = $puppetdb::params::read_database_name,
51-
$read_database_ssl = $puppetdb::params::read_database_ssl,
5250
$read_database_jdbc_ssl_properties = $puppetdb::params::read_database_jdbc_ssl_properties,
5351
$read_database_validate = $puppetdb::params::read_database_validate,
5452
$read_log_slow_statements = $puppetdb::params::read_log_slow_statements,
@@ -72,15 +70,6 @@
7270
$read_database_max_pool_size = $puppetdb::params::read_database_max_pool_size,
7371
) inherits puppetdb::params {
7472

75-
# deprecation warnings
76-
if $database_ssl {
77-
warning('$database_ssl is deprecated and will be removed in the next major release. Please use $jdbc_ssl_properties = "?ssl=true" instead.')
78-
}
79-
80-
if $read_database_ssl {
81-
warning('$read_database_ssl is deprecated and will be removed in the next major release. Please use $read_database_jdbc_ssl_properties = "?ssl=true" instead.')
82-
}
83-
8473
# Apply necessary suffix if zero is specified.
8574
# Can we drop this in the next major release?
8675
if $node_ttl == '0' {
@@ -169,7 +158,6 @@
169158
database_username => $database_username,
170159
database_password => $database_password,
171160
database_name => $database_name,
172-
database_ssl => $database_ssl,
173161
database_max_pool_size => $database_max_pool_size,
174162
jdbc_ssl_properties => $jdbc_ssl_properties,
175163
database_validate => $database_validate,
@@ -195,7 +183,6 @@
195183
database_username => $read_database_username,
196184
database_password => $read_database_password,
197185
database_name => $read_database_name,
198-
database_ssl => $read_database_ssl,
199186
jdbc_ssl_properties => $read_database_jdbc_ssl_properties,
200187
database_validate => $read_database_validate,
201188
log_slow_statements => $read_log_slow_statements,

‎manifests/server/database.pp‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
$database_username = $puppetdb::params::database_username,
77
$database_password = $puppetdb::params::database_password,
88
$database_name = $puppetdb::params::database_name,
9-
$database_ssl = $puppetdb::params::database_ssl,
109
$jdbc_ssl_properties = $puppetdb::params::jdbc_ssl_properties,
1110
$database_validate = $puppetdb::params::database_validate,
1211
$database_embedded_path = $puppetdb::params::database_embedded_path,
@@ -78,9 +77,6 @@
7877
if !empty($jdbc_ssl_properties) {
7978
$database_suffix = $jdbc_ssl_properties
8079
}
81-
elsif $database_ssl {
82-
$database_suffix = '?ssl=true'
83-
}
8480
else {
8581
$database_suffix = ''
8682
}

‎manifests/server/read_database.pp‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
$database_username = $puppetdb::params::read_database_username,
77
$database_password = $puppetdb::params::read_database_password,
88
$database_name = $puppetdb::params::read_database_name,
9-
$database_ssl = $puppetdb::params::read_database_ssl,
109
$jdbc_ssl_properties = $puppetdb::params::read_database_jdbc_ssl_properties,
1110
$database_validate = $puppetdb::params::read_database_validate,
1211
$log_slow_statements = $puppetdb::params::read_log_slow_statements,
@@ -69,9 +68,6 @@
6968
if !empty($jdbc_ssl_properties) {
7069
$database_suffix = $jdbc_ssl_properties
7170
}
72-
elsif $database_ssl {
73-
$database_suffix = '?ssl=true'
74-
}
7571
else {
7672
$database_suffix = ''
7773
}

‎manifests/server/validate_db.pp‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# This validates a database connection. See README.md for more details.
22
class puppetdb::server::validate_db (
3-
$database = $puppetdb::params::database,
4-
$database_host = $puppetdb::params::database_host,
5-
$database_port = $puppetdb::params::database_port,
6-
$database_username = $puppetdb::params::database_username,
7-
$database_password = $puppetdb::params::database_password,
8-
$database_name = $puppetdb::params::database_name,
9-
$database_ssl = $puppetdb::params::database_ssl,
3+
$database = $puppetdb::params::database,
4+
$database_host = $puppetdb::params::database_host,
5+
$database_port = $puppetdb::params::database_port,
6+
$database_username = $puppetdb::params::database_username,
7+
$database_password = $puppetdb::params::database_password,
8+
$database_name = $puppetdb::params::database_name,
9+
$jdbc_ssl_properties = $puppetdb::params::jdbc_ssl_properties,
1010
) inherits puppetdb::params {
1111

1212
# We don't need any validation for the embedded database, presumably.
1313
if (
1414
$database == 'postgres' and
15-
($database_password != undef and $database_ssl == false)
15+
($database_password != undef and $jdbc_ssl_properties == false)
1616
) {
1717
postgresql::validate_db_connection { 'validate puppetdb postgres connection':
1818
database_host => $database_host,

‎manifests/server/validate_read_db.pp‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# This validates a database connection. See README.md for more details.
22
class puppetdb::server::validate_read_db (
3-
$database = $puppetdb::params::database,
4-
$database_host = $puppetdb::params::database_host,
5-
$database_port = $puppetdb::params::database_port,
6-
$database_username = $puppetdb::params::database_username,
7-
$database_password = $puppetdb::params::database_password,
8-
$database_name = $puppetdb::params::database_name,
9-
$database_ssl = $puppetdb::params::database_ssl,
3+
$database = $puppetdb::params::database,
4+
$database_host = $puppetdb::params::database_host,
5+
$database_port = $puppetdb::params::database_port,
6+
$database_username = $puppetdb::params::database_username,
7+
$database_password = $puppetdb::params::database_password,
8+
$database_name = $puppetdb::params::database_name,
9+
$jdbc_ssl_properties = $puppetdb::params::jdbc_ssl_properties,
1010
) inherits puppetdb::params {
1111

1212
# Currently we only support postgres
1313
if (
1414
$database == 'postgres' and
15-
($database_password != undef and $database_ssl == false)
15+
($database_password != undef and $jdbc_ssl_properties == false)
1616
) {
1717
postgresql::validate_db_connection { 'validate puppetdb postgres (read) connection':
1818
database_host => $database_host,

‎spec/unit/classes/server/db_connection_uri_spec.rb‎

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,6 @@
1111
}
1212
end
1313

14-
describe 'when setting database_ssl flag' do
15-
let(:params) do
16-
{
17-
'database_ssl' => true,
18-
}
19-
end
20-
21-
it {
22-
is_expected.to contain_ini_setting('puppetdb_subname')
23-
.with(
24-
'section' => 'database',
25-
'setting' => 'subname',
26-
'value' => '//localhost:5432/puppetdb?ssl=true',
27-
)
28-
}
29-
end
30-
3114
describe 'when passing jdbc subparams' do
3215
let(:params) do
3316
{
@@ -44,23 +27,5 @@
4427
)
4528
}
4629
end
47-
48-
describe 'when passing both database_ssl and jdbc subparams' do
49-
let(:params) do
50-
{
51-
'database_ssl' => true,
52-
'jdbc_ssl_properties' => '?ssl=true&sslmode=verify-full',
53-
}
54-
end
55-
56-
it {
57-
is_expected.to contain_ini_setting('puppetdb_subname')
58-
.with(
59-
'section' => 'database',
60-
'setting' => 'subname',
61-
'value' => '//localhost:5432/puppetdb?ssl=true&sslmode=verify-full',
62-
)
63-
}
64-
end
6530
end
6631
end

‎spec/unit/classes/server/db_read_uri_spec.rb‎

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,6 @@
1111
}
1212
end
1313

14-
describe 'when setting database_ssl flag' do
15-
let(:params) do
16-
{
17-
# this sets read_database_host
18-
'database_host' => 'localhost',
19-
'database_ssl' => true,
20-
}
21-
end
22-
23-
it {
24-
is_expected.to contain_ini_setting('puppetdb_read_subname')
25-
.with(
26-
'section' => 'read-database',
27-
'setting' => 'subname',
28-
'value' => '//localhost:5432/puppetdb?ssl=true',
29-
)
30-
}
31-
end
32-
3314
describe 'when passing jdbc subparams' do
3415
let(:params) do
3516
{
@@ -47,24 +28,5 @@
4728
)
4829
}
4930
end
50-
51-
describe 'when passing both database_ssl and jdbc subparams' do
52-
let(:params) do
53-
{
54-
'database_host' => 'localhost',
55-
'database_ssl' => true,
56-
'jdbc_ssl_properties' => '?ssl=true&sslmode=verify-full',
57-
}
58-
end
59-
60-
it {
61-
is_expected.to contain_ini_setting('puppetdb_read_subname')
62-
.with(
63-
'section' => 'read-database',
64-
'setting' => 'subname',
65-
'value' => '//localhost:5432/puppetdb?ssl=true&sslmode=verify-full',
66-
)
67-
}
68-
end
6931
end
7032
end

0 commit comments

Comments
 (0)
⚡