Skip to content

Commit 34d0864

Browse files
ezilber-akamailgarber-akamaiykim-akamai
authored
Project: Configurable DB Params (#678)
* Configurable DB Parameters: Implementation (#670) * Add support for Configurable DB Parameters * revert instance.rst * tidy up * oops * add and update test cases * Revert branch change * remove pg13 negative test case --------- Co-authored-by: Youjung Kim <ykim@akamai.com> * Point to latest version of Python SDK * Added documentation links --------- Co-authored-by: Lena Garber <114949949+lgarber-akamai@users.noreply.github.com> Co-authored-by: Youjung Kim <ykim@akamai.com>
1 parent ae64776 commit 34d0864

File tree

15 files changed

+2216
-147
lines changed

15 files changed

+2216
-147
lines changed

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ Name | Description |
6262
[linode.cloud.account_availability_info](./docs/modules/account_availability_info.md)|Get info about a Linode Account Availability.|
6363
[linode.cloud.account_info](./docs/modules/account_info.md)|Get info about a Linode Account.|
6464
[linode.cloud.child_account_info](./docs/modules/child_account_info.md)|Get info about a Linode Child Account.|
65+
[linode.cloud.database_config_info](./docs/modules/database_config_info.md)|Get info about a Linode Configuration.|
6566
[linode.cloud.database_mysql_info](./docs/modules/database_mysql_info.md)|Get info about a Linode MySQL Managed Database.|
6667
[linode.cloud.database_postgresql_info](./docs/modules/database_postgresql_info.md)|Get info about a Linode PostgreSQL Managed Database.|
6768
[linode.cloud.domain_info](./docs/modules/domain_info.md)|Get info about a Linode Domain.|

‎docs/modules/database_config_info.md‎

Lines changed: 275 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,275 @@
1+
# database_config_info
2+
3+
Get info about a Linode Configuration.
4+
5+
- [Minimum Required Fields](#minimum-required-fields)
6+
- [Examples](#examples)
7+
- [Parameters](#parameters)
8+
- [Return Values](#return-values)
9+
10+
## Minimum Required Fields
11+
| Field | Type | Required | Description |
12+
|-------------|-------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
13+
| `api_token` | `str` | **Required** | The Linode account personal access token. It is necessary to run the module. <br/>It can be exposed by the environment variable `LINODE_API_TOKEN` instead. <br/>See details in [Usage](https://github.com/linode/ansible_linode?tab=readme-ov-file#usage). |
14+
15+
## Examples
16+
17+
```yaml
18+
- name: Get all available engine configuration fields for MySQL databases
19+
linode.cloud.database_config_info:
20+
engine: mysql
21+
```
22+
23+
```yaml
24+
- name: Get all available engine configuration fields for PostgreSQL databases
25+
linode.cloud.database_config_info:
26+
engine: postgresql
27+
```
28+
29+
30+
## Parameters
31+
32+
| Field | Type | Required | Description |
33+
|-----------|------|----------|------------------------------------------------------------------------------|
34+
| `engine` | <center>`str`</center> | <center>**Required**</center> | The Database Engine of the Configuration to resolve. |
35+
36+
## Return Values
37+
38+
- `config` - The returned Configuration.
39+
40+
- Sample Response:
41+
```json
42+
43+
{
44+
"binlog_retention_period": {
45+
"description": "The minimum amount of time in seconds to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default for example if using the MySQL Debezium Kafka connector.",
46+
"example": 600,
47+
"maximum": 86400,
48+
"minimum": 600,
49+
"requires_restart": false,
50+
"type": "integer"
51+
},
52+
"mysql": {
53+
"connect_timeout": {
54+
"description": "The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake",
55+
"example": 10,
56+
"maximum": 3600,
57+
"minimum": 2,
58+
"requires_restart": false,
59+
"type": "integer"
60+
},
61+
"default_time_zone": {
62+
"description": "Default server time zone as an offset from UTC (from -12:00 to +12:00), a time zone name, or 'SYSTEM' to use the MySQL server default.",
63+
"example": "+03:00",
64+
"maxLength": 100,
65+
"minLength": 2,
66+
"pattern": "^([-+][\\d:]*|[\\w/]*)$",
67+
"requires_restart": false,
68+
"type": "string"
69+
},
70+
"group_concat_max_len": {
71+
"description": "The maximum permitted result length in bytes for the GROUP_CONCAT() function.",
72+
"example": 1024,
73+
"maximum": 18446744073709551615,
74+
"minimum": 4,
75+
"requires_restart": false,
76+
"type": "integer"
77+
},
78+
"information_schema_stats_expiry": {
79+
"description": "The time, in seconds, before cached statistics expire",
80+
"example": 86400,
81+
"maximum": 31536000,
82+
"minimum": 900,
83+
"requires_restart": false,
84+
"type": "integer"
85+
},
86+
"innodb_change_buffer_max_size": {
87+
"description": "Maximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool. Default is 25",
88+
"example": 30,
89+
"maximum": 50,
90+
"minimum": 0,
91+
"requires_restart": false,
92+
"type": "integer"
93+
},
94+
"innodb_flush_neighbors": {
95+
"description": "Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent (default is 1): 0 - dirty pages in the same extent are not flushed, 1 - flush contiguous dirty pages in the same extent, 2 - flush dirty pages in the same extent",
96+
"example": 0,
97+
"maximum": 2,
98+
"minimum": 0,
99+
"requires_restart": false,
100+
"type": "integer"
101+
},
102+
"innodb_ft_min_token_size": {
103+
"description": "Minimum length of words that are stored in an InnoDB FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service.",
104+
"example": 3,
105+
"maximum": 16,
106+
"minimum": 0,
107+
"requires_restart": true,
108+
"type": "integer"
109+
},
110+
"innodb_ft_server_stopword_table": {
111+
"description": "This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables.",
112+
"example": "db_name/table_name",
113+
"maxLength": 1024,
114+
"pattern": "^.+/.+$",
115+
"requires_restart": false,
116+
"type": [
117+
"null",
118+
"string"
119+
]
120+
},
121+
"innodb_lock_wait_timeout": {
122+
"description": "The length of time in seconds an InnoDB transaction waits for a row lock before giving up. Default is 120.",
123+
"example": 50,
124+
"maximum": 3600,
125+
"minimum": 1,
126+
"requires_restart": false,
127+
"type": "integer"
128+
},
129+
"innodb_log_buffer_size": {
130+
"description": "The size in bytes of the buffer that InnoDB uses to write to the log files on disk.",
131+
"example": 16777216,
132+
"maximum": 4294967295,
133+
"minimum": 1048576,
134+
"requires_restart": false,
135+
"type": "integer"
136+
},
137+
"innodb_online_alter_log_max_size": {
138+
"description": "The upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables.",
139+
"example": 134217728,
140+
"maximum": 1099511627776,
141+
"minimum": 65536,
142+
"requires_restart": false,
143+
"type": "integer"
144+
},
145+
"innodb_read_io_threads": {
146+
"description": "The number of I/O threads for read operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.",
147+
"example": 10,
148+
"maximum": 64,
149+
"minimum": 1,
150+
"requires_restart": true,
151+
"type": "integer"
152+
},
153+
"innodb_rollback_on_timeout": {
154+
"description": "When enabled a transaction timeout causes InnoDB to abort and roll back the entire transaction. Changing this parameter will lead to a restart of the MySQL service.",
155+
"example": true,
156+
"requires_restart": true,
157+
"type": "boolean"
158+
},
159+
"innodb_thread_concurrency": {
160+
"description": "Defines the maximum number of threads permitted inside of InnoDB. Default is 0 (infinite concurrency - no limit)",
161+
"example": 10,
162+
"maximum": 1000,
163+
"minimum": 0,
164+
"requires_restart": false,
165+
"type": "integer"
166+
},
167+
"innodb_write_io_threads": {
168+
"description": "The number of I/O threads for write operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.",
169+
"example": 10,
170+
"maximum": 64,
171+
"minimum": 1,
172+
"requires_restart": true,
173+
"type": "integer"
174+
},
175+
"interactive_timeout": {
176+
"description": "The number of seconds the server waits for activity on an interactive connection before closing it.",
177+
"example": 3600,
178+
"maximum": 604800,
179+
"minimum": 30,
180+
"requires_restart": false,
181+
"type": "integer"
182+
},
183+
"internal_tmp_mem_storage_engine": {
184+
"description": "The storage engine for in-memory internal temporary tables.",
185+
"enum": [
186+
"TempTable",
187+
"MEMORY"
188+
],
189+
"example": "TempTable",
190+
"requires_restart": false,
191+
"type": "string"
192+
},
193+
"max_allowed_packet": {
194+
"description": "Size of the largest message in bytes that can be received by the server. Default is 67108864 (64M)",
195+
"example": 67108864,
196+
"maximum": 1073741824,
197+
"minimum": 102400,
198+
"requires_restart": false,
199+
"type": "integer"
200+
},
201+
"max_heap_table_size": {
202+
"description": "Limits the size of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M)",
203+
"example": 16777216,
204+
"maximum": 1073741824,
205+
"minimum": 1048576,
206+
"requires_restart": false,
207+
"type": "integer"
208+
},
209+
"net_buffer_length": {
210+
"description": "Start sizes of connection buffer and result buffer. Default is 16384 (16K). Changing this parameter will lead to a restart of the MySQL service.",
211+
"example": 16384,
212+
"maximum": 1048576,
213+
"minimum": 1024,
214+
"requires_restart": true,
215+
"type": "integer"
216+
},
217+
"net_read_timeout": {
218+
"description": "The number of seconds to wait for more data from a connection before aborting the read.",
219+
"example": 30,
220+
"maximum": 3600,
221+
"minimum": 1,
222+
"requires_restart": false,
223+
"type": "integer"
224+
},
225+
"net_write_timeout": {
226+
"description": "The number of seconds to wait for a block to be written to a connection before aborting the write.",
227+
"example": 30,
228+
"maximum": 3600,
229+
"minimum": 1,
230+
"requires_restart": false,
231+
"type": "integer"
232+
},
233+
"sort_buffer_size": {
234+
"description": "Sort buffer size in bytes for ORDER BY optimization. Default is 262144 (256K)",
235+
"example": 262144,
236+
"maximum": 1073741824,
237+
"minimum": 32768,
238+
"requires_restart": false,
239+
"type": "integer"
240+
},
241+
"sql_mode": {
242+
"description": "Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field Akamai default SQL mode (strict, SQL standard compliant) will be assigned.",
243+
"example": "ANSI,TRADITIONAL",
244+
"maxLength": 1024,
245+
"pattern": "^[A-Z_]*(,[A-Z_]+)*$",
246+
"requires_restart": false,
247+
"type": "string"
248+
},
249+
"sql_require_primary_key": {
250+
"description": "Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them.",
251+
"example": true,
252+
"requires_restart": false,
253+
"type": "boolean"
254+
},
255+
"tmp_table_size": {
256+
"description": "Limits the size of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M)",
257+
"example": 16777216,
258+
"maximum": 1073741824,
259+
"minimum": 1048576,
260+
"requires_restart": false,
261+
"type": "integer"
262+
},
263+
"wait_timeout": {
264+
"description": "The number of seconds the server waits for activity on a noninteractive connection before closing it.",
265+
"example": 28800,
266+
"maximum": 2147483,
267+
"minimum": 1,
268+
"requires_restart": false,
269+
"type": "integer"
270+
}
271+
}
272+
}
273+
```
274+
275+

0 commit comments

Comments
 (0)