Documentation
¶
Index ¶
- Constants
- type Address
- type BackendAddress
- type Configuration
- type ConfigurationMap
- type DaemonConfigurationResponse
- type Endpoint
- type EndpointAddressing
- type EndpointChangeRequest
- type EndpointPolicy
- type EndpointState
- type EndpointStatusChange
- type Error
- type FrontendAddress
- type IPAM
- type IPAMStatus
- type Identity
- type IdentityContext
- type L4Policy
- type LabelConfiguration
- type LabelConfigurationModifier
- type Labels
- type NodeAddressing
- type NodeAddressingElement
- type PolicyTraceResult
- type PolicyTree
- type Service
- type ServiceFlags
- type Status
- type StatusResponse
Constants ¶
View Source
const ( // EndpointStatusChangeCodeOk captures enum value "ok" EndpointStatusChangeCodeOk string = "ok" // EndpointStatusChangeCodeFailed captures enum value "failed" EndpointStatusChangeCodeFailed string = "failed" )
View Source
const ( // FrontendAddressProtocolTCP captures enum value "tcp" FrontendAddressProtocolTCP string = "tcp" // FrontendAddressProtocolUDP captures enum value "udp" FrontendAddressProtocolUDP string = "udp" // FrontendAddressProtocolAny captures enum value "any" FrontendAddressProtocolAny string = "any" )
View Source
const ( // StatusStateOk captures enum value "Ok" StatusStateOk string = "Ok" // StatusStateWarning captures enum value "Warning" StatusStateWarning string = "Warning" // StatusStateFailure captures enum value "Failure" StatusStateFailure string = "Failure" // StatusStateDisabled captures enum value "Disabled" StatusStateDisabled string = "Disabled" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BackendAddress ¶
type BackendAddress struct {
// Layer 3 address
// Required: true
IP *string `json:"ip"`
// Layer 4 port number
Port uint16 `json:"port,omitempty"`
// Weight for Round Robin
Weight uint16 `json:"weight,omitempty"`
}
BackendAddress Service backend address swagger:model BackendAddress
type Configuration ¶
type Configuration struct {
// Immutable configuration (read-only)
Immutable ConfigurationMap `json:"immutable,omitempty"`
// Changeable configuration
Mutable ConfigurationMap `json:"mutable,omitempty"`
}
Configuration General purpose structure to hold configuration of the daemon and endpoints. Split into a mutable and immutable section.
swagger:model Configuration
type ConfigurationMap ¶
ConfigurationMap Map of configuration key/value pairs.
swagger:model ConfigurationMap
type DaemonConfigurationResponse ¶
type DaemonConfigurationResponse struct {
// addressing
Addressing *NodeAddressing `json:"addressing,omitempty"`
// configuration
Configuration *Configuration `json:"configuration,omitempty"`
}
DaemonConfigurationResponse Response to a daemon configuration request. Contains the addressing information and configuration settings.
swagger:model DaemonConfigurationResponse
type Endpoint ¶
type Endpoint struct {
// addressing
Addressing *EndpointAddressing `json:"addressing,omitempty"`
// ID assigned by container runtime
ContainerID string `json:"container-id,omitempty"`
// Docker endpoint ID
DockerEndpointID string `json:"docker-endpoint-id,omitempty"`
// Docker network ID
DockerNetworkID string `json:"docker-network-id,omitempty"`
// MAC address
HostMac string `json:"host-mac,omitempty"`
// Local endpoint ID
ID int64 `json:"id,omitempty"`
// Security identity
Identity *Identity `json:"identity,omitempty"`
// Index of network device
InterfaceIndex int64 `json:"interface-index,omitempty"`
// Name of network device
InterfaceName string `json:"interface-name,omitempty"`
// MAC address
Mac string `json:"mac,omitempty"`
// Policy information of endpoint
Policy *EndpointPolicy `json:"policy,omitempty"`
// Current state of endpoint
// Required: true
State EndpointState `json:"state"`
// Current state of endpoint
Status []*EndpointStatusChange `json:"status"`
}
Endpoint Endpoint swagger:model Endpoint
type EndpointAddressing ¶
type EndpointAddressing struct {
// IPv4 address
IPV4 string `json:"ipv4,omitempty"`
// IPv6 address
IPV6 string `json:"ipv6,omitempty"`
}
EndpointAddressing Addressing information of an endpoint swagger:model EndpointAddressing
type EndpointChangeRequest ¶
type EndpointChangeRequest struct {
// addressing
Addressing *EndpointAddressing `json:"addressing,omitempty"`
// ID assigned by container runtime
ContainerID string `json:"container-id,omitempty"`
// Docker endpoint ID
DockerEndpointID string `json:"docker-endpoint-id,omitempty"`
// Docker network ID
DockerNetworkID string `json:"docker-network-id,omitempty"`
// MAC address
HostMac string `json:"host-mac,omitempty"`
// Local endpoint ID
ID int64 `json:"id,omitempty"`
// Index of network device
InterfaceIndex int64 `json:"interface-index,omitempty"`
// Name of network device
InterfaceName string `json:"interface-name,omitempty"`
// MAC address
Mac string `json:"mac,omitempty"`
// Current state of endpoint
// Required: true
State EndpointState `json:"state"`
}
EndpointChangeRequest Structure which contains the mutable elements of an Endpoint.
swagger:model EndpointChangeRequest
type EndpointPolicy ¶
type EndpointPolicy struct {
// List of identities allowed to communicate to this endpoint
//
AllowedConsumers []int64 `json:"allowed-consumers"`
// Build number of calculated policy in use
Build int64 `json:"build,omitempty"`
// Own identity of endpoint
ID int64 `json:"id,omitempty"`
// l4
L4 *L4Policy `json:"l4,omitempty"`
}
EndpointPolicy Policy information of an endpoint swagger:model EndpointPolicy
type EndpointState ¶
type EndpointState string
EndpointState State of endpoint swagger:model EndpointState
const ( // EndpointStateCreating captures enum value "creating" EndpointStateCreating EndpointState = "creating" // EndpointStateDisconnected captures enum value "disconnected" EndpointStateDisconnected EndpointState = "disconnected" // EndpointStateWaitingForIdentity captures enum value "waiting-for-identity" EndpointStateWaitingForIdentity EndpointState = "waiting-for-identity" // EndpointStateNotReady captures enum value "not-ready" EndpointStateNotReady EndpointState = "not-ready" // EndpointStateReady captures enum value "ready" EndpointStateReady EndpointState = "ready" )
type EndpointStatusChange ¶
type EndpointStatusChange struct {
// Code indicate type of status change
Code string `json:"code,omitempty"`
// Status message
Message string `json:"message,omitempty"`
// Timestamp when status change occurred
Timestamp string `json:"timestamp,omitempty"`
}
EndpointStatusChange Indication of a change of status swagger:model EndpointStatusChange
type FrontendAddress ¶
type FrontendAddress struct {
// Layer 3 address
IP string `json:"ip,omitempty"`
// Layer 4 port number
Port uint16 `json:"port,omitempty"`
// Layer 4 protocol
Protocol string `json:"protocol,omitempty"`
}
FrontendAddress Layer 4 address swagger:model FrontendAddress
type IPAM ¶
type IPAM struct {
// endpoint
// Required: true
Endpoint *EndpointAddressing `json:"endpoint"`
// host addressing
// Required: true
HostAddressing *NodeAddressing `json:"host-addressing"`
}
IPAM IPAM configuration of an endpoint swagger:model IPAM
type IPAMStatus ¶
IPAMStatus Status of IP address management swagger:model IPAMStatus
type Identity ¶
type Identity struct {
// Unique identifier
ID int64 `json:"id,omitempty"`
// Labels describing the identity
Labels Labels `json:"labels"`
}
Identity Security identity swagger:model Identity
type IdentityContext ¶
IdentityContext Context describing a pair of source and destination identity swagger:model IdentityContext
type L4Policy ¶
type L4Policy struct {
// List of L4 egress rules
Egress []string `json:"egress"`
// List of L4 ingress rules
Ingress []string `json:"ingress"`
}
L4Policy L4 endpoint policy swagger:model L4Policy
type LabelConfiguration ¶
type LabelConfiguration struct {
// Custom labels in addition to orchestration system labels.
Custom Labels `json:"custom"`
// Labels derived from orchestration system which have been disabled.
Disabled Labels `json:"disabled"`
// Labels derived from orchestration system
OrchestrationSystem Labels `json:"orchestration-system"`
}
LabelConfiguration Label configuration of an endpoint swagger:model LabelConfiguration
type LabelConfigurationModifier ¶
type LabelConfigurationModifier struct {
// List of labels to add and enable. If the label is an orchestration
// system label which has been disabled before, it will be removed from
// the disabled list and readded to the orchestration list. Otherwise
// it will be added to the custom label list.
//
Add Labels `json:"add"`
// List of labels to delete. If the label is an orchestration system
// label, then it will be deleted from the orchestration list and
// added to the disabled list. Otherwise it will be removed from the
// custom list.
//
Delete Labels `json:"delete"`
}
LabelConfigurationModifier Structure describing label mutations to be performed on a LabelConfiguration object.
swagger:model LabelConfigurationModifier
type NodeAddressing ¶
type NodeAddressing struct {
// ipv4
IPV4 *NodeAddressingElement `json:"ipv4,omitempty"`
// ipv6
IPV6 *NodeAddressingElement `json:"ipv6,omitempty"`
}
NodeAddressing Addressing information of a node for all address families swagger:model NodeAddressing
type NodeAddressingElement ¶
type NodeAddressingElement struct {
// Address pool to be used for local endpoints
AllocRange string `json:"alloc-range,omitempty"`
// True if address family is enabled
Enabled bool `json:"enabled,omitempty"`
// IP address of node
IP string `json:"ip,omitempty"`
}
NodeAddressingElement Addressing information swagger:model NodeAddressingElement
type PolicyTraceResult ¶
type PolicyTraceResult struct {
// log
Log string `json:"log,omitempty"`
// verdict
Verdict string `json:"verdict,omitempty"`
}
PolicyTraceResult Response to a policy resolution process swagger:model PolicyTraceResult
type Service ¶
type Service struct {
// List of backend addresses
BackendAddresses []*BackendAddress `json:"backend-addresses"`
// flags
Flags *ServiceFlags `json:"flags,omitempty"`
// Frontend address
// Required: true
FrontendAddress *FrontendAddress `json:"frontend-address"`
// Unique identification
ID int64 `json:"id,omitempty"`
}
Service Collection of endpoints to be served swagger:model Service
type ServiceFlags ¶
type ServiceFlags struct {
// Frontend to backend translation activated
ActiveFrontend bool `json:"active-frontend,omitempty"`
// Perform direct server return
DirectServerReturn bool `json:"direct-server-return,omitempty"`
}
ServiceFlags Optional service configuration flags swagger:model ServiceFlags
type Status ¶
type Status struct {
// Human readable status/error/warning message
Msg string `json:"msg,omitempty"`
// State the component is in
State string `json:"state,omitempty"`
}
Status Status of an individual component swagger:model Status
type StatusResponse ¶
type StatusResponse struct {
// Status of Cilium daemon
Cilium *Status `json:"cilium,omitempty"`
// Status of local container runtime
ContainerRuntime *Status `json:"container-runtime,omitempty"`
// Status of IP address management
IPAM *IPAMStatus `json:"ipam,omitempty"`
// Status of Kubernetes integration
Kubernetes *Status `json:"kubernetes,omitempty"`
// Status of key/value datastore
Kvstore *Status `json:"kvstore,omitempty"`
}
StatusResponse Health and status information of daemon swagger:model StatusResponse
Source Files
¶
- address.go
- backend_address.go
- configuration.go
- configuration_map.go
- daemon_configuration_response.go
- endpoint.go
- endpoint_addressing.go
- endpoint_change_request.go
- endpoint_policy.go
- endpoint_state.go
- endpoint_status_change.go
- error.go
- frontend_address.go
- identity.go
- identity_context.go
- ip_a_m.go
- ip_a_m_status.go
- l4_policy.go
- label_configuration.go
- label_configuration_modifier.go
- labels.go
- node_addressing.go
- node_addressing_element.go
- policy_trace_result.go
- policy_tree.go
- service.go
- status.go
- status_response.go
Click to show internal directories.
Click to hide internal directories.