Skip to content

Commit

Permalink
Create 'datadir' package responsible for paths.
Browse files Browse the repository at this point in the history
  • Loading branch information
ptabor committed Apr 27, 2021
1 parent 06d6f09 commit ad85d87
Show file tree
Hide file tree
Showing 5 changed files with 105 additions and 9 deletions.
17 changes: 11 additions & 6 deletions etcdctl/ctlv2/command/backup_command.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import (
"log"
"os"
"path"
"path/filepath"
"regexp"
"time"

Expand All @@ -28,6 +27,7 @@ import (
"go.etcd.io/etcd/pkg/v3/idutil"
"go.etcd.io/etcd/pkg/v3/pbutil"
"go.etcd.io/etcd/raft/v3/raftpb"
"go.etcd.io/etcd/server/v3/datadir"
"go.etcd.io/etcd/server/v3/etcdserver/api/membership"
"go.etcd.io/etcd/server/v3/etcdserver/api/snap"
"go.etcd.io/etcd/server/v3/wal"
Expand Down Expand Up @@ -60,19 +60,22 @@ func handleBackup(c *cli.Context) error {
var destWAL string

withV3 := c.Bool("with-v3")
srcSnap := filepath.Join(c.String("data-dir"), "member", "snap")
destSnap := filepath.Join(c.String("backup-dir"), "member", "snap")
srcDir := c.String("data-dir")
destDir := c.String("backup-dir")

srcSnap := datadir.ToSnapDir(srcDir)
destSnap := datadir.ToSnapDir(destDir)

if c.String("wal-dir") != "" {
srcWAL = c.String("wal-dir")
} else {
srcWAL = filepath.Join(c.String("data-dir"), "member", "wal")
srcWAL = datadir.ToWalDir(srcDir)
}

if c.String("backup-wal-dir") != "" {
destWAL = c.String("backup-wal-dir")
} else {
destWAL = filepath.Join(c.String("backup-dir"), "member", "wal")
destWAL = datadir.ToWalDir(destDir)
}

if err := fileutil.CreateDirAll(destSnap); err != nil {
Expand All @@ -81,7 +84,9 @@ func handleBackup(c *cli.Context) error {

walsnap := saveSnap(destSnap, srcSnap)
metadata, state, ents := loadWAL(srcWAL, walsnap, withV3)
saveDB(filepath.Join(destSnap, "db"), filepath.Join(srcSnap, "db"), state.Commit, withV3)

destDbPath := datadir.ToBackendFileName(destDir)
saveDB(destDbPath, datadir.ToBackendFileName(srcDir), state.Commit, withV3)

idgen := idutil.NewGenerator(0, time.Now())
metadata.NodeID = idgen.Next()
Expand Down
7 changes: 4 additions & 3 deletions server/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import (
"go.etcd.io/etcd/client/pkg/v3/transport"
"go.etcd.io/etcd/client/pkg/v3/types"
"go.etcd.io/etcd/pkg/v3/netutil"
"go.etcd.io/etcd/server/v3/datadir"

bolt "go.etcd.io/bbolt"
"go.uber.org/zap"
Expand Down Expand Up @@ -274,13 +275,13 @@ func (c *ServerConfig) advertiseMatchesCluster() error {
return fmt.Errorf("failed to resolve %s to match --initial-cluster=%s (%v)", apStr, umap.String(), err)
}

func (c *ServerConfig) MemberDir() string { return filepath.Join(c.DataDir, "member") }
func (c *ServerConfig) MemberDir() string { return datadir.ToMemberDir(c.DataDir) }

func (c *ServerConfig) WALDir() string {
if c.DedicatedWALDir != "" {
return c.DedicatedWALDir
}
return filepath.Join(c.MemberDir(), "wal")
return datadir.ToWalDir(c.DataDir)
}

func (c *ServerConfig) SnapDir() string { return filepath.Join(c.MemberDir(), "snap") }
Expand Down Expand Up @@ -324,4 +325,4 @@ func (c *ServerConfig) BootstrapTimeoutEffective() time.Duration {
return time.Second
}

func (c *ServerConfig) BackendPath() string { return filepath.Join(c.SnapDir(), "db") }
func (c *ServerConfig) BackendPath() string { return datadir.ToBackendFileName(c.DataDir) }
40 changes: 40 additions & 0 deletions server/datadir/datadir.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Copyright 2021 The etcd Authors
//
// 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 datadir

import "path/filepath"

const (
memberDirSegment = "member"
snapDirSegment = "snap"
walDirSegment = "wal"
backendFileSegment = "db"
)

func ToBackendFileName(dataDir string) string {
return filepath.Join(ToSnapDir(dataDir), backendFileSegment)
}

func ToSnapDir(dataDir string) string {
return filepath.Join(ToMemberDir(dataDir), snapDirSegment)
}

func ToWalDir(dataDir string) string {
return filepath.Join(ToMemberDir(dataDir), walDirSegment)
}

func ToMemberDir(dataDir string) string {
return filepath.Join(dataDir, memberDirSegment)
}
33 changes: 33 additions & 0 deletions server/datadir/datadir_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package datadir_test

import (
"testing"

"github.com/stretchr/testify/assert"
"go.etcd.io/etcd/server/v3/datadir"
)

func TestToBackendFileName(t *testing.T) {
result := datadir.ToBackendFileName("/dir/data-dir")
assert.Equal(t, "/dir/data-dir/member/snap/db", result)
}

func TestToMemberDir(t *testing.T) {
result := datadir.ToMemberDir("/dir/data-dir")
assert.Equal(t, "/dir/data-dir/member", result)
}

func TestToSnapDir(t *testing.T) {
result := datadir.ToSnapDir("/dir/data-dir")
assert.Equal(t, "/dir/data-dir/member/snap", result)
}

func TestToWalDir(t *testing.T) {
result := datadir.ToWalDir("/dir/data-dir")
assert.Equal(t, "/dir/data-dir/member/wal", result)
}

func TestToWalDirSlash(t *testing.T) {
result := datadir.ToWalDir("/dir/data-dir/")
assert.Equal(t, "/dir/data-dir/member/wal", result)
}
17 changes: 17 additions & 0 deletions server/datadir/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// Copyright 2021 The etcd Authors
//
// 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 datadir

// datadir contains functions to navigate file-layout of etcd data-directory.

0 comments on commit ad85d87

Please sign in to comment.