Documentation ¶
Index ¶
- func ApiToOpenApiSpec(apiRegistrationRequests map[string][]*apispb.RegistrationRequest, ...) (*openapi3.T, error)
- func GetMigrationImageBuildContexts(allServiceRequirements []*ServiceRequirements, fs afero.Fs) (map[string]*runtime.RuntimeBuildContext, error)
- func ServiceRequirementsToSpec(projectName string, environmentVariables map[string]string, ...) (*deploymentspb.Spec, error)
- type ApiCollectorServer
- type ProjectErrors
- type ServiceRequirements
- func (s *ServiceRequirements) Declare(ctx context.Context, req *resourcespb.ResourceDeclareRequest) (*resourcespb.ResourceDeclareResponse, error)
- func (s *ServiceRequirements) Error() error
- func (s *ServiceRequirements) HandleEvents(stream websocketspb.WebsocketHandler_HandleEventsServer) error
- func (s *ServiceRequirements) HasDatabases() bool
- func (s *ServiceRequirements) Listen(stream storagepb.StorageListener_ListenServer) error
- func (s *ServiceRequirements) Proxy(stream httppb.Http_ProxyServer) error
- func (s *ServiceRequirements) Schedule(stream schedulespb.Schedules_ScheduleServer) error
- func (s *ServiceRequirements) Serve(stream apispb.Api_ServeServer) error
- func (s *ServiceRequirements) Subscribe(stream topicspb.Subscriber_SubscribeServer) error
- func (s *ServiceRequirements) WorkerCount() int
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ApiToOpenApiSpec ¶
func ApiToOpenApiSpec(apiRegistrationRequests map[string][]*apispb.RegistrationRequest, apiSecurityDefinitions map[string]map[string]*resourcespb.ApiSecurityDefinitionResource, projectErrors *ProjectErrors) (*openapi3.T, error)
func GetMigrationImageBuildContexts ¶ added in v1.42.0
func GetMigrationImageBuildContexts(allServiceRequirements []*ServiceRequirements, fs afero.Fs) (map[string]*runtime.RuntimeBuildContext, error)
Collect a list of migration images that need to be built these requirements need to be supplied to the deployment serviceS
func ServiceRequirementsToSpec ¶
func ServiceRequirementsToSpec(projectName string, environmentVariables map[string]string, allServiceRequirements []*ServiceRequirements, defaultMigrationImage string) (*deploymentspb.Spec, error)
convert service requirements to a cloud bill of materials
Types ¶
type ApiCollectorServer ¶
type ApiCollectorServer struct { apispb.UnimplementedApiServer // contains filtered or unexported fields }
func (*ApiCollectorServer) Serve ¶
func (s *ApiCollectorServer) Serve(stream apispb.Api_ServeServer) error
type ProjectErrors ¶
type ProjectErrors struct {
// contains filtered or unexported fields
}
func (*ProjectErrors) Add ¶
func (pe *ProjectErrors) Add(err error)
func (ProjectErrors) Error ¶
func (pe ProjectErrors) Error() error
type ServiceRequirements ¶
type ServiceRequirements struct { topicspb.UnimplementedTopicsServer storagepb.UnimplementedStorageListenerServer websocketspb.UnimplementedWebsocketServer ApiServer apispb.ApiServer // contains filtered or unexported fields }
ServiceRequirements - Cloud resource requirements for a Nitric Application Service
Hosts all Nitric resource servers in a collection-only mode, where services can call into the servers to request resources they require for their operation.
func NewServiceRequirements ¶
func NewServiceRequirements(serviceName string, serviceFile string, serviceType string) *ServiceRequirements
func (*ServiceRequirements) Declare ¶
func (s *ServiceRequirements) Declare(ctx context.Context, req *resourcespb.ResourceDeclareRequest) (*resourcespb.ResourceDeclareResponse, error)
func (*ServiceRequirements) Error ¶
func (s *ServiceRequirements) Error() error
Error - Returns an error if any requirements have been registered incorrectly, such as duplicates
func (*ServiceRequirements) HandleEvents ¶
func (s *ServiceRequirements) HandleEvents(stream websocketspb.WebsocketHandler_HandleEventsServer) error
func (*ServiceRequirements) HasDatabases ¶ added in v1.42.0
func (s *ServiceRequirements) HasDatabases() bool
TODO: Remove when databases are no longer in preview
func (*ServiceRequirements) Listen ¶
func (s *ServiceRequirements) Listen(stream storagepb.StorageListener_ListenServer) error
func (*ServiceRequirements) Proxy ¶
func (s *ServiceRequirements) Proxy(stream httppb.Http_ProxyServer) error
func (*ServiceRequirements) Schedule ¶
func (s *ServiceRequirements) Schedule(stream schedulespb.Schedules_ScheduleServer) error
func (*ServiceRequirements) Serve ¶
func (s *ServiceRequirements) Serve(stream apispb.Api_ServeServer) error
func (*ServiceRequirements) Subscribe ¶
func (s *ServiceRequirements) Subscribe(stream topicspb.Subscriber_SubscribeServer) error
func (*ServiceRequirements) WorkerCount ¶
func (s *ServiceRequirements) WorkerCount() int
Click to show internal directories.
Click to hide internal directories.