GitLab Tutorials: gitlab-ctl commands reference & example

omnibus-ctl: command (subcommand)

check-configCheck if there are any configuration in gitlab.rb that is removed in specified version
deploy-pagePut up the deploy page
diff-configCompare the user configuration with package available configuration
get-redis-masterGet connection details to Redis master
remove-accountsDelete all users and groups used by this package
reset-grafanaReset Grafana instance to its initial state by removing the data directory
set-grafana-passwordReset admin password for Grafana
upgradeRun migrations after a package upgrade
upgrade-checkCheck if the upgrade is acceptable

General Commands:

cleanseDelete all gitlab data, and start from scratch.
helpPrint this help message.
reconfigureReconfigure the application.
show-configShow the configuration that would be generated by reconfigure.
uninstallKill all processes and uninstall the process supervisor (data will be preserved).

Service Management Commands:

graceful-killAttempt a graceful stop, then SIGKILL the entire process group.
hupSend the services a HUP.
intSend the services an INT.
killSend the services a KILL.
onceStart the services if they are down. Do not restart them if they stop.
restartStop the services if they are running, then start them again.
service-listList all the services (enabled services appear with a *.)
startStart services if they are down, and restart them if they stop.
statusShow the status of all the services.
stopStop the services, and do not restart them.
tailWatch the service logs of all enabled services.
termSend the services a TERM.
usr1Send the services a USR1.
usr2Send the services a USR2.

Backup Commands:

backup-etcBackup GitLab configuration [options]

Let’s Encrypt Commands:

renew-le-certsRenew the existing Let’s Encrypt certificates

Database Commands:

get-postgresql-primaryGet connection details to the PostgreSQL primary
patroniInteract with Patroni
pg-password-md5Generate MD5 Hash of user password in PostgreSQL format
pg-upgradeUpgrade the PostgreSQL DB to the latest supported version
revert-pg-upgradeRun this to revert to the previous version of the database
set-replication-passwordSet database replication password
write-pgpassWrite a pgpass file for the specified user

Gitaly Commands:

praefectInteract with Gitaly cluster

Container Registry Commands:

registry-garbage-collectRun Container Registry garbage collection

Consul Commands:

consulInteract with the gitlab-consul cluster

Gitlab Geo Commands:

geoInteract with Geo
geo-replication-pauseReplication Process
geo-replication-resumeReplication Process
promotion-preflight-checksRun preflight checks for promotion to primary node
replicate-geo-databaseReplicate Geo database
set-geo-primary-nodeMake this node the Geo primary

Pgbouncer Commands:

pgb-consoleConnect to the pgbouncer console
pgb-killSend the “resume” command to pgbouncer
pgb-notifyNotify pgbouncer of an update to its database
pgb-resumeSend the “resume” command to pgbouncer
pgb-suspendSend the “suspend” command to pgbouncer
Rajesh Kumar
Follow me
Latest posts by Rajesh Kumar (see all)
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x