README
¶
OpAMP Commander
Components
opampctl
- opampctl is a command line tool to control opampcommander.
Install
# opampctl
go install github.com/minuk-dev/opampcommander/cmd/opampctl@latest
# create config file
opampctl config init
apiserver
- apiserver is a server component to support OpAMP
How to run
- TBD
Development
Infrastructure Setup
This project uses MongoDB 4.4 as its database (for Raspberry Pi compatibility) and Kafka for distributed messaging. The Makefile provides convenient commands:
# Start MongoDB 4.4 (data persisted in ./default.mongodb)
make start-mongodb
# Start Kafka (for distributed mode)
make start-kafka
# Start all development services (MongoDB + Kafka)
make start-dev-services
# Stop services (data is preserved)
make stop-dev-services
# Clean all data (WARNING: removes all data)
make clean-dev-services
Development Commands
# Build and run apiserver with default settings
make run-dev-server
# Run standalone server (MongoDB only, no Kafka)
make run-standalone
# Run with custom arguments
make ARGS="--log.level=warn --log.format=text --metric.enabled" dev
# Run with GIN_MODE=release
GIN_MODE=release make ARGS="--log.level=warn --log.format=text --metric.enabled" dev
Testing
# Run unit tests
make unittest
# Run all tests including integration tests
make test
# Run E2E tests (requires Docker)
make test-e2e
# Run only Kafka E2E tests
make test-e2e-kafka
# Run only basic E2E tests
make test-e2e-basic
Release
Deployment
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api contains API models and definitions.
|
Package api contains API models and definitions. |
|
v1
Package v1 provides the API server for the application.
|
Package v1 provides the API server for the application. |
|
v1/auth
Package auth provides the authentication api for the opampcommander application
|
Package auth provides the authentication api for the opampcommander application |
|
v1/command
Package command provides the command api model for opampcommander.
|
Package command provides the command api model for opampcommander. |
|
v1/version
Package version provides api model for version information.
|
Package version provides api model for version information. |
|
cmd
|
|
|
apiserver
command
Package main provides the entry point for the opampcommander apiserver.
|
Package main provides the entry point for the opampcommander apiserver. |
|
opampctl
command
Package main is the entry point for the opampctl command line tool.
|
Package main is the entry point for the opampctl command line tool. |
|
internal
|
|
|
adapter/common/kafka
Package kafka provides Kafka messaging models.
|
Package kafka provides Kafka messaging models. |
|
adapter/in/http/auth/basic
Package basic provides a basic authentication controller for the opampcommander API client.
|
Package basic provides a basic authentication controller for the opampcommander API client. |
|
adapter/in/http/auth/github
Package github provides the GitHub oauth2 authentication controller for the opampcommander.
|
Package github provides the GitHub oauth2 authentication controller for the opampcommander. |
|
adapter/in/http/v1/agent
Package agent provides domain models for the agent
|
Package agent provides domain models for the agent |
|
adapter/in/http/v1/agentgroup
Package agentgroup provides HTTP handlers for managing agent groups.
|
Package agentgroup provides HTTP handlers for managing agent groups. |
|
adapter/in/http/v1/agentpackage
Package agentpackage contains controller for agent package related endpoints.
|
Package agentpackage contains controller for agent package related endpoints. |
|
adapter/in/http/v1/agentremoteconfig
Package agentremoteconfig contains controller for agent remote config endpoints.
|
Package agentremoteconfig contains controller for agent remote config endpoints. |
|
adapter/in/http/v1/certificate
Package certificate contains controller for certificate related endpoints.
|
Package certificate contains controller for certificate related endpoints. |
|
adapter/in/http/v1/connection
Package connection provides the HTTP controller for managing connections.
|
Package connection provides the HTTP controller for managing connections. |
|
adapter/in/http/v1/namespace
Package namespace contains controller for namespace related endpoints.
|
Package namespace contains controller for namespace related endpoints. |
|
adapter/in/http/v1/opamp
Package opamp provides the implementation of the OPAMP protocol.
|
Package opamp provides the implementation of the OPAMP protocol. |
|
adapter/in/http/v1/ping
Package ping provides the ping controller for the HTTP API.
|
Package ping provides the ping controller for the HTTP API. |
|
adapter/in/http/v1/rbac
Package rbac provides HTTP handlers for managing RBAC policies.
|
Package rbac provides HTTP handlers for managing RBAC policies. |
|
adapter/in/http/v1/role
Package role provides HTTP handlers for managing roles.
|
Package role provides HTTP handlers for managing roles. |
|
adapter/in/http/v1/rolebinding
Package rolebinding provides HTTP handlers for managing role bindings.
|
Package rolebinding provides HTTP handlers for managing role bindings. |
|
adapter/in/http/v1/server
Package server provides the HTTP controller for managing servers.
|
Package server provides the HTTP controller for managing servers. |
|
adapter/in/http/v1/user
Package user provides HTTP handlers for managing users.
|
Package user provides HTTP handlers for managing users. |
|
adapter/in/http/v1/version
Package version provides server version information.
|
Package version provides server version information. |
|
adapter/in/messaging/inmemory
Package inmemory implements in-memory messaging adapters for standalone mode.
|
Package inmemory implements in-memory messaging adapters for standalone mode. |
|
adapter/in/messaging/kafka
Package kafka provides Kafka messaging adapter implementations.
|
Package kafka provides Kafka messaging adapter implementations. |
|
adapter/out/identity/github
Package github provides a GitHub-specific identity provider adapter that resolves GitHub user identities and organization memberships for use with the RBAC system.
|
Package github provides a GitHub-specific identity provider adapter that resolves GitHub user identities and organization memberships for use with the RBAC system. |
|
adapter/out/messaging/kafka
Package kafka implements Kafka messaging adapters.
|
Package kafka implements Kafka messaging adapters. |
|
adapter/out/persistence/mongodb
Package mongodb provides the MongoDB adapter for the opampcommander application.
|
Package mongodb provides the MongoDB adapter for the opampcommander application. |
|
adapter/out/persistence/mongodb/entity
Package entity contains common entity definitions for MongoDB persistence.
|
Package entity contains common entity definitions for MongoDB persistence. |
|
adapter/out/rbac/casbin
Package casbin provides a Casbin-based RBAC enforcer adapter that implements the RBACEnforcerPort interface for permission management.
|
Package casbin provides a Casbin-based RBAC enforcer adapter that implements the RBACEnforcerPort interface for permission management. |
|
application/helper
Package helper provides helper functions for mapping between domain models and API models.
|
Package helper provides helper functions for mapping between domain models and API models. |
|
application/port
Package port is a package that defines the ports for the application layer.
|
Package port is a package that defines the ports for the application layer. |
|
application/service/admin
Package admin provides the implementation of the AdminUsecase interface.
|
Package admin provides the implementation of the AdminUsecase interface. |
|
application/service/agent
Package agent provides application services for the agent
|
Package agent provides application services for the agent |
|
application/service/agentgroup
Package agentgroup provides the AgentGroupManageService for managing agent groups.
|
Package agentgroup provides the AgentGroupManageService for managing agent groups. |
|
application/service/agentgroup/filter
Package filter provides filters for agentgroup domain model.
|
Package filter provides filters for agentgroup domain model. |
|
application/service/agentpackage
Package agentpackage provides the AgentPackageService for managing agent packages.
|
Package agentpackage provides the AgentPackageService for managing agent packages. |
|
application/service/agentpackage/filter
Package filter provides filters for agentpackage domain model.
|
Package filter provides filters for agentpackage domain model. |
|
application/service/agentremoteconfig
Package agentremoteconfig provides the service for managing agent remote configs.
|
Package agentremoteconfig provides the service for managing agent remote configs. |
|
application/service/agentremoteconfig/filter
Package filter provides filters for agentremoteconfig domain model.
|
Package filter provides filters for agentremoteconfig domain model. |
|
application/service/certificate
Package certificate provides the CertificateService for managing certificates.
|
Package certificate provides the CertificateService for managing certificates. |
|
application/service/certificate/filter
Package filter provides filters for certificate domain model.
|
Package filter provides filters for certificate domain model. |
|
application/service/namespace
Package namespace provides the NamespaceManageService for managing namespaces.
|
Package namespace provides the NamespaceManageService for managing namespaces. |
|
application/service/opamp
Package opamp provides the implementation of the OpAMP use case for managing connections and agents.
|
Package opamp provides the implementation of the OpAMP use case for managing connections and agents. |
|
application/service/permission
Package permission provides application services for permission management.
|
Package permission provides application services for permission management. |
|
application/service/rbac
Package rbac provides application services for RBAC authorization.
|
Package rbac provides application services for RBAC authorization. |
|
application/service/role
Package role provides application services for role management.
|
Package role provides application services for role management. |
|
application/service/rolebinding
Package rolebinding provides application services for RoleBinding management.
|
Package rolebinding provides application services for RoleBinding management. |
|
application/service/user
Package user provides application services for user management.
|
Package user provides application services for user management. |
|
domain/agent/model
Package agentmodel provides agent domain models.
|
Package agentmodel provides agent domain models. |
|
domain/agent/model/agent
Package agent provides domain models for the agent
|
Package agent provides domain models for the agent |
|
domain/agent/model/serverevent
Package serverevent defines server-to-server event models.
|
Package serverevent defines server-to-server event models. |
|
domain/agent/port
Package agentport provides port interfaces for the agent domain.
|
Package agentport provides port interfaces for the agent domain. |
|
domain/agent/service
Package agentservice provides domain services for the agent domain.
|
Package agentservice provides domain services for the agent domain. |
|
domain/model
Package model provides domain models for the opampcommander application.
|
Package model provides domain models for the opampcommander application. |
|
domain/model/vo
Package vo provides value objects vo package does not have any dependencies on other packages except the standard library
|
Package vo provides value objects vo package does not have any dependencies on other packages except the standard library |
|
domain/port
Package port provides ports which is defined in the hexagonal architecture.
|
Package port provides ports which is defined in the hexagonal architecture. |
|
domain/user/model
Package usermodel provides user domain models.
|
Package usermodel provides user domain models. |
|
domain/user/port
Package userport provides port interfaces for the user domain.
|
Package userport provides port interfaces for the user domain. |
|
domain/user/service
Package userservice provides domain services for the user domain.
|
Package userservice provides domain services for the user domain. |
|
helper
Package helper provides utility functions for graceful shutdown management.
|
Package helper provides utility functions for graceful shutdown management. |
|
management
Package management provides core management interfaces and types.
|
Package management provides core management interfaces and types. |
|
management/healthcheck
Package healthcheck provides health and readiness check functionality.
|
Package healthcheck provides health and readiness check functionality. |
|
management/observability
Package observability provides observability features for the application.
|
Package observability provides observability features for the application. |
|
management/pprof
Package pprof provides functionalities for performance profiling.
|
Package pprof provides functionalities for performance profiling. |
|
security
Package security provides security-related functionality for the opampcommander application.
|
Package security provides security-related functionality for the opampcommander application. |
|
pkg
|
|
|
apiserver
Package apiserver provides app logic for the opampcommander apiserver.
|
Package apiserver provides app logic for the opampcommander apiserver. |
|
apiserver/config
Package config provides the configuration for the opampcommander application.
|
Package config provides the configuration for the opampcommander application. |
|
apiserver/docs
Package docs Code generated by swaggo/swag.
|
Package docs Code generated by swaggo/swag. |
|
apiserver/module/application
Package application provides the application services module for the API server.
|
Package application provides the application services module for the API server. |
|
apiserver/module/domain
Package domain provides the domain services module for the API server.
|
Package domain provides the domain services module for the API server. |
|
apiserver/module/helper
Package helper provides utility functions and types to assist in building the application.
|
Package helper provides utility functions and types to assist in building the application. |
|
apiserver/module/helper/lifecycle
Package lifecycle provides application lifecycle management.
|
Package lifecycle provides application lifecycle management. |
|
apiserver/module/helper/management
Package management provides management HTTP server functionality.
|
Package management provides management HTTP server functionality. |
|
apiserver/module/infrastructure
Package infrastructure provides infrastructure components module for the API server.
|
Package infrastructure provides infrastructure components module for the API server. |
|
client
Package client provides a client for the opampcommander API server.
|
Package client provides a client for the opampcommander API server. |
|
clientutil
Package clientutil provides some util functions to set client
|
Package clientutil provides some util functions to set client |
|
cmd/apiserver
Package apiserver provides the command for the apiserver.
|
Package apiserver provides the command for the apiserver. |
|
cmd/opampctl
Package opampctl implements the opampctl command line tool.
|
Package opampctl implements the opampctl command line tool. |
|
cmd/opampctl/config
Package config provides the command line for the opampctl tool.
|
Package config provides the command line for the opampctl tool. |
|
cmd/opampctl/config/init
Package init provides the init command for opampctl.
|
Package init provides the init command for opampctl. |
|
cmd/opampctl/config/view
Package view provides the view command for opampctl.
|
Package view provides the view command for opampctl. |
|
cmd/opampctl/context
Package context provides the context command for opampctl.
|
Package context provides the context command for opampctl. |
|
cmd/opampctl/context/ls
Package ls provides the ls command for opampctl context.
|
Package ls provides the ls command for opampctl context. |
|
cmd/opampctl/context/use
Package use provides the use command for opampctl context.
|
Package use provides the use command for opampctl context. |
|
cmd/opampctl/create
Package create provides the create command for opampctl.
|
Package create provides the create command for opampctl. |
|
cmd/opampctl/create/agentgroup
Package agentgroup provides the create agentgroup command for opampctl.
|
Package agentgroup provides the create agentgroup command for opampctl. |
|
cmd/opampctl/create/agentpackage
Package agentpackage provides the create agentpackage command for opampctl.
|
Package agentpackage provides the create agentpackage command for opampctl. |
|
cmd/opampctl/create/agentremoteconfig
Package agentremoteconfig provides the create agentremoteconfig command for opampctl.
|
Package agentremoteconfig provides the create agentremoteconfig command for opampctl. |
|
cmd/opampctl/create/certificate
Package certificate provides the create certificate command for opampctl.
|
Package certificate provides the create certificate command for opampctl. |
|
cmd/opampctl/create/namespace
Package namespace provides the command to create a namespace.
|
Package namespace provides the command to create a namespace. |
|
cmd/opampctl/create/role
Package role provides the create role command for opampctl.
|
Package role provides the create role command for opampctl. |
|
cmd/opampctl/create/rolebinding
Package rolebinding provides the create rolebinding command for opampctl.
|
Package rolebinding provides the create rolebinding command for opampctl. |
|
cmd/opampctl/deletecmd
Package deletecmd implements the 'opampctl delete' command.
|
Package deletecmd implements the 'opampctl delete' command. |
|
cmd/opampctl/deletecmd/agentgroup
Package agentgroup implements the 'opampctl delete agentgroup' command.
|
Package agentgroup implements the 'opampctl delete agentgroup' command. |
|
cmd/opampctl/deletecmd/agentpackage
Package agentpackage implements the 'opampctl delete agentpackage' command.
|
Package agentpackage implements the 'opampctl delete agentpackage' command. |
|
cmd/opampctl/deletecmd/agentremoteconfig
Package agentremoteconfig implements the 'opampctl delete agentremoteconfig' command.
|
Package agentremoteconfig implements the 'opampctl delete agentremoteconfig' command. |
|
cmd/opampctl/deletecmd/certificate
Package certificate implements the 'opampctl delete certificate' command.
|
Package certificate implements the 'opampctl delete certificate' command. |
|
cmd/opampctl/deletecmd/namespace
Package namespace provides the command to delete a namespace.
|
Package namespace provides the command to delete a namespace. |
|
cmd/opampctl/deletecmd/role
Package role implements the 'opampctl delete role' command.
|
Package role implements the 'opampctl delete role' command. |
|
cmd/opampctl/deletecmd/rolebinding
Package rolebinding implements the 'opampctl delete rolebinding' command.
|
Package rolebinding implements the 'opampctl delete rolebinding' command. |
|
cmd/opampctl/deletecmd/user
Package user implements the 'opampctl delete user' command.
|
Package user implements the 'opampctl delete user' command. |
|
cmd/opampctl/get
Package get provides the get command for opampctl.
|
Package get provides the get command for opampctl. |
|
cmd/opampctl/get/agent
Package agent provides the command to get agent information.
|
Package agent provides the command to get agent information. |
|
cmd/opampctl/get/agentgroup
Package agentgroup implements the 'opampctl get agentgroup' command.
|
Package agentgroup implements the 'opampctl get agentgroup' command. |
|
cmd/opampctl/get/agentpackage
Package agentpackage implements the 'opampctl get agentpackage' command.
|
Package agentpackage implements the 'opampctl get agentpackage' command. |
|
cmd/opampctl/get/agentremoteconfig
Package agentremoteconfig implements the 'opampctl get agentremoteconfig' command.
|
Package agentremoteconfig implements the 'opampctl get agentremoteconfig' command. |
|
cmd/opampctl/get/certificate
Package certificate implements the 'opampctl get certificate' command.
|
Package certificate implements the 'opampctl get certificate' command. |
|
cmd/opampctl/get/connection
Package connection provides the command to get connection information.
|
Package connection provides the command to get connection information. |
|
cmd/opampctl/get/namespace
Package namespace provides the command to get namespace information.
|
Package namespace provides the command to get namespace information. |
|
cmd/opampctl/get/role
Package role provides the command to get role information.
|
Package role provides the command to get role information. |
|
cmd/opampctl/get/rolebinding
Package rolebinding implements the 'opampctl get rolebinding' command.
|
Package rolebinding implements the 'opampctl get rolebinding' command. |
|
cmd/opampctl/get/user
Package user provides the command to get user information.
|
Package user provides the command to get user information. |
|
cmd/opampctl/rbac
Package rbac provides the rbac command for opampctl.
|
Package rbac provides the rbac command for opampctl. |
|
cmd/opampctl/rbac/check
Package check provides the rbac check command for opampctl.
|
Package check provides the rbac check command for opampctl. |
|
cmd/opampctl/restart
Package restart provides the restart command for opampctl.
|
Package restart provides the restart command for opampctl. |
|
cmd/opampctl/set
Package set provides the set command for opampctl.
|
Package set provides the set command for opampctl. |
|
cmd/opampctl/set/agent
Package agent provides the command to set agent configurations.
|
Package agent provides the command to set agent configurations. |
|
cmd/opampctl/version
Package version provides a command to print the version of opampctl.
|
Package version provides a command to print the version of opampctl. |
|
cmd/opampctl/whoami
Package whoami provides the whoami command for opampctl.
|
Package whoami provides the whoami command for opampctl. |
|
cmdutil
Package cmdutil contains utility functions for command-line commands.
|
Package cmdutil contains utility functions for command-line commands. |
|
datastructure/sets
Package sets provides a simple implementation of a set data structure.
|
Package sets provides a simple implementation of a set data structure. |
|
filecache
Package filecache provides a file cache
|
Package filecache provides a file cache |
|
formatter
Package formatter provides functions to format data structures into different output formats such as YAML, JSON, and text.
|
Package formatter provides functions to format data structures into different output formats such as YAML, JSON, and text. |
|
ginutil
Package ginutil provides utility functions for working with Gin HTTP framework.
|
Package ginutil provides utility functions for working with Gin HTTP framework. |
|
opampctl/config
Package config provides the configuration for opampctl.
|
Package config provides the configuration for opampctl. |
|
opampctl/configutil
Package configutil provides utilities for working with configuration files in the opampctl tool.
|
Package configutil provides utilities for working with configuration files in the opampctl tool. |
|
testutil
Package testutil provides utility functions and types for testing.
|
Package testutil provides utility functions and types for testing. |
|
timeutil
Package timeutil provides utility functions for time manipulation.
|
Package timeutil provides utility functions for time manipulation. |
|
utils/clock
Package clock provides a clock interface.
|
Package clock provides a clock interface. |
|
version
Package version provides utilities for handling version information.
|
Package version provides utilities for handling version information. |
|
xsync
Package xsync provides a data structure that allows for concurrent access and modification.
|
Package xsync provides a data structure that allows for concurrent access and modification. |
Click to show internal directories.
Click to hide internal directories.