Skip to content

Commit 70d03bf

Browse files
null93null93
committed
Moving patch documentation to public docs
1 parent 25597c6 commit 70d03bf

File tree

4 files changed

+113
-0
lines changed

4 files changed

+113
-0
lines changed

Diff for: ‎docs/patches/P001C.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: P001C
3+
---
4+
5+
Fixes data persistence issue with OpenSearch and Redis.
6+
7+
## Description
8+
9+
We first noticed the issue that OpenSearch and Redis session data was being deleted every time it was taken out of hibernation.
10+
As a result, the site had to be re-indexed upon each wake-up.
11+
12+
The root cause lies in the helper scripts that run on boot.
13+
These scripts manage version changes for OpenSearch and Redis and are also triggered by CloudFormation (CFN) when a version update is requested.
14+
15+
In some cases, we need to delete persistent data to prevent compatibility issues between old data and new software versions.
16+
However, the problem is that the current boot process clears the data without checking if a version change has actually occurred.
17+
18+
## Impact
19+
20+
- All-In-One (AIO) Servers
21+
- Web Layer
22+
- Redis Session Layer
23+
- Redis Cache Layer
24+
- OpenSearch Layer
25+
26+
## Changes
27+
28+
The following files are patched on the servers receiving the patch:
29+
30+
- /opt/jrc/sbin/change-search-version
31+
- /opt/jrc/sbin/change-redis-session-version
32+
- /opt/jrc/sbin/change-redis-cache-version
33+
34+
## If You Accept
35+
36+
During your chosen maintenance window, the patch will be applied to all targeted servers.
37+
New Amazon Machine Images (AMIs) will be generated for each of the servers involved, and these new AMIs will be used to replace the current servers.
38+
Downtime should be minimal and take less than 10 minutes to restore service.
39+
40+
## If You Reject
41+
42+
OpenSearch and Redis session data will continue to be deleted as a side effect every time the deployment is taken out of hibernation.
43+
This will result in the need to re-index OpenSearch upon each wake-up and loss of session data.

Diff for: ‎docs/patches/P002R.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: P002R
3+
---
4+
5+
PHP performance improvements.
6+
7+
## Description
8+
9+
The `opcache.max_file_size` directive determines the maximum file size that can be cached by OPcache. Setting this value to zero allows all files to be cached, which can significantly improve the Time To First Byte (TTFB) metric. Previously, this value was limited to avoid caching large files deemed unnecessary for application functionality. However, further analysis has shown that removing this limitation enhances performance without adverse effects.
10+
11+
## Impact
12+
13+
- Web Layer
14+
15+
## Changes
16+
17+
The `opcache.max_file_size` directive will be updated to zero.
18+
19+
## If You Accept
20+
21+
During your chosen maintenance window, the patch will be applied.
22+
PHP-FPM will be restarted on the web tier to apply the changes.
23+
No downtime is expected since we are only restarting the PHP-FPM service.
24+
25+
## If You Reject
26+
27+
The current configuration will remain unchanged, and no performance improvements will be applied.

Diff for: ‎docs/patches/P003O.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: P003O
3+
---
4+
5+
## Description
6+
7+
This patch increases the maximum number of SSH keys allowed by transitioning from a single advanced SSM parameter to multiple standard SSM parameters. Each SSH key is now stored individually, removing the previous 8k size limitation.
8+
9+
## Impact
10+
11+
- All-In-One (AIO) Servers
12+
- Jump Host Servers
13+
- Web Layer
14+
15+
## Changes
16+
17+
- Public keys in the advanced SSM parameter are split into multiple standard SSM parameters.
18+
- The `sync-ssh-keys` script is patched on jump and web leader instances.
19+
- Cloudformation template is updated to reflect the new method of storing SSH keys:
20+
21+
## If You Accept
22+
23+
The deployment will support effectively unlimited SSH keys.
24+
During your chosen maintenance window, the patch will be applied to all targeted servers.
25+
New Amazon Machine Images (AMIs) will be generated for each of the servers involved, and these new AMIs will be used to replace the current servers.
26+
Downtime should be minimal and take less than 10 minutes to restore service.
27+
28+
## If You Reject
29+
30+
No performance or functionality degradation is expected, but the deployment will not benefit from the increased SSH key limit.

Diff for: ‎docs/patches/index.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Patches
3+
---
4+
5+
Patches are categorized as **Critical**, **Recommended**, or **Optional**, indicating their severity and the urgency of application.
6+
This classification is reflected in the last character of the patch's name.
7+
8+
{.compact}
9+
| Severity | Description |
10+
|-----------------|-------------------------------------------------------------------------------------------------|
11+
| **Critical** | Must be applied to all environments as soon as possible. |
12+
| **Recommended** | Includes important fixes and is recommended for all environments, but can be applied later. |
13+
| **Optional** | Applied only if specifically requested and does not affect performance or functionality. |

0 commit comments

Comments
 (0)