Skip to content

Commit

Permalink
morph: support reloading morph endpoints with SIGHUP
Browse files Browse the repository at this point in the history
Add a new function `Client.Reload` that passes the `WithEndpoints` option and
updates the `Client` endpoints.
Add docs.

Closes #1871.

Signed-off-by: Andrey Butusov <andrey@nspcc.io>
  • Loading branch information
End-rey committed Nov 6, 2024
1 parent 4304cf4 commit 19aff22
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ attribute, which is used for container domain name in NNS contracts (#2954)
- `neofs-cli control object revive` command (#2968)
- `--disable-auto-gen-tag` flag for gendoc command (#2983)
- Docs files for cli commands to the `docs/cli-commands` folder (#2983)
- Reloading morph endpoints with SIGHUP (#2998)

### Fixed
- Do not search for tombstones when handling their expiration, use local indexes instead (#2929)
Expand Down
4 changes: 4 additions & 0 deletions cmd/neofs-node/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -870,6 +870,10 @@ func (c *cfg) configWatcher(ctx context.Context) {
continue
}

// Morph

c.cli.Reload(client.WithEndpoints(c.morph.endpoints))

Check warning on line 876 in cmd/neofs-node/config.go

View check run for this annotation

Codecov / codecov/patch

cmd/neofs-node/config.go#L875-L876

Added lines #L875 - L876 were not covered by tests
c.log.Info("configuration has been reloaded successfully")
case <-ctx.Done():
return
Expand Down
6 changes: 6 additions & 0 deletions docs/sighup.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,9 @@ comparing paths from `shard.blobstor` section. After this we have 3 sets:
| Changed section | Actions |
|-----------------|----------------------------------------------------------------------------------------------------------------------|
| `path` | If `path` is different, metabase is closed and opened with a new path. All other configuration will also be updated. |

### Morph

| Changed section | Actions |
|-----------------|----------------------|
| `endpoints` | Update N3 endpoints. |
4 changes: 3 additions & 1 deletion pkg/morph/client/constructor.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ type cfg struct {
autoSidechainScope bool
signer *transaction.Signer

endpoints []string
endpoints []string
endpointsLock *sync.RWMutex

singleCli *rpcclient.WSClient // neo-go client for single client mode

Expand All @@ -63,6 +64,7 @@ func defaultConfig() *cfg {
signer: &transaction.Signer{
Scopes: transaction.CalledByEntry,
},
endpointsLock: &sync.RWMutex{},

Check warning on line 67 in pkg/morph/client/constructor.go

View check run for this annotation

Codecov / codecov/patch

pkg/morph/client/constructor.go#L67

Added line #L67 was not covered by tests
reconnectionDelay: 5 * time.Second,
reconnectionRetries: 5,
}
Expand Down
3 changes: 3 additions & 0 deletions pkg/morph/client/multi.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ func (c *Client) switchRPC() *connection {
}

func (c *Client) connEndpoints() *connection {
c.cfg.endpointsLock.RLock()
defer c.cfg.endpointsLock.RUnlock()

Check warning on line 38 in pkg/morph/client/multi.go

View check run for this annotation

Codecov / codecov/patch

pkg/morph/client/multi.go#L36-L38

Added lines #L36 - L38 were not covered by tests
// Iterate endpoints.
for _, e := range c.cfg.endpoints {

Check warning on line 40 in pkg/morph/client/multi.go

View check run for this annotation

Codecov / codecov/patch

pkg/morph/client/multi.go#L40

Added line #L40 was not covered by tests
conn, err := c.newConnection(e)
Expand Down
15 changes: 15 additions & 0 deletions pkg/morph/client/reload.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package client

// Reload allows runtime reconfiguration for WithEndpoints parameter.
func (c *Client) Reload(opts ...Option) {
cfg := new(cfg)
for _, o := range opts {
o(cfg)
}

Check warning on line 8 in pkg/morph/client/reload.go

View check run for this annotation

Codecov / codecov/patch

pkg/morph/client/reload.go#L4-L8

Added lines #L4 - L8 were not covered by tests

c.cfg.endpointsLock.Lock()

c.cfg.endpoints = cfg.endpoints

c.cfg.endpointsLock.Unlock()

Check warning on line 14 in pkg/morph/client/reload.go

View check run for this annotation

Codecov / codecov/patch

pkg/morph/client/reload.go#L10-L14

Added lines #L10 - L14 were not covered by tests
}

0 comments on commit 19aff22

Please sign in to comment.