Documentation
¶
Overview ¶
Package agentgroup provides the agentgroup API for the server
Index ¶
Constants ¶
const (
// AgentGroupKind is the kind of the agent group resource.
AgentGroupKind = "AgentGroup"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgentConfig ¶ added in v0.1.22
type AgentConfig struct {
Value string `json:"value"`
ContentType string `json:"contentType"`
ConnectionSettings *v1agent.ConnectionSettings `json:"connectionSettings,omitempty"`
}
AgentConfig represents the remote configuration for agents in the group. @name AgentGroupAgentConfig.
type AgentGroup ¶
type AgentGroup struct {
Metadata Metadata `json:"metadata"`
Spec Spec `json:"spec"`
Status Status `json:"status"`
} // @name AgentGroup
AgentGroup represents a struct that represents an agent group.
type AgentSelector ¶
type AgentSelector struct {
IdentifyingAttributes map[string]string `json:"identifyingAttributes"`
NonIdentifyingAttributes map[string]string `json:"nonIdentifyingAttributes"`
}
AgentSelector defines the criteria for selecting agents to be included in the agent group. @name AgentGroupAgentSelector.
type Attributes ¶
Attributes represents a map of attributes for the agent group. @name AgentGroupAttributes.
type Condition ¶ added in v0.1.24
type Condition struct {
Type ConditionType `json:"type"`
LastTransitionTime time.Time `json:"lastTransitionTime"`
Status ConditionStatus `json:"status"`
Reason string `json:"reason"`
Message string `json:"message,omitempty"`
} // @name AgentGroupCondition
Condition represents a condition of an agent group.
type ConditionStatus ¶ added in v0.1.24
type ConditionStatus string // @name AgentGroupConditionStatus
ConditionStatus represents the status of a condition.
const ( // ConditionStatusTrue represents a true condition status. ConditionStatusTrue ConditionStatus = "True" // ConditionStatusFalse represents a false condition status. ConditionStatusFalse ConditionStatus = "False" )
type ConditionType ¶ added in v0.1.24
type ConditionType string // @name AgentGroupConditionType
ConditionType represents the type of a condition.
const ( // ConditionTypeCreated represents the condition when the agent group was created. ConditionTypeCreated ConditionType = "Created" // ConditionTypeDeleted represents the condition when the agent group was deleted. ConditionTypeDeleted ConditionType = "Deleted" )
type CreateRequest ¶ added in v0.1.20
type CreateRequest struct {
Name string `binding:"required" json:"name"`
Priority int `json:"priority"`
Attributes Attributes `json:"attributes"`
Selector AgentSelector `json:"selector"`
AgentConfig *AgentConfig `json:"agentConfig,omitempty"`
} // @name AgentGroupCreateRequest
CreateRequest represents a request to create an agent group.
type ListResponse ¶ added in v0.1.20
type ListResponse = v1.ListResponse[AgentGroup]
ListResponse represents a response for listing agent groups.
func NewListResponse ¶ added in v0.1.20
func NewListResponse(agentGroups []AgentGroup, metadata v1.ListMeta) *ListResponse
NewListResponse creates a new ListResponse with the given agent groups and metadata.
type Metadata ¶ added in v0.1.24
type Metadata struct {
Name string `json:"name"`
Priority int `json:"priority"`
Attributes Attributes `json:"attributes"`
Selector AgentSelector `json:"selector"`
} // @name AgentGroupMetadata
Metadata represents metadata information for an agent group.
type Spec ¶ added in v0.1.24
type Spec struct {
AgentConfig *AgentConfig `json:"agentConfig,omitempty"`
} // @name AgentGroupSpec
Spec represents the specification of an agent group.
type Status ¶ added in v0.1.24
type Status struct {
// NumAgents is the total number of agents in the agent group.
NumAgents int `json:"numAgents"`
// NumConnectedAgents is the number of connected agents in the agent group.
NumConnectedAgents int `json:"numConnectedAgents"`
// NumHealthyAgents is the number of healthy agents in the agent group.
NumHealthyAgents int `json:"numHealthyAgents"`
// NumUnhealthyAgents is the number of unhealthy agents in the agent group.
NumUnhealthyAgents int `json:"numUnhealthyAgents"`
// NumNotConnectedAgents is the number of not connected agents in the agent group.
NumNotConnectedAgents int `json:"numNotConnectedAgents"`
// Conditions is a list of conditions that apply to the agent group.
Conditions []Condition `json:"conditions"`
} // @name AgentGroupStatus
Status represents the status of an agent group.