open-nomad/nomad/structs/alloc.go

82 lines
2.4 KiB
Go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package structs
const (
// AllocServiceRegistrationsRPCMethod is the RPC method for listing all
// service registrations assigned to a specific allocation.
//
// Args: AllocServiceRegistrationsRequest
// Reply: AllocServiceRegistrationsResponse
AllocServiceRegistrationsRPCMethod = "Alloc.GetServiceRegistrations"
)
// AllocServiceRegistrationsRequest is the request object used to list all
// service registrations belonging to the specified Allocation.ID.
type AllocServiceRegistrationsRequest struct {
AllocID string
QueryOptions
}
// AllocServiceRegistrationsResponse is the response object when performing a
// listing of services belonging to an allocation.
type AllocServiceRegistrationsResponse struct {
Services []*ServiceRegistration
QueryMeta
}
// ServiceProviderNamespace returns the namespace within which the allocations
// services should be registered. This takes into account the different
// providers that can provide service registrations. In the event no services
// are found, the function will return the Consul namespace which allows hooks
// to work as they did before this feature.
//
// It currently assumes that all services within an allocation use the same
// provider and therefore the same namespace.
func (a *Allocation) ServiceProviderNamespace() string {
tg := a.Job.LookupTaskGroup(a.TaskGroup)
if len(tg.Services) > 0 {
switch tg.Services[0].Provider {
case ServiceProviderNomad:
return a.Job.Namespace
default:
return tg.Consul.GetNamespace()
}
}
for _, task := range tg.Tasks {
if len(task.Services) > 0 {
switch task.Services[0].Provider {
case ServiceProviderNomad:
return a.Job.Namespace
default:
return tg.Consul.GetNamespace()
}
}
}
return tg.Consul.GetNamespace()
}
type AllocInfo struct {
AllocID string
// Group in which the service belongs for a group-level service, or the
// group in which task belongs for a task-level service.
Group string
// Task in which the service belongs for task-level service. Will be empty
// for a group-level service.
Task string
// JobID provides additional context for providers regarding which job
// caused this registration.
JobID string
// NomadNamespace provides additional context for providers regarding which
// nomad namespace caused this registration.
Namespace string
}