lxc/incus
1
0
Fork 0
mirror of https://github.com/lxc/incus.git synced 2026-02-05 09:46:19 +01:00
Code Issues Releases Activity

shared/api: Remove LXD mentions

Browse Source 
Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
This commit is contained in:
Stéphane Graber
2023-08-29 22:24:19 -04:00
parent 7ae1f4603a
commit ef20f4cd6f
32 changed files with 139 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
shared/api/certificate.go
View File

@@ -18,7 +18,7 @@ const CertificateTypeMetrics = "metrics"
// CertificateTypeUnknown indicates an unknown certificate type.
const CertificateTypeUnknown = "unknown"
// CertificatesPost represents the fields of a new LXD certificate
// CertificatesPost represents the fields of a new certificate
//
// swagger:model
type CertificatesPost struct {
@@ -35,7 +35,7 @@ type CertificatesPost struct {
Token bool `json:"token" yaml:"token"`
}
// CertificatePut represents the modifiable fields of a LXD certificate
// CertificatePut represents the modifiable fields of a certificate
//
// swagger:model
//
@@ -68,7 +68,7 @@ type CertificatePut struct {
Certificate string `json:"certificate" yaml:"certificate"`
}
// Certificate represents a LXD certificate
// Certificate represents a certificate
//
// swagger:model
type Certificate struct {

23
shared/api/cluster.go
View File

@@ -6,14 +6,14 @@ import (
"time"
)
// Cluster represents high-level information about a LXD cluster.
// Cluster represents high-level information about a cluster.
//
// swagger:model
//
// API extension: clustering.
type Cluster struct {
// Name of the cluster member answering the request
// Example: lxd01
// Example: server01
ServerName string `json:"server_name" yaml:"server_name"`
// Whether clustering is enabled
@@ -59,8 +59,7 @@ type ClusterMemberConfigKey struct {
Description string `json:"description" yaml:"description"`
}
// ClusterPut represents the fields required to bootstrap or join a LXD
// cluster.
// ClusterPut represents the fields required to bootstrap or join a cluster.
//
// swagger:model
//
@@ -96,7 +95,7 @@ type ClusterPut struct {
// API extension: clustering_join_token.
type ClusterMembersPost struct {
// The name of the new cluster member
// Example: lxd02
// Example: server02
ServerName string `json:"server_name" yaml:"server_name"`
}
@@ -107,7 +106,7 @@ type ClusterMembersPost struct {
// API extension: clustering_join_token.
type ClusterMemberJoinToken struct {
// The name of the new cluster member
// Example: lxd02
// Example: server02
ServerName string `json:"server_name" yaml:"server_name"`
// The fingerprint of the network certificate
@@ -137,18 +136,18 @@ func (t *ClusterMemberJoinToken) String() string {
return base64.StdEncoding.EncodeToString(joinTokenJSON)
}
// ClusterMemberPost represents the fields required to rename a LXD node.
// ClusterMemberPost represents the fields required to rename a cluster member.
//
// swagger:model
//
// API extension: clustering.
type ClusterMemberPost struct {
// The new name of the cluster member
// Example: lxd02
// Example: server02
ServerName string `json:"server_name" yaml:"server_name"`
}
// ClusterMember represents the a LXD node in the cluster.
// ClusterMember represents a member of a cluster.
//
// swagger:model
//
@@ -157,7 +156,7 @@ type ClusterMember struct {
ClusterMemberPut `yaml:",inline"`
// Name of the cluster member
// Example: lxd01
// Example: server01
ServerName string `json:"server_name" yaml:"server_name"`
// URL at which the cluster member can be reached
@@ -188,7 +187,7 @@ func (member *ClusterMember) Writable() ClusterMemberPut {
return member.ClusterMemberPut
}
// ClusterMemberPut represents the modifiable fields of a LXD cluster member
// ClusterMemberPut represents the modifiable fields of a cluster member
//
// swagger:model
//
@@ -225,7 +224,7 @@ type ClusterMemberPut struct {
Groups []string `json:"groups" yaml:"groups"`
}
// ClusterCertificatePut represents the certificate and key pair for all members in a LXD Cluster
// ClusterCertificatePut represents the certificate and key pair for all cluster members
//
// swagger:model
//

4
shared/api/doc.go
View File

@@ -1,4 +1,4 @@
// Package api contains Go structs for all LXD API objects
// Package api contains Go structs for all API objects
//
// # Overview
//
@@ -9,5 +9,5 @@
//
// A few convenience functions are also tied to those structs which let
// you convert between the various strucs for a given object and also query
// some of the more complex metadata that LXD can export.
// some of the more complex metadata available.
package api

4
shared/api/event.go
View File

@@ -6,7 +6,7 @@ import (
"time"
)
// LXD event types.
// Event types.
const (
EventTypeLifecycle = "lifecycle"
EventTypeLogging = "logging"
@@ -30,7 +30,7 @@ type Event struct {
Metadata json.RawMessage `yaml:"metadata" json:"metadata"`
// Originating cluster member
// Example: lxd01
// Example: server01
//
// API extension: event_location
Location string `yaml:"location,omitempty" json:"location,omitempty"`

28
shared/api/image.go
View File

@@ -4,7 +4,7 @@ import (
"time"
)
// ImageExportPost represents the fields required to export a LXD image
// ImageExportPost represents the fields required to export an image
//
// swagger:model
//
@@ -38,14 +38,14 @@ type ImageExportPost struct {
Profiles []string `json:"profiles" yaml:"profiles"`
}
// ImagesPost represents the fields available for a new LXD image
// ImagesPost represents the fields available for a new image
//
// swagger:model
type ImagesPost struct {
ImagePut `yaml:",inline"`
// Original filename of the image
// Example: lxd.tar.xz
// Example: image.tar.xz
Filename string `json:"filename" yaml:"filename"`
// Source of the image
@@ -64,7 +64,7 @@ type ImagesPost struct {
Aliases []ImageAlias `json:"aliases" yaml:"aliases"`
}
// ImagesPostSource represents the source of a new LXD image
// ImagesPostSource represents the source of a new image
//
// swagger:model
type ImagesPostSource struct {
@@ -101,7 +101,7 @@ type ImagesPostSource struct {
Project string `json:"project" yaml:"project"`
}
// ImagePut represents the modifiable fields of a LXD image
// ImagePut represents the modifiable fields of an image
//
// swagger:model
type ImagePut struct {
@@ -130,7 +130,7 @@ type ImagePut struct {
Profiles []string `json:"profiles" yaml:"profiles"`
}
// Image represents a LXD image
// Image represents an image
//
// swagger:model
type Image struct {
@@ -176,7 +176,7 @@ type Image struct {
// Example: 2021-03-22T20:39:00.575185384-04:00
LastUsedAt time.Time `json:"last_used_at" yaml:"last_used_at"`
// When the image was added to this LXD server
// When the image was added to this server
// Example: 2021-03-24T14:18:15.115036787-04:00
UploadedAt time.Time `json:"uploaded_at" yaml:"uploaded_at"`
}
@@ -191,7 +191,7 @@ func (img *Image) URL(apiVersion string, project string) *URL {
return NewURL().Path(apiVersion, "images", img.Fingerprint).Project(project)
}
// ImageAlias represents an alias from the alias list of a LXD image
// ImageAlias represents an alias from the alias list of an image
//
// swagger:model
type ImageAlias struct {
@@ -204,7 +204,7 @@ type ImageAlias struct {
Description string `json:"description" yaml:"description"`
}
// ImageSource represents the source of a LXD image
// ImageSource represents the source of an image
//
// swagger:model
type ImageSource struct {
@@ -231,14 +231,14 @@ type ImageSource struct {
ImageType string `json:"image_type" yaml:"image_type"`
}
// ImageAliasesPost represents a new LXD image alias
// ImageAliasesPost represents a new image alias
//
// swagger:model
type ImageAliasesPost struct {
ImageAliasesEntry `yaml:",inline"`
}
// ImageAliasesEntryPost represents the required fields to rename a LXD image alias
// ImageAliasesEntryPost represents the required fields to rename an image alias
//
// swagger:model
type ImageAliasesEntryPost struct {
@@ -247,7 +247,7 @@ type ImageAliasesEntryPost struct {
Name string `json:"name" yaml:"name"`
}
// ImageAliasesEntryPut represents the modifiable fields of a LXD image alias
// ImageAliasesEntryPut represents the modifiable fields of an image alias
//
// swagger:model
type ImageAliasesEntryPut struct {
@@ -260,7 +260,7 @@ type ImageAliasesEntryPut struct {
Target string `json:"target" yaml:"target"`
}
// ImageAliasesEntry represents a LXD image alias
// ImageAliasesEntry represents an image alias
//
// swagger:model
type ImageAliasesEntry struct {
@@ -277,7 +277,7 @@ type ImageAliasesEntry struct {
Type string `json:"type" yaml:"type"`
}
// ImageMetadata represents LXD image metadata (used in image tarball)
// ImageMetadata represents image metadata (used in image tarball)
//
// swagger:model
type ImageMetadata struct {

16
shared/api/init.go
View File

@@ -1,6 +1,6 @@
package api
// InitPreseed represents initialization configuration that can be supplied to `lxd init`.
// InitPreseed represents initialization configuration that can be supplied to `init`.
//
// swagger:model
//
@@ -10,7 +10,7 @@ type InitPreseed struct {
Cluster *InitClusterPreseed `json:"cluster" yaml:"cluster"`
}
// InitLocalPreseed represents initialization configuration for the local LXD.
// InitLocalPreseed represents initialization configuration.
//
// swagger:model
//
@@ -18,24 +18,24 @@ type InitPreseed struct {
type InitLocalPreseed struct {
ServerPut `yaml:",inline"`
// Networks by project to add to LXD
// Networks by project to add
// Example: Network on the "default" project
Networks []InitNetworksProjectPost `json:"networks" yaml:"networks"`
// Storage Pools to add to LXD
// Storage Pools to add
// Example: local dir storage pool
StoragePools []StoragePoolsPost `json:"storage_pools" yaml:"storage_pools"`
// Profiles to add to LXD
// Profiles to add
// Example: "default" profile with a root disk device
Profiles []ProfilesPost `json:"profiles" yaml:"profiles"`
// Projects to add to LXD
// Projects to add
// Example: "default" project
Projects []ProjectsPost `json:"projects" yaml:"projects"`
}
// InitNetworksProjectPost represents the fields of a new LXD network along with its associated project.
// InitNetworksProjectPost represents the fields of a new network along with its associated project.
//
// swagger:model
//
@@ -48,7 +48,7 @@ type InitNetworksProjectPost struct {
Project string
}
// InitClusterPreseed represents initialization configuration for the LXD cluster.
// InitClusterPreseed represents initialization configuration for the cluster.
//
// swagger:model
//

10
shared/api/instance.go
View File

@@ -27,7 +27,7 @@ const InstanceTypeContainer = InstanceType("container")
// InstanceTypeVM defines the instance type value for a virtual-machine.
const InstanceTypeVM = InstanceType("virtual-machine")
// InstancesPost represents the fields available for a new LXD instance.
// InstancesPost represents the fields available for a new instance.
//
// swagger:model
//
@@ -61,7 +61,7 @@ type InstancesPut struct {
State *InstanceStatePut `json:"state" yaml:"state"`
}
// InstancePost represents the fields required to rename/move a LXD instance.
// InstancePost represents the fields required to rename/move an instance.
//
// swagger:model
//
@@ -124,7 +124,7 @@ type InstancePostTarget struct {
Websockets map[string]string `json:"secrets,omitempty" yaml:"secrets,omitempty"`
}
// InstancePut represents the modifiable fields of a LXD instance.
// InstancePut represents the modifiable fields of an instance.
//
// swagger:model
//
@@ -173,7 +173,7 @@ type InstanceRebuildPost struct {
Source InstanceSource `json:"source" yaml:"source"`
}
// Instance represents a LXD instance.
// Instance represents an instance.
//
// swagger:model
//
@@ -210,7 +210,7 @@ type Instance struct {
LastUsedAt time.Time `json:"last_used_at" yaml:"last_used_at"`
// What cluster member this instance is located on
// Example: lxd01
// Example: server01
Location string `json:"location" yaml:"location"`
// The type of instance (container or virtual-machine)

4
shared/api/instance_backup.go
View File

@@ -4,7 +4,7 @@ import (
"time"
)
// InstanceBackupsPost represents the fields available for a new LXD instance backup.
// InstanceBackupsPost represents the fields available for a new instance backup.
//
// swagger:model
//
@@ -33,7 +33,7 @@ type InstanceBackupsPost struct {
CompressionAlgorithm string `json:"compression_algorithm" yaml:"compression_algorithm"`
}
// InstanceBackup represents a LXD instance backup.
// InstanceBackup represents an instance backup.
//
// swagger:model
//

2
shared/api/instance_console.go
View File

@@ -8,7 +8,7 @@ type InstanceConsoleControl struct {
Args map[string]string `json:"args" yaml:"args"`
}
// InstanceConsolePost represents a LXD instance console request.
// InstanceConsolePost represents an instance console request.
//
// swagger:model
//

2
shared/api/instance_exec.go
View File

@@ -9,7 +9,7 @@ type InstanceExecControl struct {
Signal int `json:"signal" yaml:"signal"`
}
// InstanceExecPost represents a LXD instance exec request.
// InstanceExecPost represents an instance exec request.
//
// swagger:model
//

8
shared/api/instance_snapshot.go
View File

@@ -4,7 +4,7 @@ import (
"time"
)
// InstanceSnapshotsPost represents the fields available for a new LXD instance snapshot.
// InstanceSnapshotsPost represents the fields available for a new instance snapshot.
//
// swagger:model
//
@@ -25,7 +25,7 @@ type InstanceSnapshotsPost struct {
ExpiresAt *time.Time `json:"expires_at" yaml:"expires_at"`
}
// InstanceSnapshotPost represents the fields required to rename/move a LXD instance snapshot.
// InstanceSnapshotPost represents the fields required to rename/move an instance snapshot.
//
// swagger:model
//
@@ -47,7 +47,7 @@ type InstanceSnapshotPost struct {
Live bool `json:"live,omitempty" yaml:"live,omitempty"`
}
// InstanceSnapshotPut represents the modifiable fields of a LXD instance snapshot.
// InstanceSnapshotPut represents the modifiable fields of an instance snapshot.
//
// swagger:model
//
@@ -58,7 +58,7 @@ type InstanceSnapshotPut struct {
ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"`
}
// InstanceSnapshot represents a LXD instance snapshot.
// InstanceSnapshot represents an instance snapshot.
//
// swagger:model
//

16
shared/api/instance_state.go
View File

@@ -1,6 +1,6 @@
package api
// InstanceStatePut represents the modifiable fields of a LXD instance's state.
// InstanceStatePut represents the modifiable fields of an instance's state.
//
// swagger:model
//
@@ -23,7 +23,7 @@ type InstanceStatePut struct {
Stateful bool `json:"stateful" yaml:"stateful"`
}
// InstanceState represents a LXD instance's state.
// InstanceState represents an instance's state.
//
// swagger:model
//
@@ -58,7 +58,7 @@ type InstanceState struct {
CPU InstanceStateCPU `json:"cpu" yaml:"cpu"`
}
// InstanceStateDisk represents the disk information section of a LXD instance's state.
// InstanceStateDisk represents the disk information section of an instance's state.
//
// swagger:model
//
@@ -75,7 +75,7 @@ type InstanceStateDisk struct {
Total int64 `json:"total" yaml:"total"`
}
// InstanceStateCPU represents the cpu information section of a LXD instance's state.
// InstanceStateCPU represents the cpu information section of an instance's state.
//
// swagger:model
//
@@ -86,7 +86,7 @@ type InstanceStateCPU struct {
Usage int64 `json:"usage" yaml:"usage"`
}
// InstanceStateMemory represents the memory information section of a LXD instance's state.
// InstanceStateMemory represents the memory information section of an instance's state.
//
// swagger:model
//
@@ -115,7 +115,7 @@ type InstanceStateMemory struct {
SwapUsagePeak int64 `json:"swap_usage_peak" yaml:"swap_usage_peak"`
}
// InstanceStateNetwork represents the network information section of a LXD instance's state.
// InstanceStateNetwork represents the network information section of an instance's state.
//
// swagger:model
//
@@ -148,7 +148,7 @@ type InstanceStateNetwork struct {
Type string `json:"type" yaml:"type"`
}
// InstanceStateNetworkAddress represents a network address as part of the network section of a LXD
// InstanceStateNetworkAddress represents a network address as part of the network section of an
// instance's state.
//
// swagger:model
@@ -172,7 +172,7 @@ type InstanceStateNetworkAddress struct {
Scope string `json:"scope" yaml:"scope"`
}
// InstanceStateNetworkCounters represents packet counters as part of the network section of a LXD
// InstanceStateNetworkCounters represents packet counters as part of the network section of an
// instance's state.
//
// swagger:model

22
shared/api/network.go
View File

@@ -1,6 +1,6 @@
package api
// NetworksPost represents the fields of a new LXD network
// NetworksPost represents the fields of a new network
//
// swagger:model
//
@@ -9,7 +9,7 @@ type NetworksPost struct {
NetworkPut `yaml:",inline"`
// The name of the new network
// Example: lxdbr1
// Example: mybr1
Name string `json:"name" yaml:"name"`
// The network type (refer to doc/networks.md)
@@ -17,18 +17,18 @@ type NetworksPost struct {
Type string `json:"type" yaml:"type"`
}
// NetworkPost represents the fields required to rename a LXD network
// NetworkPost represents the fields required to rename a network
//
// swagger:model
//
// API extension: network.
type NetworkPost struct {
// The new name for the network
// Example: lxdbr1
// Example: mybr1
Name string `json:"name" yaml:"name"`
}
// NetworkPut represents the modifiable fields of a LXD network
// NetworkPut represents the modifiable fields of a network
//
// swagger:model
//
@@ -39,7 +39,7 @@ type NetworkPut struct {
Config map[string]string `json:"config" yaml:"config"`
// Description of the profile
// Example: My new LXD bridge
// Example: My new bridge
//
// API extension: entity_description
Description string `json:"description" yaml:"description"`
@@ -60,7 +60,7 @@ const NetworkStatusUnknown = "Unknown"
// NetworkStatusUnavailable network failed to initialize.
const NetworkStatusUnavailable = "Unavailable"
// Network represents a LXD network
// Network represents a network
//
// swagger:model
type Network struct {
@@ -68,7 +68,7 @@ type Network struct {
// The network name
// Read only: true
// Example: lxdbr0
// Example: mybr0
Name string `json:"name" yaml:"name"`
// The network type
@@ -81,7 +81,7 @@ type Network struct {
// Example: ["/1.0/profiles/default", "/1.0/instances/c1"]
UsedBy []string `json:"used_by" yaml:"used_by"`
// Whether this is a LXD managed network
// Whether this is a managed network
// Read only: true
// Example: true
//
@@ -97,7 +97,7 @@ type Network struct {
// Cluster members on which the network has been defined
// Read only: true
// Example: ["lxd01", "lxd02", "lxd03"]
// Example: ["server01", "server02", "server03"]
//
// API extension: clustering
Locations []string `json:"locations" yaml:"locations"`
@@ -131,7 +131,7 @@ type NetworkLease struct {
Type string `json:"type" yaml:"type"`
// What cluster member this record was found on
// Example: lxd01
// Example: server01
//
// API extension: network_leases_location
Location string `json:"location" yaml:"location"`

2
shared/api/network_acl.go
View File

@@ -137,7 +137,7 @@ type NetworkACL struct {
// List of URLs of objects using this profile
// Read only: true
// Example: ["/1.0/instances/c1", "/1.0/instances/v1", "/1.0/networks/lxdbr0"]
// Example: ["/1.0/instances/c1", "/1.0/instances/v1", "/1.0/networks/mybr0"]
UsedBy []string `json:"used_by" yaml:"used_by"` // Resources that use the ACL.
}

2
shared/api/network_addresses.go
View File

@@ -14,7 +14,7 @@ type NetworkAllocations struct {
UsedBy string `json:"used_by" yaml:"used_by"`
// Type of the entity consuming the network address
Type string `json:"type" yaml:"type"`
// Whether the entity comes from a network that LXD performs egress source NAT on
// Whether the entity comes from a network that performs egress source NAT
NAT bool `json:"nat" yaml:"nat"`
// Hwaddr is the MAC address of the entity consuming the network address
Hwaddr string `json:"hwaddr" yaml:"hwaddr"`

6
shared/api/network_forward.go
View File

@@ -60,7 +60,7 @@ func (p *NetworkForwardPort) Normalise() {
p.TargetPort = strings.Join(subjects, ",")
}
// NetworkForwardsPost represents the fields of a new LXD network address forward
// NetworkForwardsPost represents the fields of a new network address forward
//
// swagger:model
//
@@ -83,7 +83,7 @@ func (f *NetworkForwardsPost) Normalise() {
f.NetworkForwardPut.Normalise()
}
// NetworkForwardPut represents the modifiable fields of a LXD network address forward
// NetworkForwardPut represents the modifiable fields of a network address forward
//
// swagger:model
//
@@ -128,7 +128,7 @@ type NetworkForward struct {
ListenAddress string `json:"listen_address" yaml:"listen_address"`
// What cluster member this record was found on
// Example: lxd01
// Example: server01
Location string `json:"location" yaml:"location"`
}

6
shared/api/network_load_balancer.go
View File

@@ -84,7 +84,7 @@ func (p *NetworkLoadBalancerPort) Normalise() {
p.ListenPort = strings.Join(subjects, ",")
}
// NetworkLoadBalancersPost represents the fields of a new LXD network load balancer
// NetworkLoadBalancersPost represents the fields of a new network load balancer
//
// swagger:model
//
@@ -97,7 +97,7 @@ type NetworkLoadBalancersPost struct {
ListenAddress string `json:"listen_address" yaml:"listen_address"`
}
// NetworkLoadBalancerPut represents the modifiable fields of a LXD network load balancer
// NetworkLoadBalancerPut represents the modifiable fields of a network load balancer
//
// swagger:model
//
@@ -144,7 +144,7 @@ type NetworkLoadBalancer struct {
ListenAddress string `json:"listen_address" yaml:"listen_address"`
// What cluster member this record was found on
// Example: lxd01
// Example: server01
Location string `json:"location" yaml:"location"`
}

6
shared/api/network_peer.go
View File

@@ -1,6 +1,6 @@
package api
// NetworkPeersPost represents the fields of a new LXD network peering
// NetworkPeersPost represents the fields of a new network peering
//
// swagger:model
//
@@ -21,7 +21,7 @@ type NetworkPeersPost struct {
TargetNetwork string `json:"target_network" yaml:"target_network"`
}
// NetworkPeerPut represents the modifiable fields of a LXD network peering
// NetworkPeerPut represents the modifiable fields of a network peering
//
// swagger:model
//
@@ -36,7 +36,7 @@ type NetworkPeerPut struct {
Config map[string]string `json:"config" yaml:"config"`
}
// NetworkPeer used for displaying a LXD network peering.
// NetworkPeer used for displaying a network peering.
//
// swagger:model
//

8
shared/api/network_zone.go
View File

@@ -1,6 +1,6 @@
package api
// NetworkZonesPost represents the fields of a new LXD network zone
// NetworkZonesPost represents the fields of a new network zone
//
// swagger:model
//
@@ -13,7 +13,7 @@ type NetworkZonesPost struct {
Name string `json:"name" yaml:"name"`
}
// NetworkZonePut represents the modifiable fields of a LXD network zone
// NetworkZonePut represents the modifiable fields of a network zone
//
// swagger:model
//
@@ -51,7 +51,7 @@ func (f *NetworkZone) Writable() NetworkZonePut {
return f.NetworkZonePut
}
// NetworkZoneRecordsPost represents the fields of a new LXD network zone record
// NetworkZoneRecordsPost represents the fields of a new network zone record
//
// swagger:model
//
@@ -64,7 +64,7 @@ type NetworkZoneRecordsPost struct {
Name string `json:"name" yaml:"name"`
}
// NetworkZoneRecordPut represents the modifiable fields of a LXD network zone record
// NetworkZoneRecordPut represents the modifiable fields of a network zone record
//
// swagger:model
//

4
shared/api/operation.go
View File

@@ -14,7 +14,7 @@ const OperationClassWebsocket = "websocket"
// OperationClassToken represents the Token OperationClass.
const OperationClassToken = "token"
// Operation represents a LXD background operation
// Operation represents a background operation
//
// swagger:model
type Operation struct {
@@ -63,7 +63,7 @@ type Operation struct {
Err string `json:"err" yaml:"err"`
// What cluster member this record was found on
// Example: lxd01
// Example: server01
//
// API extension: operation_location
Location string `json:"location" yaml:"location"`

10
shared/api/profile.go
View File

@@ -1,6 +1,6 @@
package api
// ProfilesPost represents the fields of a new LXD profile
// ProfilesPost represents the fields of a new profile
//
// swagger:model
type ProfilesPost struct {
@@ -11,7 +11,7 @@ type ProfilesPost struct {
Name string `json:"name" yaml:"name" db:"primary=yes"`
}
// ProfilePost represents the fields required to rename a LXD profile
// ProfilePost represents the fields required to rename a profile
//
// swagger:model
type ProfilePost struct {
@@ -20,7 +20,7 @@ type ProfilePost struct {
Name string `json:"name" yaml:"name"`
}
// ProfilePut represents the modifiable fields of a LXD profile
// ProfilePut represents the modifiable fields of a profile
//
// swagger:model
type ProfilePut struct {
@@ -33,11 +33,11 @@ type ProfilePut struct {
Description string `json:"description" yaml:"description"`
// List of devices
// Example: {"root": {"type": "disk", "pool": "default", "path": "/"}, "eth0": {"type": "nic", "network": "lxdbr0", "name": "eth0"}}
// Example: {"root": {"type": "disk", "pool": "default", "path": "/"}, "eth0": {"type": "nic", "network": "mybr0", "name": "eth0"}}
Devices map[string]map[string]string `json:"devices" yaml:"devices"`
}
// Profile represents a LXD profile
// Profile represents a profile
//
// swagger:model
type Profile struct {

14
shared/api/project.go
View File

@@ -1,6 +1,6 @@
package api
// ProjectsPost represents the fields of a new LXD project
// ProjectsPost represents the fields of a new project
//
// swagger:model
//
@@ -13,7 +13,7 @@ type ProjectsPost struct {
Name string `json:"name" yaml:"name"`
}
// ProjectPost represents the fields required to rename a LXD project
// ProjectPost represents the fields required to rename a project
//
// swagger:model
//
@@ -24,7 +24,7 @@ type ProjectPost struct {
Name string `json:"name" yaml:"name"`
}
// ProjectPut represents the modifiable fields of a LXD project
// ProjectPut represents the modifiable fields of a project
//
// swagger:model
//
@@ -39,7 +39,7 @@ type ProjectPut struct {
Description string `json:"description" yaml:"description"`
}
// Project represents a LXD project
// Project represents a project
//
// swagger:model
//
@@ -54,7 +54,7 @@ type Project struct {
// List of URLs of objects using this project
// Read only: true
// Example: ["/1.0/images/0e60015346f06627f10580d56ac7fffd9ea775f6d4f25987217d5eed94910a20", "/1.0/instances/c1", "/1.0/networks/lxdbr0", "/1.0/profiles/default", "/1.0/storage-pools/default/volumes/custom/blah"]
// Example: ["/1.0/images/0e60015346f06627f10580d56ac7fffd9ea775f6d4f25987217d5eed94910a20", "/1.0/instances/c1", "/1.0/networks/mybr0", "/1.0/profiles/default", "/1.0/storage-pools/default/volumes/custom/blah"]
UsedBy []string `json:"used_by" yaml:"used_by"`
}
@@ -70,7 +70,7 @@ func (project *Project) URL(apiVersion string) *URL {
return NewURL().Path(apiVersion, "projects", project.Name)
}
// ProjectState represents the current running state of a LXD project
// ProjectState represents the current running state of a project
//
// swagger:model
//
@@ -82,7 +82,7 @@ type ProjectState struct {
Resources map[string]ProjectStateResource `json:"resources" yaml:"resources"`
}
// ProjectStateResource represents the state of a particular resource in a LXD project
// ProjectStateResource represents the state of a particular resource in a project
//
// swagger:model
//

2
shared/api/resource.go
View File

@@ -1,6 +1,6 @@
package api
// Resources represents the system resources available for LXD
// Resources represents the system hardware resources
//
// swagger:model
//

8
shared/api/response.go
View File

@@ -4,7 +4,7 @@ import (
"encoding/json"
)
// ResponseRaw represents a LXD operation in its original form.
// ResponseRaw represents an operation in its original form.
type ResponseRaw struct {
Type ResponseType `json:"type" yaml:"type"`
@@ -22,7 +22,7 @@ type ResponseRaw struct {
Metadata any `json:"metadata" yaml:"metadata"`
}
// Response represents a LXD operation.
// Response represents an operation.
type Response struct {
Type ResponseType `json:"type" yaml:"type"`
@@ -79,10 +79,10 @@ func (r *Response) MetadataAsStruct(target any) error {
return json.Unmarshal(r.Metadata, &target)
}
// ResponseType represents a valid LXD response type.
// ResponseType represents a valid response type.
type ResponseType string
// LXD response types.
// Response types.
const (
SyncResponse ResponseType = "sync"
AsyncResponse ResponseType = "async"

16
shared/api/server.go
View File

@@ -1,6 +1,6 @@
package api
// ServerEnvironment represents the read-only environment fields of a LXD server.
// ServerEnvironment represents the read-only environment fields of a server configuration.
type ServerEnvironment struct {
// List of addresses the server is listening on
// Example: [":8443"]
@@ -75,7 +75,7 @@ type ServerEnvironment struct {
Project string `json:"project" yaml:"project"`
// Server implementation name
// Example: lxd
// Example: incus
Server string `json:"server" yaml:"server"`
// Whether the server is part of a cluster
@@ -97,7 +97,7 @@ type ServerEnvironment struct {
// API extension: clustering
ServerName string `json:"server_name" yaml:"server_name"`
// PID of the LXD process
// PID of the daemon
// Example: 1453969
ServerPid int `json:"server_pid" yaml:"server_pid"`
@@ -142,7 +142,7 @@ type ServerStorageDriverInfo struct {
Remote bool
}
// ServerPut represents the modifiable fields of a LXD server configuration
// ServerPut represents the modifiable fields of a server configuration
//
// swagger:model
type ServerPut struct {
@@ -151,7 +151,7 @@ type ServerPut struct {
Config map[string]any `json:"config" yaml:"config"`
}
// ServerUntrusted represents a LXD server for an untrusted client
// ServerUntrusted represents a server configuration for an untrusted client
//
// swagger:model
type ServerUntrusted struct {
@@ -188,21 +188,21 @@ type ServerUntrusted struct {
AuthMethods []string `json:"auth_methods" yaml:"auth_methods"`
}
// Server represents a LXD server
// Server represents a server configuration
//
// swagger:model
type Server struct {
ServerPut `yaml:",inline"`
ServerUntrusted `yaml:",inline"`
// The current user username as seen by LXD
// The current API user identifier
// Read only: true
// Example: uid=201105
//
// API extension: auth_user
AuthUserName string `json:"auth_user_name" yaml:"auth_user_name"`
// The current user login method as seen by LXD
// The current API user login method
// Read only: true
// Example: unix
//

4
shared/api/status_code.go
View File

@@ -1,9 +1,9 @@
package api
// StatusCode represents a valid LXD operation and container status.
// StatusCode represents a valid operation and container status.
type StatusCode int
// LXD status codes.
// Status codes.
const (
OperationCreated StatusCode = 100
Started StatusCode = 101

8
shared/api/storage_pool.go
View File

@@ -15,7 +15,7 @@ const StoragePoolStatusUnknown = "Unknown"
// StoragePoolStatusUnvailable storage pool failed to initialize.
const StoragePoolStatusUnvailable = "Unavailable"
// StoragePoolsPost represents the fields of a new LXD storage pool
// StoragePoolsPost represents the fields of a new storage pool
//
// swagger:model
//
@@ -32,7 +32,7 @@ type StoragePoolsPost struct {
Driver string `json:"driver" yaml:"driver"`
}
// StoragePool represents the fields of a LXD storage pool.
// StoragePool represents the fields of a storage pool.
//
// swagger:model
//
@@ -61,13 +61,13 @@ type StoragePool struct {
// Cluster members on which the storage pool has been defined
// Read only: true
// Example: ["lxd01", "lxd02", "lxd03"]
// Example: ["server01", "server02", "server03"]
//
// API extension: clustering
Locations []string `json:"locations" yaml:"locations"`
}
// StoragePoolPut represents the modifiable fields of a LXD storage pool.
// StoragePoolPut represents the modifiable fields of a storage pool.
//
// swagger:model
//

14
shared/api/storage_pool_bucket.go
View File

@@ -1,6 +1,6 @@
package api
// StorageBucketsPost represents the fields of a new LXD storage pool bucket
// StorageBucketsPost represents the fields of a new storage pool bucket
//
// swagger:model
//
@@ -15,7 +15,7 @@ type StorageBucketsPost struct {
Name string `json:"name" yaml:"name"`
}
// StorageBucketPut represents the modifiable fields of a LXD storage pool bucket
// StorageBucketPut represents the modifiable fields of a storage pool bucket
//
// swagger:model
//
@@ -34,7 +34,7 @@ type StorageBucketPut struct {
Description string `json:"description" yaml:"description"`
}
// StorageBucket represents the fields of a LXD storage pool bucket
// StorageBucket represents the fields of a storage pool bucket
//
// swagger:model
//
@@ -55,7 +55,7 @@ type StorageBucket struct {
S3URL string `json:"s3_url" yaml:"s3_url"`
// What cluster member this record was found on
// Example: lxd01
// Example: server01
//
// API extension: storage_buckets
Location string `json:"location" yaml:"location"`
@@ -76,7 +76,7 @@ func (b *StorageBucket) URL(apiVersion string, poolName string, projectName stri
return NewURL().Path(apiVersion, "storage-pools", poolName, "buckets", b.Name).Project(projectName).Target(b.Location)
}
// StorageBucketKeysPost represents the fields of a new LXD storage pool bucket key
// StorageBucketKeysPost represents the fields of a new storage pool bucket key
//
// swagger:model
//
@@ -91,7 +91,7 @@ type StorageBucketKeysPost struct {
Name string `json:"name" yaml:"name"`
}
// StorageBucketKeyPut represents the modifiable fields of a LXD storage pool bucket key
// StorageBucketKeyPut represents the modifiable fields of a storage pool bucket key
//
// swagger:model
//
@@ -122,7 +122,7 @@ type StorageBucketKeyPut struct {
SecretKey string `json:"secret-key" yaml:"secret-key"`
}
// StorageBucketKey represents the fields of a LXD storage pool bucket key
// StorageBucketKey represents the fields of a storage pool bucket key
//
// swagger:model
//

10
shared/api/storage_pool_volume.go
View File

@@ -4,7 +4,7 @@ import (
"time"
)
// StorageVolumesPost represents the fields of a new LXD storage pool volume
// StorageVolumesPost represents the fields of a new storage pool volume
//
// swagger:model
//
@@ -32,7 +32,7 @@ type StorageVolumesPost struct {
ContentType string `json:"content_type" yaml:"content_type"`
}
// StorageVolumePost represents the fields required to rename a LXD storage pool volume
// StorageVolumePost represents the fields required to rename a storage pool volume
//
// swagger:model
//
@@ -91,7 +91,7 @@ type StorageVolumePostTarget struct {
Websockets map[string]string `json:"secrets,omitempty" yaml:"secrets,omitempty"`
}
// StorageVolume represents the fields of a LXD storage volume.
// StorageVolume represents the fields of a storage volume.
//
// swagger:model
//
@@ -112,7 +112,7 @@ type StorageVolume struct {
UsedBy []string `json:"used_by" yaml:"used_by"`
// What cluster member this record was found on
// Example: lxd01
// Example: server01
//
// API extension: clustering
Location string `json:"location" yaml:"location"`
@@ -149,7 +149,7 @@ func (v *StorageVolume) URL(apiVersion string, poolName string) *URL {
return u.Project(v.Project).Target(v.Location)
}
// StorageVolumePut represents the modifiable fields of a LXD storage volume
// StorageVolumePut represents the modifiable fields of a storage volume
//
// swagger:model
//

4
shared/api/storage_pool_volume_backup.go
View File

@@ -4,7 +4,7 @@ import (
"time"
)
// StoragePoolVolumeBackup represents a LXD volume backup
// StoragePoolVolumeBackup represents a volume backup
//
// swagger:model
//
@@ -31,7 +31,7 @@ type StoragePoolVolumeBackup struct {
OptimizedStorage bool `json:"optimized_storage" yaml:"optimized_storage"`
}
// StoragePoolVolumeBackupsPost represents the fields available for a new LXD volume backup
// StoragePoolVolumeBackupsPost represents the fields available for a new volume backup
//
// swagger:model
//

8
shared/api/storage_pool_volume_snapshot.go
View File

@@ -4,7 +4,7 @@ import (
"time"
)
// StorageVolumeSnapshotsPost represents the fields available for a new LXD storage volume snapshot
// StorageVolumeSnapshotsPost represents the fields available for a new storage volume snapshot
//
// swagger:model
//
@@ -21,7 +21,7 @@ type StorageVolumeSnapshotsPost struct {
ExpiresAt *time.Time `json:"expires_at" yaml:"expires_at"`
}
// StorageVolumeSnapshotPost represents the fields required to rename/move a LXD storage volume snapshot
// StorageVolumeSnapshotPost represents the fields required to rename/move a storage volume snapshot
//
// swagger:model
//
@@ -32,7 +32,7 @@ type StorageVolumeSnapshotPost struct {
Name string `json:"name" yaml:"name"`
}
// StorageVolumeSnapshot represents a LXD storage volume snapshot
// StorageVolumeSnapshot represents a storage volume snapshot
//
// swagger:model
//
@@ -60,7 +60,7 @@ type StorageVolumeSnapshot struct {
CreatedAt time.Time `json:"created_at" yaml:"created_at"`
}
// StorageVolumeSnapshotPut represents the modifiable fields of a LXD storage volume
// StorageVolumeSnapshotPut represents the modifiable fields of a storage volume
//
// swagger:model
//

2
shared/api/url.go
View File

@@ -5,7 +5,7 @@ import (
"strings"
)
// URL represents an endpoint for the LXD API.
// URL represents an endpoint for the REST API.
type URL struct {
url.URL
}