Merge pull request ipfs#70 from ipfs/feat/badger-stable

feat: mark badger as stable
laurentsenta · Apr 1, 2020 · e6b60a6 · e6b60a6
2 parents 21a1b2e + 6c54c08
commit e6b60a6
Show file tree

Hide file tree

Showing 2 changed files with 82 additions and 60 deletions.
diff --git a/config/init.go b/config/init.go
@@ -118,29 +118,46 @@ func DefaultDatastoreConfig() Datastore {
 		StorageGCWatermark: 90, // 90%
 		GCPeriod:           "1h",
 		BloomFilterSize:    0,
-		Spec: map[string]interface{}{
-			"type": "mount",
-			"mounts": []interface{}{
-				map[string]interface{}{
-					"mountpoint": "/blocks",
-					"type":       "measure",
-					"prefix":     "flatfs.datastore",
-					"child": map[string]interface{}{
-						"type":      "flatfs",
-						"path":      "blocks",
-						"sync":      true,
-						"shardFunc": "/repo/flatfs/shard/v1/next-to-last/2",
-					},
+		Spec:               flatfsSpec(),
+	}
+}
+
+func badgerSpec() map[string]interface{} {
+	return map[string]interface{}{
+		"type":   "measure",
+		"prefix": "badger.datastore",
+		"child": map[string]interface{}{
+			"type":       "badgerds",
+			"path":       "badgerds",
+			"syncWrites": false,
+			"truncate":   true,
+		},
+	}
+}
+
+func flatfsSpec() map[string]interface{} {
+	return map[string]interface{}{
+		"type": "mount",
+		"mounts": []interface{}{
+			map[string]interface{}{
+				"mountpoint": "/blocks",
+				"type":       "measure",
+				"prefix":     "flatfs.datastore",
+				"child": map[string]interface{}{
+					"type":      "flatfs",
+					"path":      "blocks",
+					"sync":      true,
+					"shardFunc": "/repo/flatfs/shard/v1/next-to-last/2",
 				},
-				map[string]interface{}{
-					"mountpoint": "/",
-					"type":       "measure",
-					"prefix":     "leveldb.datastore",
-					"child": map[string]interface{}{
-						"type":        "levelds",
-						"path":        "datastore",
-						"compression": "none",
-					},
+			},
+			map[string]interface{}{
+				"mountpoint": "/",
+				"type":       "measure",
+				"prefix":     "leveldb.datastore",
+				"child": map[string]interface{}{
+					"type":        "levelds",
+					"path":        "datastore",
+					"compression": "none",
 				},
 			},
 		},

diff --git a/config/profile.go b/config/profile.go
@@ -11,11 +11,14 @@ type Transformer func(c *Config) error
 
 // Profile contains the profile transformer the description of the profile
 type Profile struct {
-	// Description briefly describes the functionality of the profile
+	// Description briefly describes the functionality of the profile.
 	Description string
 
-	// Transform takes ipfs configuration and applies the profile to it
+	// Transform takes ipfs configuration and applies the profile to it.
 	Transform Transformer
+
+	// InitOnly specifies that this profile can only be applied on init.
+	InitOnly bool
 }
 
 // defaultServerFilters has is a list of IPv4 and IPv6 prefixes that are private, local only, or unrouteable.
@@ -107,51 +110,49 @@ Inverse profile of the test profile.`,
 			return nil
 		},
 	},
-	"badgerds": {
-		Description: `Replaces default datastore configuration with experimental
-badger datastore.
-
-If you apply this profile after ipfs init, you will need
-to convert your datastore to the new configuration.
-You can do this using ipfs-ds-convert.
-
-For more on ipfs-ds-convert see
-$ ipfs-ds-convert --help
-and
-$ ipfs-ds-convert convert --help
-
-WARNING: badger datastore is experimental.
-Make sure to backup your data frequently.`,
+	"flatfs": {
+		Description: `Configures the node to use the flatfs datastore.
+
+This is the most battle-tested and reliable datastore, but it's significantly
+slower than the badger datastore. You should use this datastore if:
+
+* You need a very simple and very reliable datastore you and trust your
+  filesystem. This datastore stores each block as a separate file in the
+  underlying filesystem so it's unlikely to loose data unless there's an issue
+  with the underlying file system.
+* You need to run garbage collection on a small (<= 10GiB) datastore. The
+  default datastore, badger, can leave several gigabytes of data behind when
+  garbage collecting.
+* You're concerned about memory usage. In its default configuration, badger can
+  use up to several gigabytes of memory.
+
+This profile may only be applied when first initializing the node.
+`,
 
+		InitOnly: true,
 		Transform: func(c *Config) error {
-			c.Datastore.Spec = map[string]interface{}{
-				"type":   "measure",
-				"prefix": "badger.datastore",
-				"child": map[string]interface{}{
-					"type":       "badgerds",
-					"path":       "badgerds",
-					"syncWrites": false,
-					"truncate":   true,
-				},
-			}
+			c.Datastore.Spec = flatfsSpec()
 			return nil
 		},
 	},
-	"default-datastore": {
-		Description: `Restores default datastore configuration.
+	"badgerds": {
+		Description: `Configures the node to use the badger datastore.
 
-If you apply this profile after ipfs init, you will need
-to convert your datastore to the new configuration.
-You can do this using ipfs-ds-convert.
+This is the fastest datastore. Use this datastore if performance, especially
+when adding many gigabytes of files, is critical. However:
 
-For more on ipfs-ds-convert see
-$ ipfs-ds-convert --help
-and
-$ ipfs-ds-convert convert --help
-`,
+* This datastore will not properly reclaim space when your datastore is
+  smaller than several gigabytes. If you run IPFS with '--enable-gc' (you have
+  enabled block-level garbage collection), you plan on storing very little data in
+  your IPFS node, and disk usage is more critical than performance, consider using
+  flatfs.
+* This datastore uses up to several gigabytes of memory. 
 
+This profile may only be applied when first initializing the node.`,
+
+		InitOnly: true,
 		Transform: func(c *Config) error {
-			c.Datastore.Spec = DefaultDatastoreConfig().Spec
+			c.Datastore.Spec = badgerSpec()
 			return nil
 		},
 	},
@@ -187,6 +188,10 @@ fetching may be degraded.
 	},
 }
 
+func init() {
+	Profiles["default-datatore"] = Profiles["badgerds"]
+}
+
 func getAvailablePort() (port int, err error) {
 	ln, err := net.Listen("tcp", "[::]:0")
 	if err != nil {