Skip to content

Commit dff7b3e

Browse files
committed
chore(pgsql): update comments of pg_hugepage.yml
1 parent ff0de41 commit dff7b3e

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

roles/pgsql/tasks/grace_patroni_restart.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/ansible-playbook
22
---
33
#--------------------------------------------------------------#
4-
# patroni restart pg_cls gracefully [pt_restart]
4+
# patroni restart pg_cls gracefully [pt_restart]
55
# avoiding switching pg primary/standby
66
# usage:
77
# - ./pgsql.yml -l <pg_cls> -t pt_restart -e "pt_restart=true"
@@ -16,7 +16,8 @@
1616
# - ./pgsql.yml -l <pg_cls> -t pt_restart -e "pt_restart=true"
1717
# all nodes have been restarted
1818
# - ./pgsql.yml -l '<ip>,&<pg_cls>' -t pt_restart -e "pt_restart=true"
19-
# nodes in ansible_play_hosts_all have been restarted, other nodes in the same pg_cls ignored
19+
# nodes in ansible_play_hosts_all have been restarted,
20+
# other nodes in the same pg_cls ignored
2021
#--------------------------------------------------------------#
2122

2223
- name: set variable

roles/pgsql/tasks/pg_hugepage.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
---
22
#--------------------------------------------------------------#
33
# Enable hugepage for pg and restart pg cluster [pg_hugepage]
4-
# if `node_hugepage_count` or `node_hugepage_ratio` changed, it will full backup the pg_cls and restart it gracefully
4+
# if `node_hugepage_count` or `node_hugepage_ratio` changed,
5+
# it will full backup the pg_cls and restart it gracefully
56
# support usage:
67
# - `pig install`
78
# - `bin/pgsql-add <pg_cls>`
9+
# - `bin/pgsql-add <pg_cls> <ip>`
10+
# service of nodes in ansible_play_hosts_all will be unavailable during the process,
11+
# other nodes in the same pg_cls ignored
812
# - `pgsql.yml -l <pg_cls> -t pg_hugepage`
13+
# entire service of this postgres cluster will be unavailable during the process
14+
# - `pgsql.yml -l '<ip>,&<pg_cls>' -t pg_hugepage`
15+
# service of nodes in ansible_play_hosts_all will be unavailable during the process,
16+
# other nodes in the same pg_cls ignored
917
#--------------------------------------------------------------#
1018
# calculation rules:
1119
# 1. `shared_memory_size_in_huge_pages` (from PG15+): if `node_hugepage_count` is -1 and huge_pages (from PG) != off

0 commit comments

Comments
 (0)