sendnrw/netbird
2
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-09-01 20:41:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add docstrings to mdm_integration

Browse Source
This commit is contained in:
riccardom
2026-06-09 10:49:57 +00:00
parent d7f00b3beb
commit bd9fed41ad
13 changed files with 129 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
client/cmd/debug.go
View File

@@ -109,7 +109,9 @@ var debugConfigCmd = &cobra.Command{
// debugConfigDump requests the daemon for the resolved effective configuration and prints it as indented JSON.
// It resolves the active profile and current OS user, calls DaemonService.GetConfig with those values, and
// marshals the response using protojson with default/zero-valued fields included.
// Returns an error if profile or user lookup fails, the gRPC call fails, or the response cannot be marshaled.
// debugConfigDump prints the daemon's effective configuration for the active profile and current OS user as indented JSON.
// It requests the configuration from the daemon and writes the protobuf response with default fields emitted to stdout.
// Returns an error if active profile or user lookup fails, the daemon RPC fails, or the response cannot be marshaled.
func debugConfigDump(cmd *cobra.Command, _ []string) error {
pm := profilemanager.NewProfileManager()
activeProf, err := pm.GetActiveProfile()
@@ -155,7 +157,10 @@ func debugConfigDump(cmd *cobra.Command, _ []string) error {
// local file path and, if uploaded, the uploaded file key.
// It uses the package flags (anonymize, system info, log file count, CLI version and
// optional upload URL) to configure the bundle request. Returns an error if the RPC
// fails or if the daemon reports an upload failure reason.
// debugBundle requests creation of a debug bundle from the daemon and prints
// the local bundle file path and, if uploading was enabled, the uploaded file key.
// It returns an error if the RPC fails, if the daemon reports an upload failure
// reason, or if establishing the connection fails.
func debugBundle(cmd *cobra.Command, _ []string) error {
conn, err := getClient(cmd)
if err != nil {

14
client/cmd/root.go
View File

@@ -95,7 +95,9 @@ var (
}
)
// Execute executes the root command.
// Execute runs the appropriate Cobra command for the CLI.
// If the process is the update binary it delegates to updateCmd; otherwise it runs the root command.
// It returns any error produced during command execution.
func Execute() error {
if isUpdateBinary() {
return updateCmd.Execute()
@@ -108,7 +110,15 @@ func Execute() error {
// registers persistent flags (daemon address, management/admin URLs, logging, setup key, preshared key,
// hostname, anonymize, config path), attaches top-level and nested subcommands to the root command,
// and configures `up` command specific flags (external IP maps, DNS resolver address, Rosenpass options,
// auto-connect disabling, and lazy connection).
// init initializes package-level defaults and configures the root Cobra command.
//
// It sets default configuration and log directory paths (including legacy Wiretrustee
// locations) based on the runtime OS, builds default config/log file paths, and selects
// a platform-appropriate default daemon address. It registers persistent CLI flags
// (including mutually exclusive setup-key and setup-key-file), attaches top-level
// commands and subcommands to the root command, and registers `up`-specific persistent
// flags for external IP mapping, custom DNS resolver address, Rosenpass options,
// auto-connect disabling, and lazy connection.
func init() {
defaultConfigPathDir = "/etc/netbird/"
defaultLogFileDir = "/var/log/netbird/"