-
Notifications
You must be signed in to change notification settings - Fork 9.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft: etcdctl: backup and restore #2366
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| // Copyright 2015 CoreOS, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package command | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log" | ||
| "os" | ||
| "path" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/coreos/etcd/Godeps/_workspace/src/github.com/codegangsta/cli" | ||
| "github.com/coreos/etcd/etcdserver/etcdserverpb" | ||
| "github.com/coreos/etcd/pkg/idutil" | ||
| "github.com/coreos/etcd/pkg/pbutil" | ||
| "github.com/coreos/etcd/raft/raftpb" | ||
| "github.com/coreos/etcd/snap" | ||
| "github.com/coreos/etcd/store" | ||
| "github.com/coreos/etcd/wal" | ||
| "github.com/coreos/etcd/wal/walpb" | ||
| ) | ||
|
|
||
| func NewBackupNoConfCommand() cli.Command { | ||
| return cli.Command{ | ||
| Name: "backup-noconf", | ||
| Usage: "backup an etcd directory", | ||
| Flags: []cli.Flag{ | ||
| cli.StringFlag{Name: "data-dir", Value: "", Usage: "Path to the etcd data dir"}, | ||
| cli.StringFlag{Name: "backup-dir", Value: "", Usage: "Path to the backup dir"}, | ||
| }, | ||
| Action: handleBackupNoConf, | ||
| } | ||
| } | ||
|
|
||
| // handleBackup handles a request that intends to do a backup. | ||
| func handleBackupNoConf(c *cli.Context) { | ||
| srcSnap := path.Join(c.String("data-dir"), "snap") | ||
| destSnap := path.Join(c.String("backup-dir"), "snap") | ||
| srcWAL := path.Join(c.String("data-dir"), "wal") | ||
| destWAL := path.Join(c.String("backup-dir"), "wal") | ||
|
|
||
| if err := os.MkdirAll(destSnap, 0700); err != nil { | ||
| log.Fatalf("failed creating backup snapshot dir %v: %v", destSnap, err) | ||
| } | ||
| ss := snap.New(srcSnap) | ||
| snapshot, err := ss.Load() | ||
| if err != nil && err != snap.ErrNoSnapshot { | ||
| log.Fatal(err) | ||
| } | ||
| var walsnap walpb.Snapshot | ||
| if snapshot != nil { | ||
| walsnap.Index, walsnap.Term = snapshot.Metadata.Index, snapshot.Metadata.Term | ||
| newss := snap.New(destSnap) | ||
| snapshot, err := purgeConfInSnap(snapshot) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| if err := newss.SaveSnap(*snapshot); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| } | ||
|
|
||
| w, err := wal.OpenNotInUse(srcWAL, walsnap) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| defer w.Close() | ||
| wmetadata, state, ents, err := w.ReadAll() | ||
| switch err { | ||
| case nil: | ||
| case wal.ErrSnapshotNotFound: | ||
| fmt.Printf("Failed to find the match snapshot record %+v in wal %v.", walsnap, srcWAL) | ||
| fmt.Printf("etcdctl will add it back. Start auto fixing...") | ||
| default: | ||
| log.Fatal(err) | ||
| } | ||
| var metadata etcdserverpb.Metadata | ||
| pbutil.MustUnmarshal(&metadata, wmetadata) | ||
| idgen := idutil.NewGenerator(uint8(time.Now().UnixNano()), time.Now()) | ||
| metadata.ClusterID = idgen.Next() | ||
| metadata.NodeID = 0 | ||
|
|
||
| neww, err := wal.Create(destWAL, pbutil.MustMarshal(&metadata)) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| defer neww.Close() | ||
| if err := neww.Save(state, purgeConfInEnts(ents)); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| if err := neww.SaveSnapshot(walsnap); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| } | ||
|
|
||
| func purgeConfInSnap(snap *raftpb.Snapshot) (*raftpb.Snapshot, error) { | ||
| st := store.New() | ||
| err := st.Recovery(snap.Data) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| st.Delete("/0", true, true) | ||
| d, err := st.Save() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| snap.Data = d | ||
| snap.Metadata.ConfState = raftpb.ConfState{Nodes: make([]uint64, 0)} | ||
| return snap, nil | ||
| } | ||
|
|
||
| func purgeConfInEnts(ents []raftpb.Entry) []raftpb.Entry { | ||
| after := make([]raftpb.Entry, 0) | ||
| for _, e := range ents { | ||
| switch e.Type { | ||
| case raftpb.EntryConfChange: | ||
| continue | ||
| case raftpb.EntryNormal: | ||
| var r etcdserverpb.Request | ||
| pbutil.MustUnmarshal(&r, e.Data) | ||
| if strings.HasPrefix(r.Path, "/0/") { | ||
| continue | ||
| } | ||
| default: | ||
| log.Fatalf("unexpected entry type: %d", e.Type) | ||
| } | ||
| after = append(after, e) | ||
| } | ||
| return after | ||
| } | ||
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,165 @@ | ||
| // Copyright 2015 CoreOS, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package command | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "log" | ||
| "math/rand" | ||
| "os" | ||
| "path" | ||
|
|
||
| "github.com/coreos/etcd/Godeps/_workspace/src/github.com/codegangsta/cli" | ||
| "github.com/coreos/etcd/etcdserver" | ||
| "github.com/coreos/etcd/etcdserver/etcdserverpb" | ||
| "github.com/coreos/etcd/pkg/pbutil" | ||
| "github.com/coreos/etcd/pkg/types" | ||
| "github.com/coreos/etcd/raft/raftpb" | ||
| "github.com/coreos/etcd/snap" | ||
| "github.com/coreos/etcd/wal" | ||
| "github.com/coreos/etcd/wal/walpb" | ||
| ) | ||
|
|
||
| func NewRestoreCommand() cli.Command { | ||
| return cli.Command{ | ||
| Name: "restore", | ||
| Usage: "restore a backup etcd directory", | ||
| Flags: []cli.Flag{ | ||
| cli.StringFlag{Name: "backup-dir", Value: "", Usage: "Path to the etcd backup dir"}, | ||
| cli.StringFlag{Name: "restore-dir", Value: "", Usage: "Path to the restore dir"}, | ||
| cli.StringFlag{Name: "cluster-configuration", Value: "", Usage: "restored configuration"}, | ||
| cli.StringFlag{Name: "name", Value: "", Usage: "member name to restore"}, | ||
| }, | ||
| Action: handleRestore, | ||
| } | ||
| } | ||
|
|
||
| // handleBackup handles a request that intends to do a backup. | ||
| func handleRestore(c *cli.Context) { | ||
| srcSnap := path.Join(c.String("backup-dir"), "snap") | ||
| destSnap := path.Join(c.String("restore-dir"), "snap") | ||
| srcWAL := path.Join(c.String("backup-dir"), "wal") | ||
| destWAL := path.Join(c.String("restore-dir"), "wal") | ||
|
|
||
| if err := os.MkdirAll(destSnap, 0700); err != nil { | ||
| log.Fatalf("failed creating backup snapshot dir %v: %v", destSnap, err) | ||
| } | ||
| ss := snap.New(srcSnap) | ||
| snapshot, err := ss.Load() | ||
| if err != nil && err != snap.ErrNoSnapshot { | ||
| log.Fatal(err) | ||
| } | ||
| var walsnap walpb.Snapshot | ||
| if snapshot != nil { | ||
| walsnap.Index, walsnap.Term = snapshot.Metadata.Index, snapshot.Metadata.Term | ||
| } | ||
|
|
||
| w, err := wal.OpenNotInUse(srcWAL, walsnap) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| defer w.Close() | ||
| wmetadata, state, ents, err := w.ReadAll() | ||
| switch err { | ||
| case nil: | ||
| case wal.ErrSnapshotNotFound: | ||
| fmt.Printf("Failed to find the match snapshot record %+v in wal %v.", walsnap, srcWAL) | ||
| fmt.Printf("etcdctl will add it back. Start auto fixing...") | ||
| default: | ||
| log.Fatal(err) | ||
| } | ||
| var metadata etcdserverpb.Metadata | ||
| pbutil.MustUnmarshal(&metadata, wmetadata) | ||
| if metadata.NodeID != 0 { | ||
| log.Fatalf("The given backup datadir is not a backup datadir: found member %s", types.ID(metadata.NodeID)) | ||
| } | ||
| rand.Seed(int64(metadata.ClusterID)) | ||
|
|
||
| id, confs, confState, err := restoreConf(c.String("cluster-configuration"), c.String("name"), ents[len(ents)-1].Term, ents[len(ents)-1].Index) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| snapshot.Metadata.ConfState = *confState | ||
| newss := snap.New(destSnap) | ||
| if err := newss.SaveSnap(*snapshot); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| metadata.NodeID = id | ||
| neww, err := wal.Create(destWAL, pbutil.MustMarshal(&metadata)) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| defer neww.Close() | ||
|
|
||
| ents = append(ents, confs...) | ||
| state.Commit = ents[len(ents)-1].Index | ||
| if err := neww.Save(state, ents); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| if err := neww.SaveSnapshot(walsnap); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| } | ||
|
|
||
| func restoreConf(cluster string, name string, term, index uint64) (uint64, []raftpb.Entry, *raftpb.ConfState, error) { | ||
| c, err := etcdserver.NewClusterFromString("", cluster) | ||
| if err != nil { | ||
| return 0, nil, nil, err | ||
| } | ||
|
|
||
| var memberID uint64 | ||
| memberIDs := make([]uint64, 0) | ||
| ents := make([]raftpb.Entry, 0) | ||
| next := index | ||
|
|
||
| for _, member := range c.Members() { | ||
| id := uint64(rand.Int63()) | ||
| m := etcdserver.Member{ | ||
| ID: types.ID(id), | ||
| RaftAttributes: etcdserver.RaftAttributes{PeerURLs: member.PeerURLs}, | ||
| } | ||
| ctx, err := json.Marshal(m) | ||
| if err != nil { | ||
| log.Panicf("marshal member should never fail: %v", err) | ||
| } | ||
| cc := &raftpb.ConfChange{ | ||
| Type: raftpb.ConfChangeAddNode, | ||
| NodeID: id, | ||
| Context: ctx, | ||
| } | ||
| e := raftpb.Entry{ | ||
| Type: raftpb.EntryConfChange, | ||
| Data: pbutil.MustMarshal(cc), | ||
| Term: term, | ||
| Index: next, | ||
| } | ||
| next++ | ||
| ents = append(ents, e) | ||
| memberIDs = append(memberIDs, id) | ||
| if member.Name == name { | ||
| memberID = id | ||
| } | ||
| } | ||
|
|
||
| if memberID == 0 { | ||
| return 0, nil, nil, errors.New("cannot find name in cluster configuration") | ||
| } | ||
|
|
||
| return memberID, ents, &raftpb.ConfState{Nodes: memberIDs}, nil | ||
| } |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is doing the right thing, but could it make sense to make the entries that we skip into Noops instead of removing them?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure.