Skip to content

Commit

Permalink
feat: explicit announce-on/off profiles
Browse files Browse the repository at this point in the history
moving reprovide on/off to separate profile to avoid footgun
where node no longer announces to DHT + ipfs daemon check
that prints warning on start if reprovide system is disabled
  • Loading branch information
lidel committed Sep 27, 2024
1 parent 58434ec commit 0ea4eaa
Show file tree
Hide file tree
Showing 4 changed files with 98 additions and 33 deletions.
17 changes: 16 additions & 1 deletion cmd/ipfs/kubo/daemon.go
Original file line number Diff line number Diff line change
Expand Up @@ -600,8 +600,23 @@ take effect.
fmt.Println("(Hit ctrl-c again to force-shutdown the daemon.)")
}()

// Give the user heads up if daemon running in online mode has no peers after 1 minute
if !offline {
// Warn users who were victims of 'lowprofile' footgun (https://github.com/ipfs/kubo/pull/10524)
if cfg.Experimental.StrategicProviding {
fmt.Println(`

Check failure on line 606 in cmd/ipfs/kubo/daemon.go

View workflow job for this annotation

GitHub Actions / go-check

fmt.Println arg list ends with redundant newline

Check failure on line 606 in cmd/ipfs/kubo/daemon.go

View workflow job for this annotation

GitHub Actions / go-test

fmt.Println arg list ends with redundant newline

Check failure on line 606 in cmd/ipfs/kubo/daemon.go

View workflow job for this annotation

GitHub Actions / go-lint

printf: `fmt.Println` arg list ends with redundant newline (govet)
⚠️ Reprovide system is disabled due to 'Experimental.StrategicProviding=true'
⚠️ Local CIDs will not be announced to Amino DHT, making them impossible to retrieve without manual peering
⚠️ If this is not intentional, call 'ipfs config profile apply announce-on'
`)
} else if cfg.Reprovider.Interval.WithDefault(config.DefaultReproviderInterval) == 0 {
fmt.Println(`

Check failure on line 612 in cmd/ipfs/kubo/daemon.go

View workflow job for this annotation

GitHub Actions / go-check

fmt.Println arg list ends with redundant newline

Check failure on line 612 in cmd/ipfs/kubo/daemon.go

View workflow job for this annotation

GitHub Actions / go-test

fmt.Println arg list ends with redundant newline

Check failure on line 612 in cmd/ipfs/kubo/daemon.go

View workflow job for this annotation

GitHub Actions / go-lint

printf: `fmt.Println` arg list ends with redundant newline (govet)
⚠️ Reprovider system is disabled due to 'Reprovider.Interval=0'
⚠️ Local CIDs will not be announced to Amino DHT, making them impossible to retrieve without manual peering
⚠️ If this is not intentional, call 'ipfs config profile apply announce-on', or set 'Reprovider.Interval=22h'
`)
}

// Give the user heads up if daemon running in online mode has no peers after 1 minute
time.AfterFunc(1*time.Minute, func() {
cfg, err := cctx.GetConfig()
if err != nil {
Expand Down
27 changes: 26 additions & 1 deletion config/profile.go
Original file line number Diff line number Diff line change
Expand Up @@ -174,10 +174,12 @@ functionality - performance of content discovery and data
fetching may be degraded.
`,
Transform: func(c *Config) error {
// Disable "server" services (dht, autonat, limited relay)
c.Routing.Type = NewOptionalString("autoclient")
c.AutoNAT.ServiceMode = AutoNATServiceDisabled
c.Reprovider.Interval = NewOptionalDuration(0)
c.Swarm.RelayService.Enabled = False

// Keep bare minimum connections around
lowWater := int64(20)
highWater := int64(40)
gracePeriod := time.Minute
Expand All @@ -188,6 +190,29 @@ fetching may be degraded.
return nil
},
},
"announce-off": {
Description: `Disables Reprovide system (and announcing to Amino DHT).
USE WITH CAUTION:
The main use case for this is setups with manual Peering.Peers config.
Data from this node will not be announced on the DHT. This will make
DHT-based routing an data retrieval impossible if this node is the only
one hosting it, and other peers are not already connected to it.
`,
Transform: func(c *Config) error {
c.Reprovider.Interval = NewOptionalDuration(0) // 0 disables periodic reprovide
c.Experimental.StrategicProviding = true // this is not a typo (the name is counter-intuitive)
return nil
},
},
"announce-on": {
Description: `Re-enables Reprovide system (reverts announce-off profile).`,
Transform: func(c *Config) error {
c.Reprovider.Interval = NewOptionalDuration(DefaultReproviderInterval) // have to apply explicit default because nil would be ignored
c.Experimental.StrategicProviding = false // this is not a typo (the name is counter-intuitive)
return nil
},
},
"randomports": {
Description: `Use a random port number for swarm.`,

Expand Down
13 changes: 13 additions & 0 deletions docs/changelogs/v0.31.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,26 @@

- [Overview](#overview)
- [🔦 Highlights](#-highlights)
- [`lowpower` profile no longer breaks DHT announcements](#lowpower-profile-no-longer-breaks-dht-announcements)
- [📝 Changelog](#-changelog)
- [👨‍👩‍👧‍👦 Contributors](#-contributors)

### Overview

### 🔦 Highlights

#### `lowpower` profile no longer breaks DHT announcements

We've notices users were applying `lowpower` profile, and then reporting content routing issues. This was because `lowpower` disabled reprovider system and locally hosted data was no longer announced on Amino DHT.

This release changes [`lowpower` profile](https://github.com/ipfs/kubo/blob/master/docs/config.md#lowpower-profile) to not change reprovider settings, ensuring the new users are not sabotaging themselves. It also adds [`annouce-on`](https://github.com/ipfs/kubo/blob/master/docs/config.md#announce-on-profile) and [`announce-off`](https://github.com/ipfs/kubo/blob/master/docs/config.md#announce-off-profile) profiles for controlling announcement settings separately.

> [!IMPORTANT]
> If you've ever applied the `lowpower` profile before, there is a high chance your node is not announcing to DHT anymore.
> If you have `Reprovider.Interval` set to `0` you may want to wet it to `22h` (or run `ipfs config profile apply announce-on`) to fix your system.
>
> As a convenience, `ipfs daemon` will warn if reprovide system is disabled, creating oportinity to fix configuration if it was not intentional.
### 📝 Changelog

### 👨‍👩‍👧‍👦 Contributors
74 changes: 43 additions & 31 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ Map of HTTP headers to set on responses from the RPC (`/api/v0`) HTTP server.
Example:
```json
{
"Foo": ["bar"]
"Foo": ["bar"]
}
```

Expand Down Expand Up @@ -534,27 +534,27 @@ Default:
```
{
"mounts": [
{
"child": {
"path": "blocks",
"shardFunc": "/repo/flatfs/shard/v1/next-to-last/2",
"sync": true,
"type": "flatfs"
},
"mountpoint": "/blocks",
"prefix": "flatfs.datastore",
"type": "measure"
},
{
"child": {
"compression": "none",
"path": "datastore",
"type": "levelds"
},
"mountpoint": "/",
"prefix": "leveldb.datastore",
"type": "measure"
}
{
"child": {
"path": "blocks",
"shardFunc": "/repo/flatfs/shard/v1/next-to-last/2",
"sync": true,
"type": "flatfs"
},
"mountpoint": "/blocks",
"prefix": "flatfs.datastore",
"type": "measure"
},
{
"child": {
"compression": "none",
"path": "datastore",
"type": "levelds"
},
"mountpoint": "/",
"prefix": "leveldb.datastore",
"type": "measure"
}
],
"type": "mount"
}
Expand Down Expand Up @@ -1126,7 +1126,7 @@ Example:
"API" : {
"Endpoint" : "https://pinningservice.tld:1234/my/api/path",
"Key" : "someOpaqueKey"
}
}
}
}
}
Expand Down Expand Up @@ -2420,18 +2420,30 @@ This profile may only be applied when first initializing the node.

### `lowpower` profile

Reduces daemon overhead on the system. Affects node
functionality - performance of content discovery and data
fetching may be degraded.

> [!CAUTION]
> Local data won't be announced on routing systems like Amino DHT.
Reduces daemon overhead on the system by disabling optional swarm services.

- [`Routing.Type`](#routingtype) set to `autoclient` (no DHT server, only client).
- `Swarm.ConnMgr` set to maintain minimum number of p2p connections at a time.
- Disables [`Reprovider`](#reprovider) service → no CID will be announced on Amino DHT and other routing systems(!)
- Disables [`AutoNAT`](#autonat).
- Disables [`Swam.RelayService`](#swarmrelayservice).

> [!NOTE]
> This profile is provided for legacy reasons.
> With modern Kubo setting the above should not be necessary.

### `announce-off` profile

Disables [Reprovide](#reprovide) system (and announcing to Amino DHT).

> [!CAUTION]
> The main use case for this is setups with manual Peering.Peers config.
> Data from this node will not be announced on the DHT. This will make
> DHT-based routing an data retrieval impossible if this node is the only
> one hosting it, and other peers are not already connected to it.

### `announce-on` profile

Use this profile with caution.
(Re-)enables [Reprovide](#reprovide) system (reverts [`announce-off` profile](#annouce-off-profile).

### `legacy-cid-v0` profile

Expand Down

0 comments on commit 0ea4eaa

Please sign in to comment.