-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Snapshot Restore generates commands to restore dumped snapshots to a Sourcegraph instance
- Loading branch information
Showing
3 changed files
with
184 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "flag" | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| "strings" | ||
|
|
||
| "github.com/sourcegraph/sourcegraph/lib/errors" | ||
| "github.com/sourcegraph/sourcegraph/lib/output" | ||
| "gopkg.in/yaml.v3" | ||
|
|
||
| "github.com/sourcegraph/src-cli/internal/pgdump" | ||
| ) | ||
|
|
||
| func init() { | ||
| usage := `'src snapshot restore' restores a Sourcegraph instance using Sourcegraph database dumps. | ||
| Note that these commands are intended for use as reference - you may need to adjust the commands for your deployment. | ||
| USAGE | ||
| src [-v] snapshot restore [--targets<docker|k8s|"targets.yaml">] [--run] <pg_dump|docker|kubectl> | ||
| TARGETS FILES | ||
| Predefined targets are available based on default Sourcegraph configurations ('docker', 'k8s'). | ||
| Custom targets configuration can be provided in YAML format with '--targets=target.yaml', e.g. | ||
| primary: | ||
| target: ... # the DSN of the database deployment, e.g. in docker, the name of the database container | ||
| dbname: ... # name of database | ||
| username: ... # username for database access | ||
| password: ... # password for database access - only include password if it is non-sensitive | ||
| codeintel: | ||
| # same as above | ||
| codeinsights: | ||
| # same as above | ||
| See the pgdump.Targets type for more details. | ||
| ` | ||
|
|
||
| flagSet := flag.NewFlagSet("restore", flag.ExitOnError) | ||
| targetsKeyFlag := flagSet.String("targets", "auto", "predefined targets ('docker' or 'k8s'), or a custom targets.yaml file") | ||
| run := flagSet.Bool("run", false, "Automatically run the commands") | ||
|
|
||
| snapshotCommands = append(snapshotCommands, &command{ | ||
| flagSet: flagSet, | ||
| handler: func(args []string) error { | ||
| if err := flagSet.Parse(args); err != nil { | ||
| return err | ||
| } | ||
| out := output.NewOutput(flagSet.Output(), output.OutputOpts{Verbose: *verbose}) | ||
|
|
||
| builder := flagSet.Arg(0) | ||
|
|
||
| commandBuilder, targetKey := pgdump.Builder(builder, pgdump.RestoreCommand) | ||
| if targetKey == "" { | ||
| return errors.Newf("unknown or invalid template type %q", builder) | ||
| } | ||
|
|
||
| if *targetsKeyFlag != "auto" { | ||
| targetKey = *targetsKeyFlag | ||
| } | ||
|
|
||
| targets, ok := predefinedDatabaseDumpTargets[targetKey] | ||
| if !ok { | ||
| out.WriteLine(output.Emojif(output.EmojiInfo, "Using targets defined in targets file %q", targetKey)) | ||
| f, err := os.Open(targetKey) | ||
| if err != nil { | ||
| return errors.Wrapf(err, "invalid targets file %q", targetKey) | ||
| } | ||
| if err := yaml.NewDecoder(f).Decode(&targets); err != nil { | ||
| return errors.Wrapf(err, "invalid targets file %q", targetKey) | ||
| } | ||
| } else { | ||
| out.WriteLine(output.Emojif(output.EmojiInfo, "Using predefined targets for %s environments", targetKey)) | ||
| } | ||
|
|
||
| commands, err := pgdump.BuildCommands(srcSnapshotDir, commandBuilder, targets, false) | ||
| if err != nil { | ||
| return errors.Wrap(err, "failed to build commands") | ||
| } | ||
| if *run { | ||
| for _, c := range commands { | ||
| out.WriteLine(output.Emojif(output.EmojiInfo, "Running command: %q", c)) | ||
| command := exec.Command("bash", "-c", c) | ||
| output, err := command.CombinedOutput() | ||
| out.Write(string(output)) | ||
| if err != nil { | ||
| return errors.Wrapf(err, "failed to run command: %q", c) | ||
| } | ||
| } | ||
|
|
||
| out.WriteLine(output.Emoji(output.EmojiSuccess, "Successfully completed restore commands")) | ||
| out.WriteLine(output.Styledf(output.StyleSuggestion, "It may be necessary to restart your Sourcegraph instance after restoring")) | ||
| } else { | ||
| b := out.Block(output.Emoji(output.EmojiSuccess, "Run these commands to restore the databases:")) | ||
| b.Write("\n" + strings.Join(commands, "\n")) | ||
| b.Close() | ||
|
|
||
| out.WriteLine(output.Styledf(output.StyleSuggestion, "Note that you may need to do some additional setup, such as authentication, beforehand.")) | ||
| } | ||
|
|
||
| return nil | ||
| }, | ||
|
|
||
| usageFunc: func() { fmt.Fprint(flag.CommandLine.Output(), usage) }, | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters