storagenode: add doc.go files for sno packages

Change-Id: I23d4b8b462e1b03718d0c4801cc2aaff520e7356
This commit is contained in:
Clement Sam 2021-09-27 12:35:48 +00:00
parent c053bdbd70
commit 0d58172c38
7 changed files with 33 additions and 0 deletions

View File

@ -0,0 +1,5 @@
// Copyright (C) 2021 Storj Labs, Inc.
// See LICENSE for copying information.
// Package bandwidth system keeps track of bandwidth usage as reported by order limits and orders.
package bandwidth

View File

@ -1,6 +1,7 @@
// Copyright (C) 2019 Storj Labs, Inc.
// See LICENSE for copying information.
// Package inspector provides a private endpoint for monitoring status.
package inspector
import (

View File

@ -1,6 +1,8 @@
// Copyright (C) 2019 Storj Labs, Inc.
// See LICENSE for copying information.
// Package monitor is responsible for monitoring the disk is well-behaved.
// It checks whether there's sufficient space and whether directories are writable.
package monitor
import (

View File

@ -0,0 +1,7 @@
// Copyright (C) 2021 Storj Labs, Inc.
// See LICENSE for copying information.
// Package orders handles order limit management.
// It contains file database for the orders.
// Similarly, it manages settlement, where order limits are sent to the satellite.
package orders

View File

@ -0,0 +1,6 @@
// Copyright (C) 2021 Storj Labs, Inc.
// See LICENSE for copying information.
// Package pieces is responsible for the low level piece management.
// It also provides ways to keep track of pieces metadata.
package pieces

View File

@ -0,0 +1,7 @@
// Copyright (C) 2021 Storj Labs, Inc.
// See LICENSE for copying information.
// Package piecestore contains the endpoint for responding to requests from the uplinks and satellites.
// It implements the upload and download protocol, where the counterpart is in uplink.
// It uses trust packages to establish trusted satellites.
package piecestore

5
storagenode/trust/doc.go Normal file
View File

@ -0,0 +1,5 @@
// Copyright (C) 2021 Storj Labs, Inc.
// See LICENSE for copying information.
// Package trust handles rules for accepting and denying connections from satellites.
package trust