{"id":31117,"date":"2022-09-04T12:34:18","date_gmt":"2022-09-04T12:34:18","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=31117"},"modified":"2022-12-23T05:47:33","modified_gmt":"2022-12-23T05:47:33","slug":"gitlab-tutorials-gitlab-ctl-commands-reference-example","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/gitlab-tutorials-gitlab-ctl-commands-reference-example\/","title":{"rendered":"GitLab Tutorials: gitlab-ctl commands reference & example"},"content":{"rendered":"\n

omnibus-ctl: command (subcommand)<\/h2>\n\n\n\n
check-config<\/td>Check if there are any configuration in gitlab.rb that is removed in specified version<\/td><\/tr>
deploy-page<\/td>Put up the deploy page<\/td><\/tr>
diff-config<\/td>Compare the user configuration with package available configuration<\/td><\/tr>
get-redis-master<\/td>Get connection details to Redis master<\/td><\/tr>
remove-accounts<\/td>Delete all<\/em> users and groups used by this package<\/td><\/tr>
reset-grafana<\/td>Reset Grafana instance to its initial state by removing the data directory<\/td><\/tr>
set-grafana-password<\/td>Reset admin password for Grafana<\/td><\/tr>
upgrade<\/td>Run migrations after a package upgrade<\/td><\/tr>
upgrade-check<\/td>Check if the upgrade is acceptable<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

General Commands:<\/h2>\n\n\n\n
cleanse<\/td>Delete all<\/em> gitlab data, and start from scratch.<\/td><\/tr>
help<\/td>Print this help message.<\/td><\/tr>
reconfigure<\/td>Reconfigure the application.<\/td><\/tr>
show-config<\/td>Show the configuration that would be generated by reconfigure.<\/td><\/tr>
uninstall<\/td>Kill all processes and uninstall the process supervisor (data will be preserved).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Service Management Commands:<\/h2>\n\n\n\n
graceful-kill<\/td>Attempt a graceful stop, then SIGKILL the entire process group.<\/td><\/tr>
hup<\/td>Send the services a HUP.<\/td><\/tr>
int<\/td>Send the services an INT.<\/td><\/tr>
kill<\/td>Send the services a KILL.<\/td><\/tr>
once<\/td>Start the services if they are down. Do not restart them if they stop.<\/td><\/tr>
restart<\/td>Stop the services if they are running, then start them again.<\/td><\/tr>
service-list<\/td>List all the services (enabled services appear with a *.)<\/td><\/tr>
start<\/td>Start services if they are down, and restart them if they stop.<\/td><\/tr>
status<\/td>Show the status of all the services.<\/td><\/tr>
stop<\/td>Stop the services, and do not restart them.<\/td><\/tr>
tail<\/td>Watch the service logs of all enabled services.<\/td><\/tr>
term<\/td>Send the services a TERM.<\/td><\/tr>
usr1<\/td>Send the services a USR1.<\/td><\/tr>
usr2<\/td>Send the services a USR2.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Backup Commands:<\/h2>\n\n\n\n
backup-etc<\/td>Backup GitLab configuration [options]<\/td><\/tr>
<\/td><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Let’s Encrypt Commands:<\/h2>\n\n\n\n
renew-le-certs<\/td>Renew the existing Let’s Encrypt certificates<\/td><\/tr>
<\/td><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Database Commands:<\/h2>\n\n\n\n
get-postgresql-primary<\/td>Get connection details to the PostgreSQL primary<\/td><\/tr>
patroni<\/td>Interact with Patroni<\/td><\/tr>
pg-password-md5<\/td>Generate MD5 Hash of user password in PostgreSQL format<\/td><\/tr>
pg-upgrade<\/td>Upgrade the PostgreSQL DB to the latest supported version<\/td><\/tr>
revert-pg-upgrade<\/td>Run this to revert to the previous version of the database<\/td><\/tr>
set-replication-password<\/td>Set database replication password<\/td><\/tr>
write-pgpass<\/td>Write a pgpass file for the specified user<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Gitaly Commands:<\/h2>\n\n\n\n
praefect<\/td>Interact with Gitaly cluster<\/td><\/tr>
<\/td><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Container Registry Commands:<\/h2>\n\n\n\n
registry-garbage-collect<\/td>Run Container Registry garbage collection<\/td><\/tr>
<\/td><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Consul Commands:<\/h2>\n\n\n\n
consul<\/td>Interact with the gitlab-consul cluster<\/td><\/tr>
<\/td><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Gitlab Geo Commands:<\/h2>\n\n\n\n
geo<\/td>Interact with Geo<\/td><\/tr>
geo-replication-pause<\/td>Replication Process<\/td><\/tr>
geo-replication-resume<\/td>Replication Process<\/td><\/tr>
promotion-preflight-checks<\/td>Run preflight checks for promotion to primary node<\/td><\/tr>
replicate-geo-database<\/td>Replicate Geo database<\/td><\/tr>
set-geo-primary-node<\/td>Make this node the Geo primary<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Pgbouncer Commands:<\/h2>\n\n\n\n
pgb-console<\/td>Connect to the pgbouncer console<\/td><\/tr>
pgb-kill<\/td>Send the “resume” command to pgbouncer<\/td><\/tr>
pgb-notify<\/td>Notify pgbouncer of an update to its database<\/td><\/tr>
pgb-resume<\/td>Send the “resume” command to pgbouncer<\/td><\/tr>
pgb-suspend<\/td>Send the “suspend” command to pgbouncer<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"

omnibus-ctl: command (subcommand) check-config Check if there are any configuration in gitlab.rb that is removed in specified version deploy-page Put up the deploy page diff-config Compare the user configuration with package available configuration get-redis-master Get connection details to Redis master remove-accounts Delete all users and groups used by this package reset-grafana Reset Grafana instance to…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"_kad_post_classname":"","_joinchat":[],"footnotes":""},"categories":[2],"tags":[],"class_list":["post-31117","post","type-post","status-publish","format-standard","hentry","category-uncategorised"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/31117","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=31117"}],"version-history":[{"count":3,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/31117\/revisions"}],"predecessor-version":[{"id":31120,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/31117\/revisions\/31120"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=31117"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=31117"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=31117"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}