Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-06-24 22:20:40 -04:00
Code Issues Projects Releases Packages Wiki Activity

debugd: add go package docs

Browse source
This commit is contained in:
Malte Poll 2023-01-24 16:08:04 +01:00 • committed by Malte Poll
parent ee869eaf9c
commit fc8a43f4f1
11 changed files with 39 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
debugd/internal/cdbg/cmd/root.go
View file

@ -4,6 +4,7 @@ Copyright (c) Edgeless Systems GmbH
SPDX-License-Identifier: AGPL-3.0-only SPDX-License-Identifier: AGPL-3.0-only
*/ */
// Package cmd contains the cdbg CLI.
package cmd package cmd
import ( import (

8
debugd/internal/debugd/debugd.go Normal file
View file

@ -0,0 +1,8 @@
/*
Copyright (c) Edgeless Systems GmbH
SPDX-License-Identifier: AGPL-3.0-only
*/
// Package debugd contains internal packages for the debugd.
package debugd

11
debugd/internal/debugd/deploy/deploy.go Normal file
View file

@ -0,0 +1,11 @@
/*
Copyright (c) Edgeless Systems GmbH
SPDX-License-Identifier: AGPL-3.0-only
*/
/*
Package deploy implements deployment of binaries and services to a Constellation instance.
It is used by the debugd.
*/
package deploy

2
debugd/internal/debugd/info/info.go
View file

@ -4,6 +4,8 @@ Copyright (c) Edgeless Systems GmbH
SPDX-License-Identifier: AGPL-3.0-only SPDX-License-Identifier: AGPL-3.0-only
*/ */
// Package info implements the info map that is
// used to distribute key–value pair between debugd instances.
package info package info
import ( import (

2
debugd/internal/debugd/logcollector/logcollector.go
View file

@ -4,6 +4,8 @@ Copyright (c) Edgeless Systems GmbH
SPDX-License-Identifier: AGPL-3.0-only SPDX-License-Identifier: AGPL-3.0-only
*/ */
// Package logcollector uses podman to deploy logstash and filebeat containers
// in order to collect logs centrally for debugging purposes.
package logcollector package logcollector
import ( import (

1
debugd/internal/debugd/metadata/cloudprovider/cloudprovider.go
View file

@ -4,6 +4,7 @@ Copyright (c) Edgeless Systems GmbH
SPDX-License-Identifier: AGPL-3.0-only SPDX-License-Identifier: AGPL-3.0-only
*/ */
// Package cloudprovider implements a metadata service for cloud providers.
package cloudprovider package cloudprovider
import ( import (

1
debugd/internal/debugd/metadata/fallback/fallback.go
View file

@ -4,6 +4,7 @@ Copyright (c) Edgeless Systems GmbH
SPDX-License-Identifier: AGPL-3.0-only SPDX-License-Identifier: AGPL-3.0-only
*/ */
// Package fallback implements a fake metadata backend.
package fallback package fallback
import ( import (

9
debugd/internal/debugd/metadata/metadata.go Normal file
View file

@ -0,0 +1,9 @@
/*
Copyright (c) Edgeless Systems GmbH
SPDX-License-Identifier: AGPL-3.0-only
*/
// Package metadata schedules the discovery of other debugd instances
// to exchange settings and binaries.
package metadata

1
debugd/internal/debugd/server/server.go
View file

@ -4,6 +4,7 @@ Copyright (c) Edgeless Systems GmbH
SPDX-License-Identifier: AGPL-3.0-only SPDX-License-Identifier: AGPL-3.0-only
*/ */
// Package server implements the gRPC endpoint of Constellation's debugd.
package server package server
import ( import (

2
debugd/internal/filetransfer/filetransfer.go
View file

@ -4,6 +4,8 @@ Copyright (c) Edgeless Systems GmbH
SPDX-License-Identifier: AGPL-3.0-only SPDX-License-Identifier: AGPL-3.0-only
*/ */
// Package filetransfer implements the exchange of files between cdgb <-> debugd
// and between debugd <-> debugd pairs.
package filetransfer package filetransfer
import ( import (

1
debugd/internal/filetransfer/streamer/streamer.go
View file

@ -4,6 +4,7 @@ Copyright (c) Edgeless Systems GmbH
SPDX-License-Identifier: AGPL-3.0-only SPDX-License-Identifier: AGPL-3.0-only
*/ */
// Package streamer implements streaming of files over gRPC.
package streamer package streamer
import ( import (