Skip to content

PBM-1718 Allow physical/incremental backup for MongoDB Enterprise edition #1285

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.

Sign up for GitHub

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

Open
Copilot wants to merge 5 commits into
base: dev
Choose a base branch
from
Open

PBM-1718 Allow physical/incremental backup for MongoDB Enterprise edition #1285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
aac54ff
Initial plan
Copilot Mar 12, 2026
43aaac6
fix physical backup failure with unsupported read concern
Copilot Mar 12, 2026
1a16adb
allow physical backup for MongoDB Enterprise edition
Copilot Mar 12, 2026
38786c4
fix empty nomination list for MongoDB Enterprise edition
Copilot Mar 12, 2026
af79336
Merge branch 'dev' into copilot/fix-backup-agent-read-concern
igroene Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions cmd/pbm-agent/agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,11 +276,12 @@ func (a *Agent) HbStatus(ctx context.Context) {
}

hb := topo.AgentStat{
Node: a.brief.Me,
RS: a.brief.SetName,
AgentVer: version.Current().Version,
MongoVer: nodeVersion.VersionString,
PerconaVer: nodeVersion.PSMDBVersion,
Node: a.brief.Me,
RS: a.brief.SetName,
AgentVer: version.Current().Version,
MongoVer: nodeVersion.VersionString,
PerconaVer: nodeVersion.PSMDBVersion,
IsEnterprise: nodeVersion.IsEnterprise(),
}

updateAgentStat(ctx, a, l, true, &hb)
Expand Down
6 changes: 4 additions & 2 deletions pbm/backup/physical.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
"go.mongodb.org/mongo-driver/bson/bsontype"
"go.mongodb.org/mongo-driver/bson/primitive"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/mongo/readconcern"
"go.mongodb.org/mongo-driver/x/bsonx/bsoncore"

"github.com/percona/percona-backup-mongodb/pbm/compress"
Expand Down Expand Up @@ -91,7 +93,7 @@
}
}

cur, err := bc.conn.Database("admin").Aggregate(ctx, mongo.Pipeline{
cur, err := bc.conn.Database("admin", options.Database().SetReadConcern(readconcern.Local())).Aggregate(ctx, mongo.Pipeline{

Check failure on line 96 in pbm/backup/physical.go

View workflow job for this annotation

GitHub Actions / runner / golangci-lint 

The line is 126 characters long, which exceeds the maximum of 120 characters. (lll)

@github-actions github-actions Bot Mar 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [golangci] reported by reviewdog 🐶
The line is 126 characters long, which exceeds the maximum of 120 characters. (lll)

{{"$backupCursor", opts}},
})
if err != nil {
Expand Down Expand Up @@ -189,7 +191,7 @@

func (bc *BackupCursor) Journals(upto primitive.Timestamp) ([]File, error) {
ctx := context.Background()
cur, err := bc.conn.Database("admin").Aggregate(ctx,
cur, err := bc.conn.Database("admin", options.Database().SetReadConcern(readconcern.Local())).Aggregate(ctx,
mongo.Pipeline{
{{"$backupCursorExtend", bson.D{{"backupId", bc.id}, {"timestamp", upto}}}},
})
Expand Down
7 changes: 7 additions & 0 deletions pbm/topo/agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ type AgentStat struct {
// Empty for non-PSMDB (e.i MongoDB CE).
PerconaVer string `bson:"pv,omitempty"`

// IsEnterprise is set when the node runs MongoDB Enterprise edition.
IsEnterprise bool `bson:"ent,omitempty"`

// PBMStatus is the agent status.
PBMStatus SubsysStatus `bson:"pbms"`

Expand Down Expand Up @@ -114,6 +117,10 @@ func (s *AgentStat) MongoVersion() version.MongoVersion {
VersionString: s.MongoVer,
}

if s.IsEnterprise {
v.Modules = []string{"enterprise"}
}

vs := semver.Canonical("v" + s.MongoVer)[1:]
vs = strings.SplitN(vs, "-", 2)[0]
for _, a := range strings.Split(vs, ".")[:3] {
Expand Down
28 changes: 20 additions & 8 deletions pbm/version/version.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,20 @@ var BreakingChangesMap = map[defs.BackupType][]string{
}

type MongoVersion struct {
PSMDBVersion string `bson:"psmdbVersion,omitempty"`
VersionString string `bson:"version"`
Version []int `bson:"versionArray"`
PSMDBVersion string `bson:"psmdbVersion,omitempty"`
VersionString string `bson:"version"`
Version []int `bson:"versionArray"`
Modules []string `bson:"modules,omitempty"`
}

// IsEnterprise returns true if the MongoDB instance is running Enterprise edition.
func (v MongoVersion) IsEnterprise() bool {
for _, m := range v.Modules {
if m == "enterprise" {
return true
}
}
return false
}

func (v MongoVersion) String() string {
Expand Down Expand Up @@ -274,7 +285,7 @@ func (f FeatureSupport) PBMSupport() error {
func (f FeatureSupport) FullPhysicalBackup() bool {
// PSMDB 4.2.15, 4.4.6
v := MongoVersion(f)
if v.PSMDBVersion == "" {
if v.PSMDBVersion == "" && !v.IsEnterprise() {
return false
}

Expand All @@ -293,7 +304,7 @@ func (f FeatureSupport) FullPhysicalBackup() bool {
func (f FeatureSupport) IncrementalPhysicalBackup() bool {
// PSMDB 4.2.24, 4.4.18, 5.0.14, 6.0.3
v := MongoVersion(f)
if v.PSMDBVersion == "" {
if v.PSMDBVersion == "" && !v.IsEnterprise() {
return false
}

Expand All @@ -318,17 +329,18 @@ func (f FeatureSupport) BackupType(t defs.BackupType) error {
case defs.PhysicalBackup:
if !f.FullPhysicalBackup() {
return errors.New("full physical backup works since " +
"Percona Server for MongoDB 4.2.15, 4.4.6")
"Percona Server for MongoDB 4.2.15, 4.4.6 or MongoDB Enterprise 4.2.15, 4.4.6")
}
case defs.IncrementalBackup:
if !f.IncrementalPhysicalBackup() {
return errors.New("incremental physical backup works since " +
"Percona Server for MongoDB 4.2.24, 4.4.18, 5.0.14, 6.0.3")
"Percona Server for MongoDB 4.2.24, 4.4.18, 5.0.14, 6.0.3 or " +
"MongoDB Enterprise 4.2.24, 4.4.18, 5.0.14, 6.0.3")
}
case defs.ExternalBackup:
if !f.FullPhysicalBackup() {
return errors.New("external backup works since " +
"Percona Server for MongoDB 4.2.15, 4.4.6")
"Percona Server for MongoDB 4.2.15, 4.4.6 or MongoDB Enterprise 4.2.15, 4.4.6")
}
}

Expand Down
172 changes: 172 additions & 0 deletions pbm/version/version_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,178 @@ func TestCompatibility(t *testing.T) {
}
}

func TestFullPhysicalBackup(t *testing.T) {
cases := []struct {
name string
ver MongoVersion
want bool
Comment on lines +105 to +107

@github-actions github-actions Bot Mar 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[gofmt] reported by reviewdog 🐶

Suggested change
name string
ver MongoVersion
want bool
name string
ver MongoVersion
want bool

}{
// PSMDB cases
{
name: "psmdb 4.2.14 (too old)",
ver: MongoVersion{PSMDBVersion: "4.2.14-14", Version: []int{4, 2, 14}},
want: false,
},
{
name: "psmdb 4.2.15",
ver: MongoVersion{PSMDBVersion: "4.2.15-15", Version: []int{4, 2, 15}},
want: true,
},
{
name: "psmdb 4.4.5 (too old)",
ver: MongoVersion{PSMDBVersion: "4.4.5-5", Version: []int{4, 4, 5}},
want: false,
},
{
name: "psmdb 4.4.6",
ver: MongoVersion{PSMDBVersion: "4.4.6-6", Version: []int{4, 4, 6}},
want: true,
},
{
name: "psmdb 7.0.0",
ver: MongoVersion{PSMDBVersion: "7.0.0-1", Version: []int{7, 0, 0}},
want: true,
},
// Plain MongoDB (no enterprise)
{
name: "mongodb community 7.0.0",
ver: MongoVersion{Version: []int{7, 0, 0}},
want: false,
},
// MongoDB Enterprise cases
{
name: "mongodb enterprise 4.2.14 (too old)",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{4, 2, 14}},
want: false,
},
{
name: "mongodb enterprise 4.2.15",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{4, 2, 15}},
want: true,
},
{
name: "mongodb enterprise 4.4.5 (too old)",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{4, 4, 5}},
want: false,
},
{
name: "mongodb enterprise 4.4.6",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{4, 4, 6}},
want: true,
},
{
name: "mongodb enterprise 7.0.0",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{7, 0, 0}},
want: true,
},
{
name: "mongodb enterprise 8.0.0",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{8, 0, 0}},
want: true,
},
}

for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
got := FeatureSupport(tc.ver).FullPhysicalBackup()
if got != tc.want {
t.Errorf("FullPhysicalBackup() = %v, want %v", got, tc.want)
}
})
}
}

func TestIncrementalPhysicalBackup(t *testing.T) {
cases := []struct {
name string
ver MongoVersion
want bool
}{
// PSMDB cases
{
name: "psmdb 4.2.23 (too old)",
ver: MongoVersion{PSMDBVersion: "4.2.23-23", Version: []int{4, 2, 23}},
want: false,
},
{
name: "psmdb 4.2.24",
ver: MongoVersion{PSMDBVersion: "4.2.24-24", Version: []int{4, 2, 24}},
want: true,
},
{
name: "psmdb 7.0.0",
ver: MongoVersion{PSMDBVersion: "7.0.0-1", Version: []int{7, 0, 0}},
want: true,
},
// Plain MongoDB (no enterprise)
{
name: "mongodb community 7.0.0",
ver: MongoVersion{Version: []int{7, 0, 0}},
want: false,
},
// MongoDB Enterprise cases
{
name: "mongodb enterprise 4.2.23 (too old)",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{4, 2, 23}},
want: false,
},
{
name: "mongodb enterprise 4.2.24",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{4, 2, 24}},
want: true,
},
{
name: "mongodb enterprise 4.4.17 (too old)",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{4, 4, 17}},
want: false,
},
{
name: "mongodb enterprise 4.4.18",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{4, 4, 18}},
want: true,
},
{
name: "mongodb enterprise 5.0.13 (too old)",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{5, 0, 13}},
want: false,
},
{
name: "mongodb enterprise 5.0.14",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{5, 0, 14}},
want: true,
},
{
name: "mongodb enterprise 6.0.2 (too old)",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{6, 0, 2}},
want: false,
},
{
name: "mongodb enterprise 6.0.3",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{6, 0, 3}},
want: true,
},
{
name: "mongodb enterprise 7.0.0",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{7, 0, 0}},
want: true,
},
{
name: "mongodb enterprise 8.0.0",
ver: MongoVersion{Modules: []string{"enterprise"}, Version: []int{8, 0, 0}},
want: true,
},
}

for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
got := FeatureSupport(tc.ver).IncrementalPhysicalBackup()
if got != tc.want {
t.Errorf("IncrementalPhysicalBackup() = %v, want %v", got, tc.want)
}
})
}
}

func TestHasPhysicalFilesMetadata(t *testing.T) {
cases := map[string]bool{
"": false,
Expand Down
Loading