Skip to content
This repository was archived by the owner on Mar 9, 2022. It is now read-only.

Commit 8ff5edc

Browse files
authored
docs: updated flatfs/badger profile helptext (#167)
This is copy-paste from ipfs/kubo#8662 to ensure consistency.
1 parent 49f6a3e commit 8ff5edc

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

profile.go

+18-16
Original file line numberDiff line numberDiff line change
@@ -123,18 +123,16 @@ This profile may only be applied when first initializing the node.
123123
"flatfs": {
124124
Description: `Configures the node to use the flatfs datastore.
125125
126-
This is the most battle-tested and reliable datastore, but it's significantly
127-
slower than the badger datastore. You should use this datastore if:
126+
This is the most battle-tested and reliable datastore.
127+
You should use this datastore if:
128128
129-
* You need a very simple and very reliable datastore and you trust your
129+
* You need a very simple and very reliable datastore, and you trust your
130130
filesystem. This datastore stores each block as a separate file in the
131131
underlying filesystem so it's unlikely to loose data unless there's an issue
132132
with the underlying file system.
133-
* You need to run garbage collection on a small (<= 10GiB) datastore. The
134-
default datastore, badger, can leave several gigabytes of data behind when
135-
garbage collecting.
136-
* You're concerned about memory usage. In its default configuration, badger can
137-
use up to several gigabytes of memory.
133+
* You need to run garbage collection in a way that reclaims free space as soon as possible.
134+
* You want to minimize memory usage.
135+
* You are ok with the default speed of data import, or prefer to use --nocopy.
138136
139137
This profile may only be applied when first initializing the node.
140138
`,
@@ -146,17 +144,21 @@ This profile may only be applied when first initializing the node.
146144
},
147145
},
148146
"badgerds": {
149-
Description: `Configures the node to use the badger datastore.
147+
Description: `Configures the node to use the experimental badger datastore.
150148
151-
This is the fastest datastore. Use this datastore if performance, especially
152-
when adding many gigabytes of files, is critical. However:
149+
Use this datastore if some aspects of performance,
150+
especially the speed of adding many gigabytes of files, are critical.
151+
However, be aware that:
153152
154153
* This datastore will not properly reclaim space when your datastore is
155-
smaller than several gigabytes. If you run IPFS with '--enable-gc' (you have
156-
enabled block-level garbage collection), you plan on storing very little data in
157-
your IPFS node, and disk usage is more critical than performance, consider using
158-
flatfs.
159-
* This datastore uses up to several gigabytes of memory.
154+
smaller than several gigabytes. If you run IPFS with --enable-gc, you plan
155+
on storing very little data in your IPFS node, and disk usage is more
156+
critical than performance, consider using flatfs.
157+
* This datastore uses up to several gigabytes of memory.
158+
* Good for medium-size datastores, but may run into performance issues
159+
if your dataset is bigger than a terabyte.
160+
* The current implementation is based on old badger 1.x
161+
which is no longer supported by the upstream team.
160162
161163
This profile may only be applied when first initializing the node.`,
162164

0 commit comments

Comments
 (0)