Change 26644
SDP Doc Update to address jobs.
Mainly documents scripts which lacked any mention.
Mainly documents scripts which lacked any mention.
0 comments
Log in to comment
| SDP-460 | Script 'broker_rotate.sh' is not mentioned in the SDP Guide (Unix). If this is... part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/broker_rotate.sh « | |
| SDP-461 | Script 'edge_dump.sh' is not mentioned in the SDP Guide (Unix). If this is part... of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/edge_dump.sh « | |
| SDP-462 | Script 'edge_shelf_replicate.sh' is not mentioned in the SDP Guide (Unix). If t...his is part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/edge_shelf_replicate.sh « | |
| SDP-463 | Script 'edge_vars' is not mentioned in the SDP Guide (Unix). If this is part of... the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/edge_vars « | |
| SDP-464 | Script 'gen_default_broker_cfg.sh' is not mentioned in the SDP Guide (Unix). If... this is part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/gen_default_broker_cfg.sh « | |
| SDP-469 | Script 'mkrep.sh' is not mentioned in the SDP Guide (Unix). If this is part... of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. Configuring a replicated environment is now done using this script, but with no mention of it in the guide, no-one knows to look at this script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/mkrep.sh « | |
| SDP-471 | Script 'p4dstate.sh' is not mentioned in the SDP Guide (Unix). If this is part... of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/p4dstate.sh « | |
| SDP-481 | Script 'ps_functions.sh' is not mentioned in the SDP Guide (Unix). If this is p...art of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/ps_functions.sh « | |
| SDP-482 | Script 'purge_revisions.sh' is not mentioned in the SDP Guide (Unix). If this i...s part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/purge_revisions.sh « | |
| SDP-483 | Script 'recover_edge.sh' is not mentioned in the SDP Guide (Unix). If this is p...art of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/recover_edge.sh « | |
| SDP-484 | Script 'replica_cleanup.sh' is not mentioned in the SDP Guide (Unix). If this i...s part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/replica_cleanup.sh « | |
| SDP-485 | Script 'replica_status.sh' is not mentioned in the SDP Guide (Unix). If this is... part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/replica_status.sh « | |
| SDP-486 | Script 'request_replica_checkpoint.sh' is not mentioned in the SDP Guide (Unix).... If this is part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/request_replica_checkpoint.sh « | |
| SDP-487 | Script 'rotate_journal.sh' is not mentioned in the SDP Guide (Unix). If this is... part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/rotate_journal.sh « | |
| SDP-492 | Script 'update_limits.py' is not mentioned in the SDP Guide (Unix). If this is... part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/update_limits.py « | |
| SDP-493 | Script 'verify_sdp.sh' is not mentioned in the SDP Guide (Unix). If this is par...t of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/verify_sdp.sh « | |
| SDP-495 | SDP Guide mentions now-deleted/obsolete script. Section 3.3.2 "Recovering a r...eplica from checkpoint" "See the steps in the script weekly_sync_replica.sh for details..." This script was deleted four years ago. « | |
| SDP-496 | Script 'backup_functions.sh' is mentioned in the SDP Guide (Unix) but there is o...nly limited, if any explanation on the purpose of this script. If this is part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/backup_functions.sh « | |
| SDP-497 | Script 'p4d_base' is mentioned in the SDP Guide (Unix) but there is only limited..., if any explanation on the purpose of this script. If this is part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/p4d_base « | |
| SDP-498 | Script 'p4verify.sh' is mentioned in the SDP Guide (Unix) but there is only limi...ted, if any explanation on the purpose of this script. If this is part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/p4verify.sh « | |
| SDP-499 | Script 'run_if_edge.sh' is mentioned in the SDP Guide (Unix) but there is only l...imited, if any explanation on the purpose of this script. If this is part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/run_if_edge.sh « | |
| SDP-500 | Script 'run_if_master.sh' is mentioned in the SDP Guide (Unix) but there is only... limited, if any explanation on the purpose of this script. If this is part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/run_if_master.sh « | |
| SDP-501 | Script 'run_if_replica.sh' is mentioned in the SDP Guide (Unix) but there is onl...y limited, if any explanation on the purpose of this script. If this is part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/run_if_replica.sh « | |
| SDP-502 | Script 'sync_replica.sh' is mentioned in the SDP Guide (Unix) but there is only... limited, if any explanation on the purpose of this script. If this is part of the SDP, it needs to be given at least some basic explanation; if not, consider removing the script from the SDP or move the functionality to another script and update the documentation for that script. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/Server/Unix/p4/common/bin/sync_replica.sh « | |
| SDP-503 | SDP Guide mentions some scripts by most of the filename, not all of it. For e...xample, SDP_Guide.Unix.pdf provides a brief explanation of recreate_offline_db, live_checkpoint and daily_checkpoint, but the actual files are called recreate_offline_db.sh, live_checkpoint.sh and daily_checkpoint.sh. As it's possible to have files with no 'extension' (no '.sh' in this case) please ensure the full name is used: searching the doc for "daily_checkpoint.sh" finds a few places where the script is mentioned, but does not find section 5.1.6 "daily_checkpoint" where the explanation of the purpose is found. The reader either needs to review the Table of Contents to see if it's mentioned, or assumes the script is not documented at all. « | |
| SDP-504 | SDP Guide mentions "weekly_checkpoint" script under "daily_checkpoint": "This... procedure rebalances and compresses the database files in the offline_db directory, which are rotated into the live database directory once a week by the weekly_checkpoint script." This file does not exist; please remove the reference. NB. "weekly_backup.sh", "weekly_sync_replica.sh" and "weekly_sync_shared_replica.sh" are the only "weekly_*.sh" scripts I can find in the SDP Workshop Project, and these were removed (deleted) roughly four years ago. « | |
| SDP-509 | "sdp-administrator-guide.docx" needs to be removed or updated. The SDP is i...ntended to assist in the administration of a Helix Core Server, and there are SDP_Guide docs for Windows and Unix that are expected to cover the administration and use of the SDP. It is unclear if 'sdp-administrator-guide' is intended to supplement or replace the other SDP Guide docs. Also, the 'sdp-administrator-guide' itself is clearly out-of-date. The 'main' copy was included in change 25245, which was the 2019.1 SDP release (change description starts "Released SDP 2019.1.25238 (2019/03/02). ") However, the document itself states "2018.1" and "first draft", and "(C) 2015-2018", so does not tie up with the SDP version with which it's been included. https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/main/doc/sdp-administrator-guide.docx https://swarm.workshop.perforce.com/projects/perforce-software-sdp/files/dev/doc/sdp-administrator-guide.docx « | |
| SDP-512 | upgrade.sh needs clearer documented explanation The documentation needs to be... clear that the system admin must not attempt to build any of the symlinks or rename the p4/p4d binaries themselves, as this is handled by the upgrade script. The current documentation explains what is done, but does not make it clear what must not be done. To allow the admin to carry out these tasks themselves, the documentation must remove any ambiguity and prevent the need to ask questions, or avoid the situation where an admin attempts to be helpful and implements some part of the process themselves. Currently, the docs state this: 4.1 Server upgrades Upgrading a server instance in the SDP framework is a simple process involving a few steps. * Download the new p4 and p4d executables for your OS from ftp.perforce.com and place them in /p4/common/bin * Run: /p4/common/bin/upgrade.sh instance * If you are running replicas, upgrade the replicas first, and then the master (outside -> in) -- and -- 5.2.1 upgrade.sh Runs a typical upgrade process, once new p4 and p4d binaries are available in /p4/common/bin. This script will: * Rotate the journal (for clean recovery point) * Apply all necessary journals to offline_db * Stop the server * Create an appropriately versioned link for new p4/p4d/p4broker etc * Link those into /p4/1/bin (per instance) * Run p4d -xu on live and offline_db to perform database upgrades * Restart server Location: /p4/common/bin « | |
| SDP-538 | Document systemd interactions with SDP init scripts. On operating systems tha...t use systemd as the init mechanism, admins must be trained to only use systemd to start and stop p4d, and SDP documentation must clarify this. This is a somewhat dangerous situation, where systemd doesn't know p4d is up, but it is. The danger is not immediate. It wont impact p4d functionality or performance when running. This danger is that, if the machine were rebooted, p4d would not be asked by the OS to shutdown gracefully, and that can cause data corruption if the server is busy at the time of reboot. This documentation may be unnecessary/obsolete if SDP-428 is implemented. « | |
| SDP-545 | DOC: PDF contains "Reference source not found" errors. 4.4 Optimizing the dat...abase files The Perforce Server’s database is composed of b-tree files. The server does not fully rebalance and compress them during normal operation. To optimize the files, you must checkpoint and restore the server. This normally only needs to be done very few months. To minimize the size of back up files and maximize server performance, minimize the size of the db.have and db.label files. The === HERE === scripts for Error! Reference source not found., and Error! Reference source not found., help achieve this goal. =========== For best server performance, run these scripts weekly via /p4/sdp/Maintenance/maintenance https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/doc/SDP_Guide.Unix.pdf « | |
| Add Job | ||
3 edited
0 added
0 deleted
Tip: Use n and p to cycle through the changes.