diff options
Diffstat (limited to 'pgaas/src/stage/opt/app/pgaas/man')
4 files changed, 65 insertions, 3 deletions
diff --git a/pgaas/src/stage/opt/app/pgaas/man/check_cluster.man b/pgaas/src/stage/opt/app/pgaas/man/check_cluster.man index dc6fcce..ea8f5e9 100644 --- a/pgaas/src/stage/opt/app/pgaas/man/check_cluster.man +++ b/pgaas/src/stage/opt/app/pgaas/man/check_cluster.man @@ -14,7 +14,10 @@ .SH NAME check_cluster - check the state of the cluster .SH SYNOPSIS -check_cluster [-v] [-l] [-t timeout] +check_cluster [-d file] [-v] [-l] [-t timeout] +.HP 20 +-d file +duplicate the status output to the given file .HP 20 -l do not check localhost first (and restarting the service if necessary) @@ -25,10 +28,13 @@ set how long to wait when accessing the servers -v verbose .SH DESCRIPTION -Loop through the nodes in the cluster, using pgwget to determine how many are masters, secondaries, or not up. +Loop through the nodes in the cluster, using pgwget to determine how many are +masters, secondaries, in maintenance, or not up. Complain about certain situations. If there are multiple masters, and this not the first master in the list, then: run pg_ctl_restart -prevent /ro from returning true +to prevent /ro from returning true +.PP +When \-d is used, the filename will have ".tmp" appended, writing the output to that temp filename, and then renaming the ".tmp" file to the given filename. diff --git a/pgaas/src/stage/opt/app/pgaas/man/makefile b/pgaas/src/stage/opt/app/pgaas/man/makefile index 9cd2090..92f6292 100644 --- a/pgaas/src/stage/opt/app/pgaas/man/makefile +++ b/pgaas/src/stage/opt/app/pgaas/man/makefile @@ -93,5 +93,9 @@ show_pg_stat_user_tables.1: show_pg_stat_user_tables.man DATE=$$(date +%Y-%m-%d); sed "1s/ {{DATE}} / $$DATE /" < $< | nroff -Tlp -man > $@ startpsql.1: startpsql.man DATE=$$(date +%Y-%m-%d); sed "1s/ {{DATE}} / $$DATE /" < $< | nroff -Tlp -man > $@ +start_maintenance_mode.1: start_maintenance_mode.man + DATE=$$(date +%Y-%m-%d); sed "1s/ {{DATE}} / $$DATE /" < $< | nroff -Tlp -man > $@ +stop_maintenance_mode.1: stop_maintenance_mode.man + DATE=$$(date +%Y-%m-%d); sed "1s/ {{DATE}} / $$DATE /" < $< | nroff -Tlp -man > $@ update_var_run_isrw.1: update_var_run_isrw.man DATE=$$(date +%Y-%m-%d); sed "1s/ {{DATE}} / $$DATE /" < $< | nroff -Tlp -man > $@ diff --git a/pgaas/src/stage/opt/app/pgaas/man/start_maintenance_mode.man b/pgaas/src/stage/opt/app/pgaas/man/start_maintenance_mode.man new file mode 100644 index 0000000..1906afa --- /dev/null +++ b/pgaas/src/stage/opt/app/pgaas/man/start_maintenance_mode.man @@ -0,0 +1,28 @@ +'\" Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. +'\" +'\" Licensed under the Apache License, Version 2.0 (the "License"); +'\" you may not use this code except in compliance +'\" with the License. You may obtain a copy of the License +'\" at http://www.apache.org/licenses/LICENSE-2.0 +'\" +'\" Unless required by applicable law or agreed to in writing, software +'\" distributed under the License is distributed on an "AS IS" BASIS, +'\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +'\" implied. See the License for the specific language governing +'\" permissions and limitations under the License. +.TH start_maintenance_mode 1PG {{DATE}} OpenECOMP OpenECOMP +.SH NAME +start_maintenance_mode - convert this system to maintenance mode +.SH SYNOPSIS +start_maintenance_mode +.SH DESCRIPTION +Take this system out of the normal rotation and mark it as being in maintenance mode. +This command may only be used on a secondary system and not on a master system. +After this command is run, the PostgreSQL server will be brought down, but may be +restarted manually using the pg_ctl_start. +Note that the health checks will not regard this system as being in the normal +rotation until the command stop_maintenance_mode is executed, allowing the DBA to perform +whatever is needed to perform a backup or other maintenance routines, +such as copying the database files. +.SH FILES +/var/run/postgresql/inmaintenance diff --git a/pgaas/src/stage/opt/app/pgaas/man/stop_maintenance_mode.man b/pgaas/src/stage/opt/app/pgaas/man/stop_maintenance_mode.man new file mode 100644 index 0000000..bc97745 --- /dev/null +++ b/pgaas/src/stage/opt/app/pgaas/man/stop_maintenance_mode.man @@ -0,0 +1,24 @@ +'\" Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. +'\" +'\" Licensed under the Apache License, Version 2.0 (the "License"); +'\" you may not use this code except in compliance +'\" with the License. You may obtain a copy of the License +'\" at http://www.apache.org/licenses/LICENSE-2.0 +'\" +'\" Unless required by applicable law or agreed to in writing, software +'\" distributed under the License is distributed on an "AS IS" BASIS, +'\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +'\" implied. See the License for the specific language governing +'\" permissions and limitations under the License. +.TH stop_maintenance_mode 1PG {{DATE}} OpenECOMP OpenECOMP +.SH NAME +stop_maintenance_mode - convert this system to maintenance mode +.SH SYNOPSIS +stop_maintenance_mode +.SH DESCRIPTION +Mark this system as no longer being in maintenance mode, and +return this system back to the normal rotation. +This command may only be used on a secondary system and not on a master system. +This command will also restart the PostgreSQL server. +.SH FILES +/var/run/postgresql/inmaintenance |