File tree Expand file tree Collapse file tree 2 files changed +5
-4
lines changed
Expand file tree Collapse file tree 2 files changed +5
-4
lines changed Original file line number Diff line number Diff line change @@ -22,15 +22,16 @@ var (
2222// rootCmd represents the base command when called without any subcommands
2323var rootCmd = & cobra.Command {
2424 Use : "waitfor" ,
25- Short : "This tool waits for kubernetes pods or jobs to be ready" ,
26- Long : `This tool waits for kubernetes pods or jobs to be ready
27-
25+ Short : "This tool waits for kubernetes pods or jobs and SQL databases to be ready" ,
26+ Long : `This tool waits for kubernetes pods or jobs and SQL databases to be ready
27+
2828a common usecase is to use it as init container to wait for other pods to be ready before starting the main application.
2929For example waiting for a database to be ready before starting the app to prevent errors.
3030
3131Example:
3232 waitfor pod -n vault -l app.kubernetes.io/instance=vault
3333 waitfor job -n snipeit -l job=generate-app-key
34+ waitfor sql -u root -p mysecretpassword -s mariadb.mydatabase.cluster.local -d mydb
3435` ,
3536}
3637
Original file line number Diff line number Diff line change @@ -18,7 +18,7 @@ import (
1818var sqlCmd = & cobra.Command {
1919 Use : "sql" ,
2020 Short : "Wait for SQL connection" ,
21- Long : `Wait for SQL connection until available
21+ Long : `wait for SQL connection until available
2222
2323Simple example:
2424 waitfor sql -u root -p mysecretpassword -s mariadb.mydatabase.cluster.local -d mydb
You can’t perform that action at this time.
0 commit comments