package
0.0.0-20180108144400-194264adc583
Repository: https://github.com/ciao-project/ciao.git
Documentation: pkg.go.dev

# Constants

All used to indicate all persistent scenario, in this case it indicates to act in all instances.
AlreadyRunning is returned when an attempt is made to start an instance on a node upon which that very same instance is already running.
AttachVolumeAlreadyAttached indicates that the volume is already attached to the instance.
AttachVolumeAttachFailure indicates that the attempt to attach a volume to an instance failed.
AttachVolumeInstanceFailure indicates that the volume could not be attached as the instance has failed to start and is being deleted.
AttachVolumeInvalidData is returned by ciao-launcher if the contents of the AttachVolume payload are incorrect, e.g., the instance_uuid is missing.
AttachVolumeInvalidPayload indicates that the payload of the SSNTP AttachVolume command was corrupt and could not be unmarshalled.
AttachVolumeNoInstance indicates that a volume could not be attached to an instance as the instance does not exist on the node to which the AttachVolume command was sent.
AttachVolumeNotSupported indicates that the attach volume command is not supported for the given workload type, e.g., a container.
AttachVolumeStateFailure indicates that launcher was unable to update its internal state to register the new volume.
ComputeNode indicates that a resource struct specifies whether the command in which it is embedded applies to a compute node.
ComputeStatusPending is a filter that used to select pending instances in requests to the controller.
ComputeStatusRunning is a filter that used to select running instances in requests to the controller.
ComputeStatusStopped is a filter that used to select exited instances in requests to the controller.
Deleted indicates that an instance has been successfully deleted.
DeleteInvalidData is returned by ciao-launcher if the contents of the DELETE payload are incorrect, e.g., the instance_uuid is missing.
DeleteInvalidPayload indicates that the payload of the SSNTP DELETE command was corrupt and could not be unmarshalled.
DeleteNoInstance indicates that an instance could not be deleted as it does not exist on the node to which the DELETE command was sent.
Docker specifies that an instance is to be launched inside a Docker container.
EFI indicates that EFI firmware, e.g., OVMF.fd, should be used to boot a VM.
Exited indicates that an instance has been successfully created but is not currently running, either because it failed to start or was explicitly stopped by a STOP command or perhaps by a CN reboot.
ExitFailed is not currently used.
ExitPaused is not currently used.
ExternalIP is used to indicate the the requested resource is an externally accessible IP address.
Filesystem defines the local filesystem backend storage type for the configuration data.
FullCloud is returned by the scheduler when all nodes in the cluster are FULL and it is unable to satisfy a START request.
FullComputeNode indicates that the node to which the START command was sent had insufficient resources to start the requested instance.
Host used to indicate in a Host persistent scenario, in this case it indicates to act in only in the instances of a host.
Hung indicates that an instance is not responding to commands.
Image is used to indicate that the requested resource is an image.
ImageFailure indicates that ciao-launcher is unable to locate the rootfs for the instance, e.g., a VM instance is started with no bootable volumes or a containers image cannot be downloaded.
Instance is used to indicate that this requested resource is an instance.
InstanceExists is returned when an attempt is made to start an instance on a node upon which that very same instance already exists but is not currently running.
InvalidData indicates that the start section of the payload is corrupt or missing information.
InvalidPayload indicates that the contents of the START payload are corrupt.
LaunchFailure indicates that the instance has been successfully created but could not be launched.
Legacy indicates that legacy firmware, e.g., BIOS should be used to boot a VM.
MemMB indicates that a resource struct specifies a quantity of memory in MBs.
Missing indicates that the node this instance is running on is not active.
NetworkFailure indicates that it was not possible to initialise networking for the instance.
NetworkNode indicates that a resource struct specifies whether the command in which it is embedded applies to a network node.
NoComputeNodes is returned by the scheduler if no compute nodes are running in the cluster upon which the instance can be started.
NodeInMaintenance indicates that the node to which the START command was sent cannot host the instance as it is currently in maintenance mode.
NoNetworkNodes is returned by the scheduler if no network nodes are running in the cluster upon which the instance can be started.
Pending indicates that ciao-launcher has not yet ascertained the state of a given instance.
PublicIPAssignFailure constant is used to denote when Public IP assignment operation failed.
PublicIPInvalidData constant is used to denote when command section of YAML payload is corrupt or missing required information.
PublicIPInvalidPayload constant is used to denote when YAML payload is corrupt.
PublicIPNoInstance indicates that a public IP assignment/release failed because the corresponding instance does not exist.
PublicIPReleaseFailure constant is used to denote when Public IP release operation failed.
QEMU specifies that an instance is to be booted on QEMU KVM VM.
Running indicates an instance is running.
SharedDiskGiB is used for shared storage across the cluster used for storing volume and images.
Stopping indicates that an instance has been issued a delete command, however, we are unalbe to ascertain whether the instance has been deleted yet.
VCPUs indicates that a particular resource struct contains a count of VCPUs.
VM used to indicate in a instance persistent scenario, in this case it indicates to act in only one instance.
Volume is used to indicate that the requested resource is a volume.

# Structs

AttachVolume represents the unmarshalled version of the contents of a SSNTP AttachVolume payload.
CNCINet contains information about CNCI network interfaces.
CNCIRefreshCommand contains information on where to send the updated concentrator instance list.
CommandAssignPublicIP is a wrapper around PublicIPCommand.
CommandCNCIRefresh represents the unmarshalled version of the contents of an SSNTP ssntp.ConcentratorInstanceRefresh command.
CommandReleasePublicIP is a wrapper around PublicIPCommand.
ConcentratorInstanceAddedEvent contains information about a newly added CNCI instance.
Configure represents the SSNTP CONFIGURE command payload.
ConfigureController contains the unmarshalled configurations for the controller service.
ConfigureLauncher contains the unmarshalled configurations for the launcher service.
ConfigurePayload is a wrapper to read and unmarshall all posible configurations for the following services: scheduler, controller, launcher, imaging and identity.
ConfigureScheduler contains the unmarshalled configurations for the scheduler service.
ConfigureStorage contains the unmarshalled configurations for the Ceph storage driver.
Delete represents the unmarshalled version of the contents of a SSNTP DELETE payload.
ErrorAttachVolumeFailure represents the unmarshalled version of the contents of a SSNTP ERROR frame whose type is set to ssntp.AttachVolumeFailure.
ErrorDeleteFailure represents the unmarshalled version of the contents of a SSNTP ERROR frame whose type is set to ssntp.DeleteFailure.
ErrorPublicIPFailure represents the PublicIPFailure SSNTP error payload.
ErrorStartFailure represents the unmarshalled version of the contents of a SSNTP ERROR frame whose type is set to ssntp.StartFailure.
Evacuate represents the SSNTP EVACUATE command payload.
EvacuateCmd contains the nodeID of a SSNTP Agent.
EventConcentratorInstanceAdded represents the unmarshalled version of the contents of an SSNTP ssntp.ConcentratorInstanceAdded event.
EventInstanceDeleted represents the unmarshalled version of the contents of an SSNTP ssntp.InstanceDeleted event.
EventInstanceStopped represents the unmarshalled version of the contents of an SSNTP ssntp.InstanceStopped event.
EventPublicIPAssigned represents the SSNTP PublicIPAssigned event payload.
EventPublicIPUnassigned represents the SSNTP PublicIPUnassigned event payload.
EventTenantAdded represents the unmarshalled version of the contents of an SSNTP ssntp.TenantAdded event payload.
EventTenantRemoved represents the unmarshalled version of the contents of an SSNTP ssntp.TenantRemoved event payload.
FrameTrace captures trace information for an SSNTP frame as it makes its way through a SSNTP cluster.
InstanceDeletedEvent contains the UUID of an instance that has just been deleted.
InstanceStat contains information about the state of an indiviual instance in a ciao cluster.
InstanceStoppedEvent contains the UUID of an instance that has just been deleted from a node for the purposes of migration.
NetworkResources contains all the networking information for an instance.
NetworkStat contains information about a single network interface present on a ciao compute or network node.
NodeConnected represents the unmarshalled version of the contents of an SSNTP ssntp.NodeConnected event payload.
NodeConnectedEvent contains information about a node that has either just connected or disconnected.
NodeDisconnected represents the unmarshalled version of the contents of an SSNTP ssntp.NodeDisconnected event payload.
PublicIPCommand contains information about a IP and its associated data.
PublicIPEvent contains the basic information of Public IP event.
Ready represents the unmarshalled version of the contents of an SSNTP READY payload.
RequestedResource is used to specify an individual resource contained within a Start or Restart command.
Restore represents the SSNTP Restore command payload.
RestoreCmd contains the nodeID of a SSNTP Agent.
SSNTPNode contains information about a node through which a SSNTP frame has passed.
Start represents the unmarshalled version of the contents of a SSNTP START payload.
StartCmd contains the information needed to start a new instance.
Stat represents a snapshot of the state of a compute or a network node.
Stop represents the unmarshalled version of the contents of a SSNTP STOP payload.
StopCmd contains the information needed to stop a running instance.
StorageResource represents a requested storage resource for a workload.
TenantAddedEvent is populated by ciao-launcher whenever it creates or removes a local tunnel for a tenant on a CN.
Trace represents the unmarshalled version of the contents of an SSNTP ssntp.TraceReport event.
VolumeCmd contains all the information needed to attach a volume to or detach a volume from an existing instance.
WorkloadRequirements contains the requirements to execute the workload.

# Type aliases

AttachVolumeFailureReason denotes the underlying error that prevented an SSNTP AttachVolume command from attaching a volume to an instance.
DeleteFailureReason denotes the underlying error that prevented an SSNTP DELETE command from deleting a running instance.
Firmware represents the type of firmware used to boot a VM.
Hypervisor indicates the type of hypervisor used to run a given instance.
Persistence represents the persistency of an instance, i.e., whether that instance should be restarted after certain events have occurred, e.g., the node on which the instance runs is rebooted.
PublicIPFailureReason represents the potential AssignPublicIP/ReleasePublicIP commands failure reasons.
Resource represents the name of a resource in a StartCmd structure.
StartFailureReason denotes the underlying error that prevented an SSNTP START command from launching a new instance on a CN or a NN.
StorageType is used to define the configuration backend storage type.