Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package blobstore provides a client interface for storing blobs behind orchestrator services.
|
Package blobstore provides a client interface for storing blobs behind orchestrator services. |
|
Package clock provides a simple abstraction around the standard time package.
|
Package clock provides a simple abstraction around the standard time package. |
|
Package http2 contains a minimal implementation of non-TLS http/2 server and client Package http2 contains a minimal implementation of non-TLS http/2 server and client Package http2 contains a minimal implementation of non-TLS http/2 server and client
|
Package http2 contains a minimal implementation of non-TLS http/2 server and client Package http2 contains a minimal implementation of non-TLS http/2 server and client Package http2 contains a minimal implementation of non-TLS http/2 server and client |
|
server
Server's main package, run with obsidian -h to see all available options
|
Server's main package, run with obsidian -h to see all available options |
|
* Package plugin defines the interface for a plugin into the services provided * with the magma orchestrator.
|
* Package plugin defines the interface for a plugin into the services provided * with the magma orchestrator. |
|
Package serde contains the definition of a SERializer-DEserializer concept.
|
Package serde contains the definition of a SERializer-DEserializer concept. |
|
Package service outlines the Magma microservices framework in the cloud.
|
Package service outlines the Magma microservices framework in the cloud. |
|
middleware/unary
Package unary provides some default RPC interceptors and a wrapper around GRPC's unary interceptors called Interceptor.
|
Package unary provides some default RPC interceptors and a wrapper around GRPC's unary interceptors called Interceptor. |
|
services
|
|
|
accessd
Package accessd provides a thin client for access management service.
|
Package accessd provides a thin client for access management service. |
|
accessd/accessd
Access Control Manager is a service which stores, manages and verifies operator Identity objects and their rights to access (read/write) Entities.
|
Access Control Manager is a service which stores, manages and verifies operator Identity objects and their rights to access (read/write) Entities. |
|
accessd/protos
access_helper provides ToString() receiver for AccessControl_Permission mask
|
access_helper provides ToString() receiver for AccessControl_Permission mask |
|
accessd/servicers
Accessd service provides the gRPC interface for cloud services & REST server to check & manage Identity access permissions.
|
Accessd service provides the gRPC interface for cloud services & REST server to check & manage Identity access permissions. |
|
configurator
Package configurator contains the Configurator service which manages configuration of and relationships between logical network entities.
|
Package configurator contains the Configurator service which manages configuration of and relationships between logical network entities. |
|
configurator/storage
Package storage defines the storage interfaces and implementations for the configurator service.
|
Package storage defines the storage interfaces and implementations for the configurator service. |
|
device
Package device contains the device service.
|
Package device contains the device service. |
|
directoryd
Package directoryd provides an API for interacting with the directory lookup service, which manages UE location records.
|
Package directoryd provides an API for interacting with the directory lookup service, which manages UE location records. |
|
directoryd/directoryd
Package main implements dual purpose directory service which manages UE location records and provides RPCs to look them up: DirectoryLookupServer & GatewayDirectoryService GatewayDirectoryService RPC can be provided by a local Gateway/Device service as well as the cloud hosted service.
|
Package main implements dual purpose directory service which manages UE location records and provides RPCs to look them up: DirectoryLookupServer & GatewayDirectoryService GatewayDirectoryService RPC can be provided by a local Gateway/Device service as well as the cloud hosted service. |
|
dispatcher/httpserver
Package httpserver is a http/2 h2c server.
|
Package httpserver is a http/2 h2c server. |
|
magmad
Package magmad provides functions for taking actions at connected gateways.
|
Package magmad provides functions for taking actions at connected gateways. |
|
metricsd
Package metricsd supports metrics collection, augmentation, and export, as well as providing REST API endpoints for viewing metrics and managing alerts.
|
Package metricsd supports metrics collection, augmentation, and export, as well as providing REST API endpoints for viewing metrics and managing alerts. |
|
metricsd/collection
Package collection contains implementations of metric collectors and gatherers to perform local metric collection/aggregation.
|
Package collection contains implementations of metric collectors and gatherers to perform local metric collection/aggregation. |
|
metricsd/exporters
Package exporters provides an interface for converting protobuf metrics to timeseries datapoints and writing these datapoints to storage.
|
Package exporters provides an interface for converting protobuf metrics to timeseries datapoints and writing these datapoints to storage. |
|
state
Package state contains the state service, an orchestrator microservice which manages device-reported state.
|
Package state contains the state service, an orchestrator microservice which manages device-reported state. |
|
state/indexer
Package indexer provides tools to define, use, and update state indexers.
|
Package indexer provides tools to define, use, and update state indexers. |
|
state/types
Package types contains the types and associated methods for the state service.
|
Package types contains the types and associated methods for the state service. |
|
streamer
Package streamer provides a logical stream for orc8r to push updates to gateways.
|
Package streamer provides a logical stream for orc8r to push updates to gateways. |
|
Package sqorc implements orchestrator-specific SQL utilities like statement builders and transaction wrappers.
|
Package sqorc implements orchestrator-specific SQL utilities like statement builders and transaction wrappers. |
|
Package storage contains common definitions to be used across service storage interfaces
|
Package storage contains common definitions to be used across service storage interfaces |
|
tools
|
|
|
accessc
Command Line Tool to create & manage Operators, ACLs and Certificates
|
Command Line Tool to create & manage Operators, ACLs and Certificates |
|
accessc/handlers
Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality
|
Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality Package handlers implements individual accessc commands as well as common across multiple commands functionality |
|
commands
Package Commands provides common definitions & functionality for a CLI tool subcommand implementations
|
Package Commands provides common definitions & functionality for a CLI tool subcommand implementations |
|
migrations/m001_config_service/migration
DB migration script for the config service refactor.
|
DB migration script for the config service refactor. |
|
migrations/m002_cleanup_legacy_configs/migration
DB migration script to clean up old magmad config tables.
|
DB migration script to clean up old magmad config tables. |
|
swaggergen
swaggergen is a custom tool to generate Go code from swagger 2.0 spec files in a way that allows Magma to keep swagger files modular.
|
swaggergen is a custom tool to generate Go code from swagger 2.0 spec files in a way that allows Magma to keep swagger files modular. |
Click to show internal directories.
Click to hide internal directories.