зеркало из https://github.com/github/vitess-gh.git
Port vtorc CLI to servenv and pflag (#10911)
* Port vtorc CLI to servenv and pflag This is a mea culpa on my part; we missed this one before the v14 ship date (because I was unsure the status of vtorc GA and forgot to ask). Consequently, we have to do some extra work to avoid breaking compatibility. Therefore, I introduce a function to inline transform the args passed by the user on the CLI from those that worked with stdlib flag into those that work with pflag. If there is a diff, we print a warning to the user so they know how to update their invocation, so they don't experience issues when we drop this shim code in v16. Signed-off-by: Andrew Mason <andrew@planetscale.com> * fix help text and parsing Signed-off-by: Andrew Mason <andrew@planetscale.com> * fixup! wip: port vtorc CLI to servenv and pflag Signed-off-by: Andrew Mason <andrew@planetscale.com> * Add documentation to the transformation func Signed-off-by: Andrew Mason <andrew@planetscale.com> * fix flag name Signed-off-by: Andrew Mason <andrew@planetscale.com> * Remove app.HelpCommand branches, which describe unsupported functionality Signed-off-by: Andrew Mason <andrew@planetscale.com> * More cleanup: remove HelpCommand and associated code Signed-off-by: Andrew Mason <andrew@planetscale.com> Co-authored-by: Matt Lord <mattalord@gmail.com>
This commit is contained in:
Andrew Mason
GitHub
Родитель
4ecdfec03e
Коммит
e2851b69b6
|
|
@ -17,15 +17,21 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"flag"
|
||||
"os"
|
||||
"reflect"
|
||||
"strings"
|
||||
|
||||
_ "github.com/go-sql-driver/mysql"
|
||||
_ "github.com/mattn/go-sqlite3"
|
||||
"github.com/spf13/pflag"
|
||||
|
||||
"vitess.io/vitess/go/vt/orchestrator/app"
|
||||
"vitess.io/vitess/go/vt/orchestrator/config"
|
||||
"vitess.io/vitess/go/vt/orchestrator/external/golib/log"
|
||||
"vitess.io/vitess/go/vt/orchestrator/inst"
|
||||
"vitess.io/vitess/go/vt/servenv"
|
||||
|
||||
_flag "vitess.io/vitess/go/internal/flag"
|
||||
)
|
||||
|
||||
var (
|
||||
|
|
@ -33,30 +39,123 @@ var (
|
|||
AppVersion string
|
||||
)
|
||||
|
||||
// main is the application's entry point. It will either spawn a CLI or HTTP itnerfaces.
|
||||
// transformArgsForPflag turns a slice of raw args passed on the command line,
|
||||
// possibly incompatible with pflag (because the user is expecting stdlib flag
|
||||
// parsing behavior) and transforms them into the arguments that should have
|
||||
// been passed to conform to pflag parsing behavior.
|
||||
//
|
||||
// the primary function is to catch any cases where the user specified a longopt
|
||||
// with only a single hyphen (e.g. `-myflag`) and correct it to be
|
||||
// double-hyphenated.
|
||||
//
|
||||
// note that this transformation does _not_ actually validate the arguments; for
|
||||
// example if the user specifies `--myflag`, but the FlagSet has no such flag
|
||||
// defined, that will still appear in the returned result and will (correctly)
|
||||
// cause a parse error later on in `main`, at which point the CLI usage will
|
||||
// be printed.
|
||||
//
|
||||
// note also that this transformation is incomplete. pflag allows interspersing
|
||||
// of flag and positional arguments, whereas stdlib flag does not. however, for
|
||||
// vtorc specifically, with the exception of `vtorc help <topic>`, the CLI only
|
||||
// consumes flag arguments (in other words, there are no supported subcommands),
|
||||
// so this is a non-issue, and is not implemented here in order to make this
|
||||
// function a bit simpler.
|
||||
func transformArgsForPflag(fs *pflag.FlagSet, args []string) (result []string) {
|
||||
for i, arg := range args {
|
||||
switch {
|
||||
case arg == "--":
|
||||
// pflag stops parsing at `--`, so we're done transforming the CLI
|
||||
// arguments. Just append everything remaining and be done.
|
||||
result = append(result, args[i:]...)
|
||||
return result
|
||||
case strings.HasPrefix(arg, "--"):
|
||||
// Long-hand flag. Append it and continue.
|
||||
result = append(result, arg)
|
||||
case strings.HasPrefix(arg, "-"):
|
||||
// Most complex case. This is either:
|
||||
// 1. A legacy long-hand flag that needs a double-dash (e.g. `-myflag` => `--myflag`).
|
||||
// 2. One _or more_ pflag shortopts all shoved together (think `rm -rf` as `rm -r -f`).
|
||||
//
|
||||
// In the latter case, we don't need to do any transformations, but
|
||||
// in the former, we do.
|
||||
name := strings.SplitN(arg[1:], "=", 2)[0] // discard any potential value (`-myflag` and `-myflag=10` both have the name of `myflag`)
|
||||
if fs.Lookup(name) != nil {
|
||||
// Case 1: We have a long opt with this name, so we need to
|
||||
// prepend an additional hyphen.
|
||||
result = append(result, "-"+arg)
|
||||
} else {
|
||||
// Case 2: No transformation needed.
|
||||
result = append(result, arg)
|
||||
}
|
||||
default:
|
||||
// Just a flag argument. Nothing to transform.
|
||||
result = append(result, arg)
|
||||
}
|
||||
}
|
||||
|
||||
return result
|
||||
}
|
||||
|
||||
// main is the application's entry point. It will spawn an HTTP interface.
|
||||
func main() {
|
||||
// TODO(sougou): change this to use vitess servenv framework
|
||||
// TODO(sougou): remove cli code
|
||||
configFile := flag.String("config", "", "config file name")
|
||||
sibling := flag.String("s", "", "sibling instance, host_fqdn[:port]")
|
||||
destination := flag.String("d", "", "destination instance, host_fqdn[:port] (synonym to -s)")
|
||||
discovery := flag.Bool("discovery", true, "auto discovery mode")
|
||||
quiet := flag.Bool("quiet", false, "quiet")
|
||||
verbose := flag.Bool("verbose", false, "verbose")
|
||||
debug := flag.Bool("debug", false, "debug mode (very verbose)")
|
||||
stack := flag.Bool("stack", false, "add stack trace upon error")
|
||||
config.RuntimeCLIFlags.SkipUnresolve = flag.Bool("skip-unresolve", false, "Do not unresolve a host name")
|
||||
config.RuntimeCLIFlags.SkipUnresolveCheck = flag.Bool("skip-unresolve-check", false, "Skip/ignore checking an unresolve mapping (via hostname_unresolve table) resolves back to same hostname")
|
||||
config.RuntimeCLIFlags.Noop = flag.Bool("noop", false, "Dry run; do not perform destructing operations")
|
||||
config.RuntimeCLIFlags.BinlogFile = flag.String("binlog", "", "Binary log file name")
|
||||
config.RuntimeCLIFlags.Statement = flag.String("statement", "", "Statement/hint")
|
||||
config.RuntimeCLIFlags.GrabElection = flag.Bool("grab-election", false, "Grab leadership (only applies to continuous mode)")
|
||||
config.RuntimeCLIFlags.PromotionRule = flag.String("promotion-rule", "prefer", "Promotion rule for register-andidate (prefer|neutral|prefer_not|must_not)")
|
||||
config.RuntimeCLIFlags.SkipContinuousRegistration = flag.Bool("skip-continuous-registration", false, "Skip cli commands performaing continuous registration (to reduce orchestratrator backend db load")
|
||||
config.RuntimeCLIFlags.EnableDatabaseUpdate = flag.Bool("enable-database-update", false, "Enable database update, overrides SkipOrchestratorDatabaseUpdate")
|
||||
config.RuntimeCLIFlags.IgnoreRaftSetup = flag.Bool("ignore-raft-setup", false, "Override RaftEnabled for CLI invocation (CLI by default not allowed for raft setups). NOTE: operations by CLI invocation may not reflect in all raft nodes.")
|
||||
config.RuntimeCLIFlags.Tag = flag.String("tag", "", "tag to add ('tagname' or 'tagname=tagvalue') or to search ('tagname' or 'tagname=tagvalue' or comma separated 'tag0,tag1=val1,tag2' for intersection of all)")
|
||||
flag.Parse()
|
||||
// TODO(ajm188): after v15, remove this pflag hack and use servenv.ParseFlags
|
||||
// directly.
|
||||
fs := pflag.NewFlagSet("vtorc", pflag.ExitOnError)
|
||||
|
||||
args := append([]string{}, os.Args...)
|
||||
os.Args = os.Args[0:1]
|
||||
servenv.ParseFlags("vtorc")
|
||||
|
||||
// N.B. This code has to be duplicated from go/internal/flag in order to
|
||||
// correctly transform `-help` => `--help`. Otherwise passing `-help` would
|
||||
// produce:
|
||||
// unknown shorthand flag: 'e' in -elp
|
||||
var help bool
|
||||
if fs.Lookup("help") == nil {
|
||||
if fs.ShorthandLookup("h") == nil {
|
||||
fs.BoolVarP(&help, "help", "h", false, "display usage and exit")
|
||||
} else {
|
||||
fs.BoolVar(&help, "help", false, "display usage and exit")
|
||||
}
|
||||
}
|
||||
|
||||
configFile := fs.String("config", "", "config file name")
|
||||
sibling := fs.StringP("sibling", "s", "", "sibling instance, host_fqdn[:port]")
|
||||
destination := fs.StringP("destination", "d", "", "destination instance, host_fqdn[:port] (synonym to -s)")
|
||||
discovery := fs.Bool("discovery", true, "auto discovery mode")
|
||||
quiet := fs.Bool("quiet", false, "quiet")
|
||||
verbose := fs.Bool("verbose", false, "verbose")
|
||||
debug := fs.Bool("debug", false, "debug mode (very verbose)")
|
||||
stack := fs.Bool("stack", false, "add stack trace upon error")
|
||||
config.RuntimeCLIFlags.SkipUnresolve = fs.Bool("skip-unresolve", false, "Do not unresolve a host name")
|
||||
config.RuntimeCLIFlags.SkipUnresolveCheck = fs.Bool("skip-unresolve-check", false, "Skip/ignore checking an unresolve mapping (via hostname_unresolve table) resolves back to same hostname")
|
||||
config.RuntimeCLIFlags.Noop = fs.Bool("noop", false, "Dry run; do not perform destructing operations")
|
||||
config.RuntimeCLIFlags.BinlogFile = fs.String("binlog", "", "Binary log file name")
|
||||
config.RuntimeCLIFlags.Statement = fs.String("statement", "", "Statement/hint")
|
||||
config.RuntimeCLIFlags.GrabElection = fs.Bool("grab-election", false, "Grab leadership (only applies to continuous mode)")
|
||||
config.RuntimeCLIFlags.PromotionRule = fs.String("promotion-rule", "prefer", "Promotion rule for register-andidate (prefer|neutral|prefer_not|must_not)")
|
||||
config.RuntimeCLIFlags.SkipContinuousRegistration = fs.Bool("skip-continuous-registration", false, "Skip cli commands performaing continuous registration (to reduce orchestratrator backend db load")
|
||||
config.RuntimeCLIFlags.EnableDatabaseUpdate = fs.Bool("enable-database-update", false, "Enable database update, overrides SkipOrchestratorDatabaseUpdate")
|
||||
config.RuntimeCLIFlags.IgnoreRaftSetup = fs.Bool("ignore-raft-setup", false, "Override RaftEnabled for CLI invocation (CLI by default not allowed for raft setups). NOTE: operations by CLI invocation may not reflect in all raft nodes.")
|
||||
config.RuntimeCLIFlags.Tag = fs.String("tag", "", "tag to add ('tagname' or 'tagname=tagvalue') or to search ('tagname' or 'tagname=tagvalue' or comma separated 'tag0,tag1=val1,tag2' for intersection of all)")
|
||||
|
||||
os.Args = append(os.Args, transformArgsForPflag(fs, args[1:])...)
|
||||
if !reflect.DeepEqual(args, os.Args) {
|
||||
// warn the user so they can adjust their CLI scripts
|
||||
warning := `CLI args passed do not conform to pflag parsing behavior
|
||||
The arguments have been transformed for compatibility as follows:
|
||||
%v => %v
|
||||
Please update your scripts before the next version, when this will begin to break.
|
||||
`
|
||||
log.Warningf(warning, args, os.Args)
|
||||
}
|
||||
|
||||
_flag.Parse(fs)
|
||||
// N.B. Also duplicated from go/internal/flag, for the same reason as above.
|
||||
if help || fs.Arg(0) == "help" {
|
||||
pflag.Usage()
|
||||
os.Exit(0)
|
||||
}
|
||||
|
||||
if *destination != "" && *sibling != "" {
|
||||
log.Fatalf("-s and -d are synonyms, yet both were specified. You're probably doing the wrong thing.")
|
||||
|
|
@ -68,7 +167,7 @@ func main() {
|
|||
}
|
||||
default:
|
||||
{
|
||||
log.Fatalf("-promotion-rule only supports prefer|neutral|prefer_not|must_not")
|
||||
log.Fatalf("--promotion-rule only supports prefer|neutral|prefer_not|must_not")
|
||||
}
|
||||
}
|
||||
if *destination == "" {
|
||||
|
|
@ -120,17 +219,5 @@ func main() {
|
|||
config.RuntimeCLIFlags.ConfiguredVersion = AppVersion
|
||||
config.MarkConfigurationLoaded()
|
||||
|
||||
helpTopic := ""
|
||||
if flag.Arg(0) == "help" {
|
||||
if flag.Arg(1) != "" {
|
||||
helpTopic = flag.Arg(1)
|
||||
}
|
||||
}
|
||||
|
||||
switch {
|
||||
case helpTopic != "":
|
||||
app.HelpCommand(helpTopic)
|
||||
default:
|
||||
app.HTTP(*discovery)
|
||||
}
|
||||
app.HTTP(*discovery)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,48 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/spf13/pflag"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func Test_transformArgsForPflag(t *testing.T) {
|
||||
fs := pflag.NewFlagSet("test", pflag.ContinueOnError)
|
||||
fs.String("foobar", "baz", "")
|
||||
fs.StringP("name", "n", "", "")
|
||||
fs.BoolP("debug", "d", true, "")
|
||||
|
||||
tests := []struct {
|
||||
args []string
|
||||
transformed []string
|
||||
}{
|
||||
{
|
||||
args: []string{"--foobar=hello", "--name", "myname", "-d"},
|
||||
transformed: []string{"--foobar=hello", "--name", "myname", "-d"},
|
||||
},
|
||||
{
|
||||
args: []string{"-foobar=hello", "-name", "myname", "-d"},
|
||||
transformed: []string{"--foobar=hello", "--name", "myname", "-d"},
|
||||
},
|
||||
{
|
||||
args: []string{"--", "-foobar=hello"},
|
||||
transformed: []string{"--", "-foobar=hello"},
|
||||
},
|
||||
{
|
||||
args: []string{"-dn"}, // combined shortopts
|
||||
transformed: []string{"-dn"},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
tt := tt
|
||||
name := strings.Join(tt.args, " ")
|
||||
|
||||
t.Run(name, func(t *testing.T) {
|
||||
got := transformArgsForPflag(fs, tt.args)
|
||||
assert.Equal(t, tt.transformed, got)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
@ -14,11 +14,6 @@ func init() {
|
|||
log.SetLevel(log.ERROR)
|
||||
}
|
||||
|
||||
func TestHelp(t *testing.T) {
|
||||
Cli("help", false, "localhost:9999", "localhost:9999", "orc", "no-reason", "1m", ".", "no-alias", "no-pool", "")
|
||||
test.S(t).ExpectTrue(len(knownCommands) > 0)
|
||||
}
|
||||
|
||||
func TestKnownCommands(t *testing.T) {
|
||||
Cli("help", false, "localhost:9999", "localhost:9999", "orc", "no-reason", "1m", ".", "no-alias", "no-pool", "")
|
||||
|
||||
|
|
|
|||
|
|
@ -1,811 +0,0 @@
|
|||
/*
|
||||
Copyright 2016 GitHub Inc.
|
||||
See https://github.com/openark/orchestrator/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
package app
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
)
|
||||
|
||||
const AppPrompt string = `
|
||||
orchestrator [-c command] [-i instance] [-d destination] [--verbose|--debug] [... cli ] | http
|
||||
|
||||
Cheatsheet:
|
||||
Run orchestrator in HTTP mode:
|
||||
|
||||
orchestrator --debug http
|
||||
|
||||
See all possible commands:
|
||||
|
||||
orchestrator help
|
||||
|
||||
Detailed help for a given command (e.g. "relocate")
|
||||
|
||||
orchestrator help relocate
|
||||
`
|
||||
|
||||
var CommandHelp map[string]string
|
||||
|
||||
func init() {
|
||||
CommandHelp = make(map[string]string)
|
||||
CommandHelp["relocate"] = `
|
||||
Relocate a replica beneath another (destination) instance. The choice of destination is almost arbitrary;
|
||||
it must not be a child/descendant of the instance, but otherwise it can be anywhere, and can be a normal replica
|
||||
or a binlog server. Orchestrator will choose the best course of action to relocate the replica.
|
||||
No action taken when destination instance cannot act as primary (e.g. has no binary logs, is of incompatible version, incompatible binlog format etc.)
|
||||
Examples:
|
||||
|
||||
orchestrator -c relocate -i replica.to.relocate.com -d instance.that.becomes.its.primary
|
||||
|
||||
orchestrator -c relocate -d destination.instance.that.becomes.its.primary
|
||||
-i not given, implicitly assumed local hostname
|
||||
|
||||
(this command was previously named "relocate-below")
|
||||
`
|
||||
CommandHelp["relocate-replicas"] = `
|
||||
Relocates all or part of the replicas of a given instance under another (destination) instance. This is
|
||||
typically much faster than relocating replicas one by one.
|
||||
Orchestrator chooses the best course of action to relocation the replicas. It may choose a multi-step operations.
|
||||
Some replicas may succeed and some may fail the operation.
|
||||
The instance (replicas' primary) itself may be crashed or inaccessible. It is not contacted throughout the operation.
|
||||
Examples:
|
||||
|
||||
orchestrator -c relocate-replicas -i instance.whose.replicas.will.relocate -d instance.that.becomes.their.primary
|
||||
|
||||
orchestrator -c relocate-replicas -i instance.whose.replicas.will.relocate -d instance.that.becomes.their.primary --pattern=regexp.filter
|
||||
only apply to those instances that match given regex
|
||||
`
|
||||
CommandHelp["move-up-replicas"] = `
|
||||
Moves replicas of the given instance one level up the topology, making them siblings of given instance.
|
||||
This is a (faster) shortcut to executing move-up on all replicas of given instance.
|
||||
Examples:
|
||||
|
||||
orchestrator -c move-up-replicas -i replica.whose.subreplicas.will.move.up.com[:3306]
|
||||
|
||||
orchestrator -c move-up-replicas -i replica.whose.subreplicas.will.move.up.com[:3306] --pattern=regexp.filter
|
||||
only apply to those instances that match given regex
|
||||
`
|
||||
CommandHelp["move-below"] = `
|
||||
Moves a replica beneath its sibling. Both replicas must be actively replicating from same primary.
|
||||
The sibling will become instance's primary. No action taken when sibling cannot act as primary
|
||||
(e.g. has no binary logs, is of incompatible version, incompatible binlog format etc.)
|
||||
Example:
|
||||
|
||||
orchestrator -c move-below -i replica.to.move.com -d sibling.replica.under.which.to.move.com
|
||||
|
||||
orchestrator -c move-below -d sibling.replica.under.which.to.move.com
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["take-primary"] = `
|
||||
Turn an instance into a primary of its own primary; essentially switch the two. Replicas of each of the two
|
||||
involved instances are unaffected, and continue to replicate as they were.
|
||||
The instance's primary must itself be a replica. It does not necessarily have to be actively replicating.
|
||||
|
||||
orchestrator -c take-primary -i replica.that.will.switch.places.with.its.primary.com
|
||||
`
|
||||
CommandHelp["repoint"] = `
|
||||
Make the given instance replicate from another instance without changing the binglog coordinates. There
|
||||
are little sanity checks to this and this is a risky operation. Use cases are: a rename of the primary's
|
||||
host, a corruption in relay-logs, move from beneath Binlog-server. Examples:
|
||||
|
||||
orchestrator -c repoint -i replica.to.operate.on.com -d new.primary.com
|
||||
|
||||
orchestrator -c repoint -i replica.to.operate.on.com
|
||||
The above will repoint the replica back to its existing primary without change
|
||||
|
||||
orchestrator -c repoint
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["repoint-replicas"] = `
|
||||
Repoint all replicas of given instance to replicate back from the instance. This is a convenience method
|
||||
which implies a one-by-one "repoint" command on each replica.
|
||||
|
||||
orchestrator -c repoint-replicas -i instance.whose.replicas.will.be.repointed.com
|
||||
|
||||
orchestrator -c repoint-replicas
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["make-co-primary"] = `
|
||||
Create a primary-primary replication. Given instance is a replica which replicates directly from a primary.
|
||||
The primary is then turned to be a replica of the instance. The primary is expected to not be a replica.
|
||||
The read_only property of the slve is unaffected by this operation. Examples:
|
||||
|
||||
orchestrator -c make-co-primary -i replica.to.turn.into.co.primary.com
|
||||
|
||||
orchestrator -c make-co-primary
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["get-candidate-replica"] = `
|
||||
Information command suggesting the most up-to-date replica of a given instance, which can be promoted
|
||||
as local primary to its siblings. If replication is up and running, this command merely gives an
|
||||
estimate, since replicas advance and progress continuously in different pace. If all replicas of given
|
||||
instance have broken replication (e.g. because given instance is dead), then this command provides
|
||||
with a definitve candidate, which could act as a replace primary. See also regroup-replicas. Example:
|
||||
|
||||
orchestrator -c get-candidate-replica -i instance.with.replicas.one.of.which.may.be.candidate.com
|
||||
`
|
||||
CommandHelp["regroup-replicas-bls"] = `
|
||||
Given an instance that has Binlog Servers for replicas, promote one such Binlog Server over its other
|
||||
Binlog Server siblings.
|
||||
|
||||
Example:
|
||||
|
||||
orchestrator -c regroup-replicas-bls -i instance.with.binlog.server.replicas.com
|
||||
|
||||
--debug is your friend.
|
||||
`
|
||||
CommandHelp["move-gtid"] = `
|
||||
Move a replica beneath another (destination) instance. Orchestrator will reject the operation if GTID is
|
||||
not enabled on the replica, or is not supported by the would-be primary.
|
||||
You may try and move the replica under any other instance; there are no constraints on the family ties the
|
||||
two may have, though you should be careful as not to try and replicate from a descendant (making an
|
||||
impossible loop).
|
||||
Examples:
|
||||
|
||||
orchestrator -c move-gtid -i replica.to.move.com -d instance.that.becomes.its.primary
|
||||
|
||||
orchestrator -c match -d destination.instance.that.becomes.its.primary
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["move-replicas-gtid"] = `
|
||||
Moves all replicas of a given instance under another (destination) instance using GTID. This is a (faster)
|
||||
shortcut to moving each replica via "move-gtid".
|
||||
Orchestrator will only move those replica configured with GTID (either Oracle or MariaDB variants) and under the
|
||||
condition the would-be primary supports GTID.
|
||||
Examples:
|
||||
|
||||
orchestrator -c move-replicas-gtid -i instance.whose.replicas.will.relocate -d instance.that.becomes.their.primary
|
||||
|
||||
orchestrator -c move-replicas-gtid -i instance.whose.replicas.will.relocate -d instance.that.becomes.their.primary --pattern=regexp.filter
|
||||
only apply to those instances that match given regex
|
||||
`
|
||||
CommandHelp["regroup-replicas-gtid"] = `
|
||||
Given an instance (possibly a crashed one; it is never being accessed), pick one of its replica and make it
|
||||
local primary of its siblings, using GTID. The rules are similar to those in the "regroup-replicas" command.
|
||||
Example:
|
||||
|
||||
orchestrator -c regroup-replicas-gtid -i instance.with.gtid.and.replicas.one.of.which.will.turn.local.primary.if.possible
|
||||
|
||||
--debug is your friend.
|
||||
`
|
||||
CommandHelp["match"] = `
|
||||
Matches a replica beneath another (destination) instance. The choice of destination is almost arbitrary;
|
||||
it must not be a child/descendant of the instance. But otherwise they don't have to be direct siblings,
|
||||
and in fact (if you know what you're doing), they don't actually have to belong to the same topology.
|
||||
The operation expects the relocated instance to be "behind" the destination instance. It only finds out
|
||||
whether this is the case by the end; the operation is cancelled in the event this is not the case.
|
||||
No action taken when destination instance cannot act as primary (e.g. has no binary logs, is of incompatible version, incompatible binlog format etc.)
|
||||
Examples:
|
||||
|
||||
orchestrator -c match -i replica.to.relocate.com -d instance.that.becomes.its.primary
|
||||
|
||||
orchestrator -c match -d destination.instance.that.becomes.its.primary
|
||||
-i not given, implicitly assumed local hostname
|
||||
|
||||
(this command was previously named "match-below")
|
||||
`
|
||||
CommandHelp["match-replicas"] = `
|
||||
Matches all replicas of a given instance under another (destination) instance. This is a (faster) shortcut
|
||||
to matching said replicas one by one under the destination instance. In fact, this bulk operation is highly
|
||||
optimized and can execute in orders of magnitue faster, depeding on the nu,ber of replicas involved and their
|
||||
respective position behind the instance (the more replicas, the more savings).
|
||||
The instance itself may be crashed or inaccessible. It is not contacted throughout the operation. Examples:
|
||||
|
||||
orchestrator -c match-replicas -i instance.whose.replicas.will.relocate -d instance.that.becomes.their.primary
|
||||
|
||||
orchestrator -c match-replicas -i instance.whose.replicas.will.relocate -d instance.that.becomes.their.primary --pattern=regexp.filter
|
||||
only apply to those instances that match given regex
|
||||
|
||||
(this command was previously named "multi-match-replicas")
|
||||
`
|
||||
CommandHelp["enable-gtid"] = `
|
||||
If possible, enable GTID replication. This works on Oracle (>= 5.6, gtid-mode=1) and MariaDB (>= 10.0).
|
||||
Replication is stopped for a short duration so as to reconfigure as GTID. In case of error replication remains
|
||||
stopped. Example:
|
||||
|
||||
orchestrator -c enable-gtid -i replica.compatible.with.gtid.com
|
||||
`
|
||||
CommandHelp["disable-gtid"] = `
|
||||
Assuming replica replicates via GTID, disable GTID replication and resume standard file:pos replication. Example:
|
||||
|
||||
orchestrator -c disable-gtid -i replica.replicating.via.gtid.com
|
||||
`
|
||||
CommandHelp["reset-primary-gtid-remove-own-uuid"] = `
|
||||
Assuming GTID is enabled, Reset primary on instance, remove GTID entries generated by the instance.
|
||||
This operation is only allowed on Oracle-GTID enabled servers that have no replicas.
|
||||
Is is used for cleaning up the GTID mess incurred by mistakenly issuing queries on the replica (even such
|
||||
queries as "FLUSH ENGINE LOGS" that happen to write to binary logs). Example:
|
||||
|
||||
orchestrator -c reset-primary-gtid-remove-own-uuid -i replica.running.with.gtid.com
|
||||
`
|
||||
CommandHelp["stop-replica"] = `
|
||||
Issues a STOP SLAVE; command. Example:
|
||||
|
||||
orchestrator -c stop-replica -i replica.to.be.stopped.com
|
||||
`
|
||||
CommandHelp["start-replica"] = `
|
||||
Issues a START SLAVE; command. Example:
|
||||
|
||||
orchestrator -c start-replica -i replica.to.be.started.com
|
||||
`
|
||||
CommandHelp["restart-replica"] = `
|
||||
Issues STOP SLAVE + START SLAVE; Example:
|
||||
|
||||
orchestrator -c restart-replica -i replica.to.be.started.com
|
||||
`
|
||||
CommandHelp["skip-query"] = `
|
||||
On a failed replicating replica, skips a single query and attempts to resume replication.
|
||||
Only applies when the replication seems to be broken on SQL thread (e.g. on duplicate
|
||||
key error). Also works in GTID mode. Example:
|
||||
|
||||
orchestrator -c skip-query -i replica.with.broken.sql.thread.com
|
||||
`
|
||||
CommandHelp["reset-replica"] = `
|
||||
Issues a RESET SLAVE command. Destructive to replication. Example:
|
||||
|
||||
orchestrator -c reset-replica -i replica.to.reset.com
|
||||
`
|
||||
CommandHelp["detach-replica"] = `
|
||||
Stops replication and modifies binlog position into an impossible, yet reversible, value.
|
||||
This effectively means the replication becomes broken. See reattach-replica. Example:
|
||||
|
||||
orchestrator -c detach-replica -i replica.whose.replication.will.break.com
|
||||
|
||||
Issuing this on an already detached replica will do nothing.
|
||||
`
|
||||
CommandHelp["reattach-replica"] = `
|
||||
Undo a detach-replica operation. Reverses the binlog change into the original values, and
|
||||
resumes replication. Example:
|
||||
|
||||
orchestrator -c reattach-replica -i detahced.replica.whose.replication.will.amend.com
|
||||
|
||||
Issuing this on an attached (i.e. normal) replica will do nothing.
|
||||
`
|
||||
CommandHelp["detach-replica-primary-host"] = `
|
||||
Stops replication and modifies Master_Host into an impossible, yet reversible, value.
|
||||
This effectively means the replication becomes broken. See reattach-replica-primary-host. Example:
|
||||
|
||||
orchestrator -c detach-replica-primary-host -i replica.whose.replication.will.break.com
|
||||
|
||||
Issuing this on an already detached replica will do nothing.
|
||||
`
|
||||
CommandHelp["reattach-replica-primary-host"] = `
|
||||
Undo a detach-replica-primary-host operation. Reverses the hostname change into the original value, and
|
||||
resumes replication. Example:
|
||||
|
||||
orchestrator -c reattach-replica-primary-host -i detahced.replica.whose.replication.will.amend.com
|
||||
|
||||
Issuing this on an attached (i.e. normal) replica will do nothing.
|
||||
`
|
||||
CommandHelp["restart-replica-statements"] = `
|
||||
Prints a list of statements to execute to stop then restore replica to same execution state.
|
||||
Provide --statement for injected statement.
|
||||
This is useful for issuing a command that can only be executed while replica is stopped. Such
|
||||
commands are any of CHANGE MASTER TO.
|
||||
Orchestrator will not execute given commands, only print them as courtesy. It may not have
|
||||
the privileges to execute them in the first place. Example:
|
||||
|
||||
orchestrator -c restart-replica-statements -i some.replica.com -statement="change master to master_heartbeat_period=5"
|
||||
`
|
||||
|
||||
CommandHelp["set-read-only"] = `
|
||||
Turn an instance read-only, via SET GLOBAL read_only := 1. Examples:
|
||||
|
||||
orchestrator -c set-read-only -i instance.to.turn.read.only.com
|
||||
|
||||
orchestrator -c set-read-only
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["set-writeable"] = `
|
||||
Turn an instance writeable, via SET GLOBAL read_only := 0. Example:
|
||||
|
||||
orchestrator -c set-writeable -i instance.to.turn.writeable.com
|
||||
|
||||
orchestrator -c set-writeable
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
|
||||
CommandHelp["flush-binary-logs"] = `
|
||||
Flush binary logs on an instance. Examples:
|
||||
|
||||
orchestrator -c flush-binary-logs -i instance.with.binary.logs.com
|
||||
|
||||
orchestrator -c flush-binary-logs -i instance.with.binary.logs.com --binlog=mysql-bin.002048
|
||||
Flushes binary logs until reaching given number. Fails when current number is larger than input
|
||||
`
|
||||
CommandHelp["purge-binary-logs"] = `
|
||||
Purge binary logs on an instance. Examples:
|
||||
|
||||
orchestrator -c purge-binary-logs -i instance.with.binary.logs.com --binlog mysql-bin.002048
|
||||
|
||||
Purges binary logs until given log
|
||||
`
|
||||
CommandHelp["submit-pool-instances"] = `
|
||||
Submit a pool name with a list of instances in that pool. This removes any previous instances associated with
|
||||
that pool. Expecting comma delimited list of instances
|
||||
|
||||
orchestrator -c submit-pool-instances --pool name_of_pool -i pooled.instance1.com,pooled.instance2.com:3306,pooled.instance3.com
|
||||
`
|
||||
CommandHelp["cluster-pool-instances"] = `
|
||||
List all pools and their associated instances. Output is in tab delimited format, and lists:
|
||||
cluster_name, cluster_alias, pool_name, pooled instance
|
||||
Example:
|
||||
|
||||
orchestrator -c cluster-pool-instances
|
||||
`
|
||||
CommandHelp["which-heuristic-cluster-pool-instances"] = `
|
||||
List instances belonging to a cluster, which are also in some pool or in a specific given pool.
|
||||
Not all instances are listed: unreachable, downtimed instances ar left out. Only those that should be
|
||||
responsive and healthy are listed. This serves applications in getting information about instances
|
||||
that could be queried (this complements a proxy behavior in providing the *list* of instances).
|
||||
Examples:
|
||||
|
||||
orchestrator -c which-heuristic-cluster-pool-instances --alias mycluster
|
||||
Get the instances of a specific cluster, no specific pool
|
||||
|
||||
orchestrator -c which-heuristic-cluster-pool-instances --alias mycluster --pool some_pool
|
||||
Get the instances of a specific cluster and which belong to a given pool
|
||||
|
||||
orchestrator -c which-heuristic-cluster-pool-instances -i instance.belonging.to.a.cluster
|
||||
Cluster inferred by given instance
|
||||
|
||||
orchestrator -c which-heuristic-cluster-pool-instances
|
||||
Cluster inferred by local hostname
|
||||
`
|
||||
|
||||
CommandHelp["find"] = `
|
||||
Find instances whose hostname matches given regex pattern. Example:
|
||||
|
||||
orchestrator -c find -pattern "backup.*us-east"
|
||||
`
|
||||
CommandHelp["clusters"] = `
|
||||
List all clusters known to orchestrator. A cluster (aka topology, aka chain) is identified by its
|
||||
primary (or one of its primary if more than one exists). Example:
|
||||
|
||||
orchestrator -c clusters
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["all-clusters-primaries"] = `
|
||||
List of writeable primaries, one per cluster.
|
||||
For most single-primary topologies, this is trivially the primary.
|
||||
For active-active primary-primary topologies, this ensures only one of
|
||||
the primaries is returned. Example:
|
||||
|
||||
orchestrator -c all-clusters-primaries
|
||||
`
|
||||
CommandHelp["topology"] = `
|
||||
Show an ascii-graph of a replication topology, given a member of that topology. Example:
|
||||
|
||||
orchestrator -c topology -i instance.belonging.to.a.topology.com
|
||||
|
||||
orchestrator -c topology
|
||||
-i not given, implicitly assumed local hostname
|
||||
|
||||
Instance must be already known to orchestrator. Topology is generated by orchestrator's mapping
|
||||
and not from synchronuous investigation of the instances. The generated topology may include
|
||||
instances that are dead, or whose replication is broken.
|
||||
`
|
||||
CommandHelp["all-instances"] = `
|
||||
List the complete known set of instances. Similar to '-c find -pattern "."' Example:
|
||||
|
||||
orchestrator -c all-instances
|
||||
`
|
||||
CommandHelp["which-instance"] = `
|
||||
Output the fully-qualified hostname:port representation of the given instance, or error if unknown
|
||||
to orchestrator. Examples:
|
||||
|
||||
orchestrator -c which-instance -i instance.to.check.com
|
||||
|
||||
orchestrator -c which-instance
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["which-cluster"] = `
|
||||
Output the name of the cluster an instance belongs to, or error if unknown to orchestrator. Examples:
|
||||
|
||||
orchestrator -c which-cluster -i instance.to.check.com
|
||||
|
||||
orchestrator -c which-cluster
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["which-cluster-instances"] = `
|
||||
Output the list of instances participating in same cluster as given instance; output is one line
|
||||
per instance, in hostname:port format. Examples:
|
||||
|
||||
orchestrator -c which-cluster-instances -i instance.to.check.com
|
||||
|
||||
orchestrator -c which-cluster-instances
|
||||
-i not given, implicitly assumed local hostname
|
||||
|
||||
orchestrator -c which-cluster-instances -alias some_alias
|
||||
assuming some_alias is a known cluster alias (see ClusterNameToAlias or DetectClusterAliasQuery configuration)
|
||||
`
|
||||
CommandHelp["which-cluster-domain"] = `
|
||||
Output the domain name of given cluster, indicated by instance or alias. This depends on
|
||||
the DetectClusterDomainQuery configuration. Example:
|
||||
|
||||
orchestrator -c which-cluster-domain -i instance.to.check.com
|
||||
|
||||
orchestrator -c which-cluster-domain
|
||||
-i not given, implicitly assumed local hostname
|
||||
|
||||
orchestrator -c which-cluster-domain -alias some_alias
|
||||
assuming some_alias is a known cluster alias (see ClusterNameToAlias or DetectClusterAliasQuery configuration)
|
||||
`
|
||||
CommandHelp["which-heuristic-domain-instance"] = `
|
||||
Returns the instance associated as the cluster's writer with a cluster's domain name.
|
||||
Given a cluster, orchestrator looks for the domain name indicated by this cluster, and proceeds to search for
|
||||
a stord key-value attribute for that domain name. This would be the writer host for the given domain.
|
||||
See also set-heuristic-domain-instance, this is meant to be a temporary service mimicking in micro-scale a
|
||||
service discovery functionality.
|
||||
Example:
|
||||
|
||||
orchestrator -c which-heuristic-domain-instance -alias some_alias
|
||||
Detects the domain name for given cluster, reads from key-value store the writer host associated with the domain name.
|
||||
|
||||
orchestrator -c which-heuristic-domain-instance -i instance.of.some.cluster
|
||||
Cluster is inferred by a member instance (the instance is not necessarily the primary)
|
||||
`
|
||||
CommandHelp["which-cluster-primary"] = `
|
||||
Output the name of the active primary in a given cluster, indicated by instance or alias.
|
||||
An "active" primary is one that is writable and is not marked as downtimed due to a topology recovery.
|
||||
Examples:
|
||||
|
||||
orchestrator -c which-cluster-primary -i instance.to.check.com
|
||||
|
||||
orchestrator -c which-cluster-primary
|
||||
-i not given, implicitly assumed local hostname
|
||||
|
||||
orchestrator -c which-cluster-primary -alias some_alias
|
||||
assuming some_alias is a known cluster alias (see ClusterNameToAlias or DetectClusterAliasQuery configuration)
|
||||
`
|
||||
CommandHelp["which-cluster-osc-replicas"] = `
|
||||
Output a list of replicas in same cluster as given instance, that would server as good candidates as control replicas
|
||||
for a pt-online-schema-change operation.
|
||||
Those replicas would be used for replication delay so as to throtthe osc operation. Selected replicas will include,
|
||||
where possible: intermediate primaries, their replicas, 3rd level replicas, direct non-intermediate-primary replicas.
|
||||
|
||||
orchestrator -c which-cluster-osc-replicas -i instance.to.check.com
|
||||
|
||||
orchestrator -c which-cluster-osc-replicas
|
||||
-i not given, implicitly assumed local hostname
|
||||
|
||||
orchestrator -c which-cluster-osc-replicas -alias some_alias
|
||||
assuming some_alias is a known cluster alias (see ClusterNameToAlias or DetectClusterAliasQuery configuration)
|
||||
`
|
||||
CommandHelp["which-lost-in-recovery"] = `
|
||||
List instances marked as downtimed for being lost in a recovery process. The output of this command lists
|
||||
"lost" instances that probably should be recycled.
|
||||
The topology recovery process injects a magic hint when downtiming lost instances, that is picked up
|
||||
by this command. Examples:
|
||||
|
||||
orchestrator -c which-lost-in-recovery
|
||||
Lists all heuristically-recent known lost instances
|
||||
`
|
||||
CommandHelp["which-primary"] = `
|
||||
Output the fully-qualified hostname:port representation of a given instance's primary. Examples:
|
||||
|
||||
orchestrator -c which-primary -i a.known.replica.com
|
||||
|
||||
orchestrator -c which-primary
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["which-replicas"] = `
|
||||
Output the fully-qualified hostname:port list of replicas (one per line) of a given instance (or empty
|
||||
list if instance is not a primary to anyone). Examples:
|
||||
|
||||
orchestrator -c which-replicas -i a.known.instance.com
|
||||
|
||||
orchestrator -c which-replicas
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["get-cluster-heuristic-lag"] = `
|
||||
For a given cluster (indicated by an instance or alias), output a heuristic "representative" lag of that cluster.
|
||||
The output is obtained by examining the replicas that are member of "which-cluster-osc-replicas"-command, and
|
||||
getting the maximum replica lag of those replicas. Recall that those replicas are a subset of the entire cluster,
|
||||
and that they are ebing polled periodically. Hence the output of this command is not necessarily up-to-date
|
||||
and does not represent all replicas in cluster. Examples:
|
||||
|
||||
orchestrator -c get-cluster-heuristic-lag -i instance.that.is.part.of.cluster.com
|
||||
|
||||
orchestrator -c get-cluster-heuristic-lag
|
||||
-i not given, implicitly assumed local host, cluster implied
|
||||
|
||||
orchestrator -c get-cluster-heuristic-lag -alias some_alias
|
||||
assuming some_alias is a known cluster alias (see ClusterNameToAlias or DetectClusterAliasQuery configuration)
|
||||
`
|
||||
CommandHelp["instance-status"] = `
|
||||
Output short status on a given instance (name, replication status, noteable configuration). Example2:
|
||||
|
||||
orchestrator -c instance-status -i instance.to.investigate.com
|
||||
|
||||
orchestrator -c instance-status
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["snapshot-topologies"] = `
|
||||
Take a snapshot of existing topologies. This will record minimal replication topology data: the identity
|
||||
of an instance, its primary and its cluster.
|
||||
Taking a snapshot later allows for reviewing changes in topologies. One might wish to invoke this command
|
||||
on a daily basis, and later be able to solve questions like 'where was this instacne replicating from before
|
||||
we moved it?', 'which instances were replication from this instance a week ago?' etc. Example:
|
||||
|
||||
orchestrator -c snapshot-topologies
|
||||
`
|
||||
|
||||
CommandHelp["discover"] = `
|
||||
Request that orchestrator cotacts given instance, reads its status, and upsert it into
|
||||
orchestrator's respository. Examples:
|
||||
|
||||
orchestrator -c discover -i instance.to.discover.com:3306
|
||||
|
||||
orchestrator -c discover -i cname.of.instance
|
||||
|
||||
orchestrator -c discover
|
||||
-i not given, implicitly assumed local hostname
|
||||
|
||||
Orchestrator will resolve CNAMEs and VIPs.
|
||||
`
|
||||
CommandHelp["forget"] = `
|
||||
Request that orchestrator removed given instance from its repository. If the instance is alive
|
||||
and connected through replication to otherwise known and live instances, orchestrator will
|
||||
re-discover it by nature of its discovery process. Instances are auto-removed via config's
|
||||
UnseenAgentForgetHours. If you happen to know a machine is decommisioned, for example, it
|
||||
can be nice to remove it from the repository before it auto-expires. Example:
|
||||
|
||||
orchestrator -c forget -i instance.to.forget.com
|
||||
|
||||
Orchestrator will *not* resolve CNAMEs and VIPs for given instance.
|
||||
`
|
||||
CommandHelp["begin-maintenance"] = `
|
||||
Request a maintenance lock on an instance. Topology changes require placing locks on the minimal set of
|
||||
affected instances, so as to avoid an incident of two uncoordinated operations on a smae instance (leading
|
||||
to possible chaos). Locks are placed in the backend database, and so multiple orchestrator instances are safe.
|
||||
Operations automatically acquire locks and release them. This command manually acquires a lock, and will
|
||||
block other operations on the instance until lock is released.
|
||||
Note that orchestrator automatically assumes locks to be expired after MaintenanceExpireMinutes (hard coded value).
|
||||
Examples:
|
||||
|
||||
orchestrator -c begin-maintenance -i instance.to.lock.com --duration=3h --reason="load testing; do not disturb"
|
||||
accepted duration format: 10s, 30m, 24h, 3d, 4w
|
||||
|
||||
orchestrator -c begin-maintenance -i instance.to.lock.com --reason="load testing; do not disturb"
|
||||
--duration not given; default to MaintenanceExpireMinutes (hard coded value)
|
||||
`
|
||||
CommandHelp["end-maintenance"] = `
|
||||
Remove maintenance lock; such lock may have been gained by an explicit begin-maintenance command implicitly
|
||||
by a topology change. You should generally only remove locks you have placed manually; orchestrator will
|
||||
automatically expire locks after MaintenanceExpireMinutes (hard coded value).
|
||||
Example:
|
||||
|
||||
orchestrator -c end-maintenance -i locked.instance.com
|
||||
`
|
||||
CommandHelp["begin-downtime"] = `
|
||||
Mark an instance as downtimed. A downtimed instance is assumed to be taken care of, and recovery-analysis does
|
||||
not apply for such an instance. As result, no recommendation for recovery, and no automated-recovery are issued
|
||||
on a downtimed instance.
|
||||
Downtime is different than maintanence in that it places no lock (mainenance uses an exclusive lock on the instance).
|
||||
It is OK to downtime an instance that is already downtimed -- the new begin-downtime command will override whatever
|
||||
previous downtime attributes there were on downtimes instance.
|
||||
Note that orchestrator automatically assumes downtime to be expired after MaintenanceExpireMinutes (hard coded value).
|
||||
Examples:
|
||||
|
||||
orchestrator -c begin-downtime -i instance.to.downtime.com --duration=3h --reason="dba handling; do not do recovery"
|
||||
accepted duration format: 10s, 30m, 24h, 3d, 4w
|
||||
|
||||
orchestrator -c begin-downtime -i instance.to.lock.com --reason="dba handling; do not do recovery"
|
||||
--duration not given; default to MaintenanceExpireMinutes (hard coded value)
|
||||
`
|
||||
CommandHelp["end-downtime"] = `
|
||||
Indicate an instance is no longer downtimed. Typically you should not need to use this since
|
||||
a downtime is always bounded by a duration and auto-expires. But you may use this to forcibly
|
||||
indicate the active downtime should be expired now.
|
||||
Example:
|
||||
|
||||
orchestrator -c end-downtime -i downtimed.instance.com
|
||||
`
|
||||
|
||||
CommandHelp["recover"] = `
|
||||
Do auto-recovery given a dead instance. Orchestrator chooses the best course of action.
|
||||
The given instance must be acknowledged as dead and have replicas, or else there's nothing to do.
|
||||
See "replication-analysis" command.
|
||||
Orchestrator executes external processes as configured by *Processes variables.
|
||||
--debug is your friend. Example:
|
||||
|
||||
orchestrator -c recover -i dead.instance.com --debug
|
||||
`
|
||||
CommandHelp["recover-lite"] = `
|
||||
Do auto-recovery given a dead instance. Orchestrator chooses the best course of action, exactly
|
||||
as in "-c recover". Orchestratir will *not* execute external processes.
|
||||
|
||||
orchestrator -c recover-lite -i dead.instance.com --debug
|
||||
`
|
||||
CommandHelp["force-primary-failover"] = `
|
||||
Forcibly begin a primary failover process, even if orchestrator does not see anything wrong
|
||||
in particular with the primary.
|
||||
- This will not work in a primary-primary configuration
|
||||
- Orchestrator just treats this command as a DeadPrimary failover scenario
|
||||
- Orchestrator will issue all relevant pre-failover and post-failover external processes.
|
||||
- Orchestrator will not attempt to recover/reconnect the old primary
|
||||
`
|
||||
CommandHelp["force-primary-takeover"] = `
|
||||
Forcibly discard primary and promote another (direct child) instance instead, even if everything is running well.
|
||||
This allows for planned switchover.
|
||||
NOTE:
|
||||
- You must specify the instance to promote via "-d"
|
||||
- Promoted instance must be a direct child of the existing primary
|
||||
- This will not work in a primary-primary configuration
|
||||
- Orchestrator just treats this command as a DeadPrimary failover scenario
|
||||
- It is STRONGLY suggested that you first relocate everything below your chosen instance-to-promote.
|
||||
It *is* a planned failover thing.
|
||||
- Otherwise orchestrator will do its thing in moving instances around, hopefully promoting your requested
|
||||
server on top.
|
||||
- Orchestrator will issue all relevant pre-failover and post-failover external processes.
|
||||
- In this command orchestrator will not issue 'SET GLOBAL read_only=1' on the existing primary, nor will
|
||||
it issue a 'FLUSH TABLES WITH READ LOCK'. Please see the 'graceful-primary-takeover' command.
|
||||
Examples:
|
||||
|
||||
orchestrator -c force-primary-takeover -alias mycluster -d immediate.child.of.primary.com
|
||||
Indicate cluster by alias. Orchestrator automatically figures out the primary
|
||||
|
||||
orchestrator -c force-primary-takeover -i instance.in.relevant.cluster.com -d immediate.child.of.primary.com
|
||||
Indicate cluster by an instance. You don't structly need to specify the primary, orchestrator
|
||||
will infer the primary's identify.
|
||||
`
|
||||
CommandHelp["graceful-primary-takeover"] = `
|
||||
Gracefully discard primary and promote another (direct child) instance instead, even if everything is running well.
|
||||
This allows for planned switchover.
|
||||
NOTE:
|
||||
- Promoted instance must be a direct child of the existing primary
|
||||
- Promoted instance must be the *only* direct child of the existing primary. It *is* a planned failover thing.
|
||||
- Orchestrator will first issue a "set global read_only=1" on existing primary
|
||||
- It will promote candidate primary to the binlog positions of the existing primary after issuing the above
|
||||
- There _could_ still be statements issued and executed on the existing primary by SUPER users, but those are ignored.
|
||||
- Orchestrator then proceeds to handle a DeadPrimary failover scenario
|
||||
- Orchestrator will issue all relevant pre-failover and post-failover external processes.
|
||||
Examples:
|
||||
|
||||
orchestrator -c graceful-primary-takeover -alias mycluster
|
||||
Indicate cluster by alias. Orchestrator automatically figures out the primary and verifies it has a single direct replica
|
||||
|
||||
orchestrator -c force-primary-takeover -i instance.in.relevant.cluster.com
|
||||
Indicate cluster by an instance. You don't structly need to specify the primary, orchestrator
|
||||
will infer the primary's identify.
|
||||
`
|
||||
CommandHelp["replication-analysis"] = `
|
||||
Request an analysis of potential crash incidents in all known topologies.
|
||||
Output format is not yet stabilized and may change in the future. Do not trust the output
|
||||
for automated parsing. Use web API instead, at this time. Example:
|
||||
|
||||
orchestrator -c replication-analysis
|
||||
`
|
||||
CommandHelp["ack-cluster-recoveries"] = `
|
||||
Acknowledge recoveries for a given cluster; this unblocks pending future recoveries.
|
||||
Acknowledging a recovery requires a comment (supply via --reason). Acknowledgement clears the in-active-period
|
||||
flag for affected recoveries, which in turn affects any blocking recoveries.
|
||||
Multiple recoveries may be affected. Only unacknowledged recoveries will be affected.
|
||||
Examples:
|
||||
|
||||
orchestrator -c ack-cluster-recoveries -i instance.in.a.cluster.com --reason="dba has taken taken necessary steps"
|
||||
Cluster is indicated by any of its members. The recovery need not necessarily be on/to given instance.
|
||||
|
||||
orchestrator -c ack-cluster-recoveries -alias some_alias --reason="dba has taken taken necessary steps"
|
||||
Cluster indicated by alias
|
||||
`
|
||||
CommandHelp["ack-instance-recoveries"] = `
|
||||
Acknowledge recoveries for a given instance; this unblocks pending future recoveries.
|
||||
Acknowledging a recovery requires a comment (supply via --reason). Acknowledgement clears the in-active-period
|
||||
flag for affected recoveries, which in turn affects any blocking recoveries.
|
||||
Multiple recoveries may be affected. Only unacknowledged recoveries will be affected.
|
||||
Example:
|
||||
|
||||
orchestrator -c ack-cluster-recoveries -i instance.that.failed.com --reason="dba has taken taken necessary steps"
|
||||
`
|
||||
|
||||
CommandHelp["register-candidate"] = `
|
||||
Indicate that a specific instance is a preferred candidate for primary promotion. Upon a dead primary
|
||||
recovery, orchestrator will do its best to promote instances that are marked as candidates. However
|
||||
orchestrator cannot guarantee this will always work. Issues like version compatabilities, binlog format
|
||||
etc. are limiting factors.
|
||||
You will want to mark an instance as a candidate when: it is replicating directly from the primary, has
|
||||
binary logs and log_slave_updates is enabled, uses same binlog_format as its siblings, compatible version
|
||||
as its siblings. If you're using DataCenterPattern & PhysicalEnvironmentPattern (see configuration),
|
||||
you would further wish to make sure you have a candidate in each data center.
|
||||
Orchestrator first promotes the best-possible replica, and only then replaces it with your candidate,
|
||||
and only if both in same datcenter and physical enviroment.
|
||||
An instance needs to continuously be marked as candidate, so as to make sure orchestrator is not wasting
|
||||
time with stale instances. Orchestrator periodically clears candidate-registration for instances that have
|
||||
not been registeres for over CandidateInstanceExpireMinutes (see config).
|
||||
Example:
|
||||
|
||||
orchestrator -c register-candidate -i candidate.instance.com
|
||||
|
||||
orchestrator -c register-candidate
|
||||
-i not given, implicitly assumed local hostname
|
||||
`
|
||||
CommandHelp["register-hostname-unresolve"] = `
|
||||
Assigns the given instance a virtual (aka "unresolved") name. When moving replicas under an instance with assigned
|
||||
"unresolve" name, orchestrator issues a CHANGE MASTER TO MASTER_HOST='<the unresovled name instead of the fqdn>' ...
|
||||
This is useful in cases where your primary is behind virtual IP (e.g. active/passive primaries with shared storage or DRBD,
|
||||
e.g. binlog servers sharing common VIP).
|
||||
A "repoint" command is useful after "register-hostname-unresolve": you can repoint replicas of the instance to their exact
|
||||
same location, and orchestrator will swap the fqdn of their primary with the unresolved name.
|
||||
Such registration must be periodic. Orchestrator automatically expires such registration after ExpiryHostnameResolvesMinutes.
|
||||
Example:
|
||||
|
||||
orchestrator -c register-hostname-unresolve -i instance.fqdn.com --hostname=virtual.name.com
|
||||
`
|
||||
CommandHelp["deregister-hostname-unresolve"] = `
|
||||
Explicitly deregister/dosassociate a hostname with an "unresolved" name. Orchestrator merely remvoes the association, but does
|
||||
not touch any replica at this point. A "repoint" command can be useful right after calling this command to change replica's primary host
|
||||
name (assumed to be an "unresolved" name, such as a VIP) with the real fqdn of the primary host.
|
||||
Example:
|
||||
|
||||
orchestrator -c deregister-hostname-unresolve -i instance.fqdn.com
|
||||
`
|
||||
CommandHelp["set-heuristic-domain-instance"] = `
|
||||
This is a temporary (sync your watches, watch for next ice age) command which registers the cluster domain name of a given cluster
|
||||
with the primary/writer host for that cluster. It is a one-time-primary-discovery operation.
|
||||
At this time orchestrator may also act as a small & simple key-value store (recall the "temporary" indication).
|
||||
Primary failover operations will overwrite the domain instance identity. Orchestrator so turns into a mini primary-discovery
|
||||
service (I said "TEMPORARY"). Really there are other tools for the job. See also: which-heuristic-domain-instance
|
||||
Example:
|
||||
|
||||
orchestrator -c set-heuristic-domain-instance --alias some_alias
|
||||
Detects the domain name for given cluster, identifies the writer primary of the cluster, associates the two in key-value store
|
||||
|
||||
orchestrator -c set-heuristic-domain-instance -i instance.of.some.cluster
|
||||
Cluster is inferred by a member instance (the instance is not necessarily the primary)
|
||||
`
|
||||
|
||||
CommandHelp["continuous"] = `
|
||||
Enter continuous mode, and actively poll for instances, diagnose problems, do maintenance etc.
|
||||
This type of work is typically done in HTTP mode. However nothing prevents orchestrator from
|
||||
doing it in command line. Invoking with "continuous" will run indefinitely. Example:
|
||||
|
||||
orchestrator -c continuous
|
||||
`
|
||||
CommandHelp["active-nodes"] = `
|
||||
List orchestrator nodes or processes that are actively running or have most recently
|
||||
executed. Output is in hostname:token format, where "token" is an internal unique identifier
|
||||
of an orchestrator process. Example:
|
||||
|
||||
orchestrator -c active-nodes
|
||||
`
|
||||
CommandHelp["access-token"] = `
|
||||
When running HTTP with "AuthenticationMethod" : "token", receive a new access token.
|
||||
This token must be utilized within "AccessTokenUseExpirySeconds" and can then be used
|
||||
until "AccessTokenExpiryMinutes" have passed.
|
||||
In "token" authentication method a user is read-only unless able to provide with a fresh token.
|
||||
A token may only be used once (two users must get two distinct tokens).
|
||||
Submitting a token is done via "/web/access-token?publicToken=<received_token>". The token is then stored
|
||||
in HTTP cookie.
|
||||
|
||||
orchestrator -c access-token
|
||||
`
|
||||
CommandHelp["reset-hostname-resolve-cache"] = `
|
||||
Clear the hostname resolve cache; it will be refilled by following host discoveries
|
||||
|
||||
orchestrator -c reset-hostname-resolve-cache
|
||||
`
|
||||
CommandHelp["resolve"] = `
|
||||
Utility command to resolve a CNAME and return resolved hostname name. Example:
|
||||
|
||||
orchestrator -c resolve -i cname.to.resolve
|
||||
`
|
||||
CommandHelp["redeploy-internal-db"] = `
|
||||
Force internal schema migration to current backend structure. Orchestrator keeps track of the deployed
|
||||
versions and will not reissue a migration for a version already deployed. Normally you should not use
|
||||
this command, and it is provided mostly for building and testing purposes. Nonetheless it is safe to
|
||||
use and at most it wastes some cycles.
|
||||
`
|
||||
|
||||
for key := range CommandHelp {
|
||||
CommandHelp[key] = strings.Trim(CommandHelp[key], "\n")
|
||||
}
|
||||
}
|
||||
|
||||
func HelpCommand(command string) {
|
||||
fmt.Printf("%s:\n%s\n", command, CommandHelp[command])
|
||||
}
|
||||
Загрузка…
Ссылка в новой задаче