diff --git a/doc/index.html b/doc/index.html index 8c1cf7ff..a44ec72b 100644 --- a/doc/index.html +++ b/doc/index.html @@ -895,147 +895,6 @@
ImageServiceCreateRequest is the request payload for creating an image.
+ChildPrefixLength.
| image | -metalstack.api.v2.Image | -- | Image is the image to create. |
+ ipv4 | +uint32 | +optional | +IPv4 bit length of this network in this addressfamily. |
ImageServiceCreateResponse is the response payload for creating an image.
- - -| Field | Type | Label | Description | ||||
| image | -metalstack.api.v2.Image | -- | Image contains the created image. |
+ ipv6 | +uint32 | +optional | +IPv6 bit length of this network in this addressfamily. |
| id | string | - | ID of the image to delete. |
+ Id of this network. |
-
-
ImageServiceDeleteResponse is the response payload for deleting an image.
- - -| Field | Type | Label | Description | |||
| image | -metalstack.api.v2.Image | +meta | +Meta | - | Image contains the deleted image. |
+ Meta for this network. |
ImageServiceUpdateRequest is the request payload for updating an image.
- - -| Field | Type | Label | Description | ||||
| id | +name | string | -- | Id of this image. |
+ optional | +Name of this network. |
|
| update_meta | -metalstack.api.v2.UpdateMeta | -- | UpdateMeta contains the timestamp and strategy to be used in this update request. |
+ description | +string | +optional | +Description of this network. |
| url | +partition | string | optional | -URL where this image is located. |
+ Partition where this network will be created. |
||
| name | +project | string | optional | -Name of this image. |
+ Project where this network belongs to. |
||
| description | +namespace | string | optional | -Description of this image. |
+ Namespace if specified, this network is namespaced and can therefore overlap with others. +Will be equal with project most of the time. |
||
| features | -metalstack.api.v2.ImageFeature | +prefixes | +string | repeated | -Features of this image. |
+ Prefixes in this network. |
|
| classification | -metalstack.api.v2.ImageClassification | +destination_prefixes | +string | +repeated | +Destination Prefixes in this network. |
+ ||
| default_child_prefix_length | +ChildPrefixLength | - | Classification of this image. |
+ Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request. |
|||
| expires_at | -google.protobuf.Timestamp | +min_child_prefix_length | +ChildPrefixLength | - | ExpiresAt indicates that usage is not possible after this date. |
+ Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. |
|
| labels | -metalstack.api.v2.UpdateLabels | +type | +NetworkType | ++ | Type of the network. |
+ ||
| nat_type | +NATType | ++ | NATType of this network. |
+ ||||
| vrf | +uint32 | optional | -Labels to update on this image. |
+ VRF of this network has this VNI. |
ImageServiceUpdateResponse is the response payload for updating an image.
- - -| Field | Type | Label | Description | ||||
| parent_network | +string | +optional | +Parent Network points to the id of the parent network if any. |
+ ||||
| image | -metalstack.api.v2.Image | +additional_announcable_cidrs | +string | +repeated | +AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. |
+ ||
| consumption | +NetworkConsumption | - | Image contains the updated image. |
+ Consumption of IPs and prefixes in this network. |
| query | -metalstack.api.v2.ImageQuery | +ipv4 | +NetworkUsage | - | Query for which images the usage should be reported. |
+ IPv4 network usage. |
ImageServiceUsageResponse is the response payload for getting image usage.
- - -| Field | Type | Label | Description | ||||
| image_usage | -metalstack.api.v2.ImageUsage | -repeated | -Images contains usage information. |
+ ipv6 | +NetworkUsage | ++ | IPv6 network usage, this can be approximated for high numbers. |
| Method Name | Request Type | Response Type | Description |
| Create | -ImageServiceCreateRequest | -ImageServiceCreateResponse | -Creates a new image. |
-
| Update | -ImageServiceUpdateRequest | -ImageServiceUpdateResponse | -Updates an image. |
-
| Delete | -ImageServiceDeleteRequest | -ImageServiceDeleteResponse | -Deletes an image. |
-
| Usage | -ImageServiceUsageRequest | -ImageServiceUsageResponse | -Returns the usage of images. |
-
IP is an IP address which can be used as loadbalancer addresses.
+NetworkQuery defines which networks to query.
| uuid | +id | string | -- | Uuid of this ip. |
+ optional | +Id of the network to query. |
|
| meta | -Meta | -- | Meta for this ip. |
+ name | +string | +optional | +Name of this network. |
| ip | +description | string | -- | Ip is either ipv4 or ipv6 address. |
+ optional | +Description of this network. |
|
| name | +partition | string | -- | Name of this ip. |
+ optional | +Partition where this network will be created. |
|
| description | +project | string | -- | Description of this ip. |
+ optional | +Project where this network belongs to. |
|
| network | +namespace | string | -- | Network is the network this ip belongs to. |
+ optional | +Namespace where this network belongs to. |
|
| project | +prefixes | string | -- | Project where this ip address belongs to. |
+ repeated | +Prefixes in this network. |
|
| type | -IPType | -- | Type of this ip. |
+ destination_prefixes | +string | +repeated | +Destination Prefixes in this network. |
| namespace | -string | +vrf | +uint32 | optional | -Namespace if specified this ip is from a namespaced network and can therefore overlap with others. -Will be equal with project most of the time. |
-
IPQuery can be used to query a IP or a list of IP.
- - -| Field | Type | Label | Description | ||||
| ip | -string | -optional | -Ip the ip to list. |
- ||||
| network | -string | -optional | -Network from which the IPs are to list. |
- ||||
| project | -string | -optional | -Project of the ips to list. |
+ VRF of this network has this VNI. |
|||
| name | +parent_network | string | optional | -Name of this ip. |
+ Parent Network points to the id of the parent network if any. |
||
| uuid | -string | +address_family | +NetworkAddressFamily | optional | -UUID for which these IPs should be filtered. |
+ Addressfamily to query. |
|
| machine | -string | +type | +NetworkType | optional | -Machine for which these IPs should be filtered. |
+ Type of the network to query for. |
|
| parent_prefix_cidr | -string | +nat_type | +NATType | optional | -ParentPrefixCidr for which this ips should get filtered. |
+ NATType configured. |
|
| labels | Labels | optional | -Labels for which these IPs should be filtered. |
- ||||
| type | -IPType | -optional | -Static if set to true, this will be a Static ip. |
- ||||
| address_family | -IPAddressFamily | -optional | -Address family of the IPs to list, defaults to all address families. |
- ||||
| namespace | -string | -optional | -Namespace can be specified to get the ip of a namespace. |
+ Labels on this network. |
| network | -string | -- | Network from which the IP should be created. |
- ||||
| project | string | - | Project of the ip. |
+ Project where this network belongs to. |
|||
| name | string | optional | -Name of the ip. |
+ Name of this network. |
|||
| description | string | optional | -Description of the ip. |
+ Description of this network. |
|||
| ip | +partition | string | optional | -IP if given try to create this ip if still available. |
+ Partition where this network will be created. |
||
| machine | -string | -optional | -Machine for which this ip should get created. |
+ labels | +Labels | ++ | Labels on this network. |
| labels | -Labels | +parent_network | +string | optional | -Labels to put onto the ip. |
+ Parent Network points to the id of the parent network if any. |
|
| type | -IPType | +length | +ChildPrefixLength | optional | -Type of the IP, ether ephemeral (default), or static. |
+ Length per addressfamily. |
|
| address_family | -IPAddressFamily | +NetworkAddressFamily | optional | -Addressfamily of the IP to create, defaults to ipv4. |
+ AddressFamily to create, defaults to the same as the parent. |
| ip | -IP | +network | +Network | - | Ip the ip. |
+ Network is the created network. |
| ip | +id | string | - | IP of the ip to delete. |
+ ID of the network to get. |
||
| project | string | - | Project of the ip. |
+ Project of the network. |
| ip | -IP | +network | +Network | - | Ip the ip. |
+ Network is the deleted network. |
| ip | +id | string | - | IP of the ip to get. |
+ ID of the network to get. |
||
| project | string | - | Project of the ip. |
- ||||
| namespace | -string | -optional | -Namespace can be specified to get the ip of a namespace. |
+ Project of the network. |
| ip | -IP | +network | +Network | - | Ip the ip. |
+ Network which was requested to get. |
| project | string | - | Project of the ips to list. |
+ Project of the base networks to list. |
|||
| query | -IPQuery | +NetworkQuery | - | Query to list one or more IPs. |
+ Query which specifies which networks to return. |
| ips | -IP | +networks | +Network | repeated | -Ips the ips. |
+ Networks are the requested networks. |
| ip | -string | -- | Ip the ip address to update. |
- ||||
| update_meta | -UpdateMeta | -- | UpdateMeta contains the timestamp and strategy to be used in this update request. |
- ||||
| project | string | - | Project id of the ip. |
- ||||
| name | -string | -optional | -Name of this ip. |
- ||||
| description | -string | -optional | -Description of this ip. |
- ||||
| type | -IPType | -optional | -Type of this ip. |
+ Project of the networks to list. |
|||
| labels | -UpdateLabels | -optional | -Labels on this ip. |
+ query | +NetworkQuery | ++ | Query which specifies which networks to return. |
| ip | -IP | +networks | +Network | +repeated | +Networks are the requested networks. |
+
NetworkServiceUpdateRequest.
+ + +| Field | Type | Label | Description | ||||
| id | +string | - | Ip the ip. |
+ ID of the network to get. |
+ |||
| update_meta | +UpdateMeta | ++ | UpdateMeta contains the timestamp and strategy to be used in this update request. |
+ ||||
| project | +string | ++ | Project of the network. |
+ ||||
| name | +string | +optional | +Name of this network. |
+ ||||
| description | +string | +optional | +Description of this network. |
+ ||||
| labels | +UpdateLabels | +optional | +Labels on this network. |
| Field | Type | Label | Description |
| network | +Network | ++ | Network is the updated network. |
+
IPAddressFamily defines either IPv4 or IPv6 Addressfamily.
+NetworkUsage reports core metrics about available and used IPs or Prefixes in a Network.
+ + +| Field | Type | Label | Description |
| available_ips | +uint64 | ++ | the total available IPs. |
+
| used_ips | +uint64 | ++ | the total used IPs. |
+
| available_prefixes | +uint64 | ++ | the total available 2-bit prefixes. |
+
| used_prefixes | +uint64 | ++ | the total used Prefixes. |
+
NATType defines how and if outgoing traffic is translated.
| Name | Number | Description | ||
| IP_ADDRESS_FAMILY_UNSPECIFIED | +NAT_TYPE_UNSPECIFIED | 0 | -IP_ADDRESS_FAMILY_UNSPECIFIED is not specified. |
+ NAT_TYPE_UNSPECIFIED indicates a unspecified nat type. |
| IP_ADDRESS_FAMILY_V4 | +NAT_TYPE_NONE | 1 | -IP_ADDRESS_FAMILY_V4 defines a IPv4 address. |
+ NAT_TYPE_NONE indicates that no nat is configured. |
| IP_ADDRESS_FAMILY_V6 | +NAT_TYPE_IPV4_MASQUERADE | 2 | -IP_ADDRESS_FAMILY_V6 defines a IPv6 address. |
+ NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network. |
IPType specifies different IP address types.
+NetworkAddressFamily defines the address family of a network.
| Name | Number | Description | ||
| IP_TYPE_UNSPECIFIED | +NETWORK_ADDRESS_FAMILY_UNSPECIFIED | 0 | -IP_TYPE_UNSPECIFIED is not specified. |
+ NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified. |
| IP_TYPE_EPHEMERAL | +NETWORK_ADDRESS_FAMILY_V4 | 1 | -IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage. |
+ NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes. |
| IP_TYPE_STATIC | +NETWORK_ADDRESS_FAMILY_V6 | 2 | -IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly. |
+ NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes. |
+
| NETWORK_ADDRESS_FAMILY_DUAL_STACK | +3 | +NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes. |
IPService provides IP address management operations.
+NetworkType indicates the purpose of the network, it cannot be changed after creation.
| Method Name | Request Type | Response Type | Description | |||
| Name | Number | Description | ||||
| Get | -IPServiceGetRequest | -IPServiceGetResponse | -Returns the IP address with the specified IP. |
+ NETWORK_TYPE_UNSPECIFIED | +0 | +NETWORK_TYPE_UNSPECIFIED indicates a unknown network type. |
| Create | -IPServiceCreateRequest | -IPServiceCreateResponse | -Creates a new IP address. |
+ NETWORK_TYPE_EXTERNAL | +1 | +NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks. +In most cases this is the internet network or a network which offers connectivity to legacy datacenter networks. +If it is not project scoped everyone can allocate Ips in this network, otherwise only from the same project ip allocation is possible. |
| Update | -IPServiceUpdateRequest | -IPServiceUpdateResponse | -Updates an IP address. |
+ NETWORK_TYPE_UNDERLAY | +2 | +NETWORK_TYPE_UNDERLAY indicates a underlay network. +The underlay network connects all switches and the firewalls to build a EVPN dataplane. +It is not project scoped. Is part of the dataplane and reserved for administrative purposes. |
| List | -IPServiceListRequest | -IPServiceListResponse | -Returns the list of all IP addresses. |
+ NETWORK_TYPE_SUPER | +3 | +NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks. +If the vrf id is given, child networks will inherit this vrf. +If the vrf id is nil in this network, child vrf is taken from the pool. +If the partition is given, child networks inherit the partition. +If the partition is nil, child networks also do not have a partition (i.e. requires vrf is distributed across all partitions). +If the partition is given, only one super network in that partition can be created. +If the partition is nil, multiple super networks can exist. Then, for child network creation the network id must be specified (base networks can be queried by label selector). +For child creation destination prefixes will be inherited. +If this is project scoped, the child project must match, otherwise can be freely specified. |
| Delete | -IPServiceDeleteRequest | -IPServiceDeleteResponse | -Deletes an IP address. |
+ NETWORK_TYPE_SUPER_NAMESPACED | +4 | +NETWORK_TYPE_SUPER_NAMESPACED indicates a super network which is only used to create child networks. +All rules from NETWORK_TYPE_SUPER apply for them as well. +In addition, a network namespace will be created for every project. Child networks per project will have disjunct prefixes. +Prefix allocation will start again with the same base cidr for every project / namespace. +This will allow the creation of much more child networks from a given super network size. |
+
| NETWORK_TYPE_CHILD | +5 | +NETWORK_TYPE_CHILD indicates a child network of a project. +This is the only network type that can be created by a user. +Connectivity to external networks is not possible without going through an additional firewall in this network which creates connectivity to other networks. +Such a network will be created either from a super, or super namespaced. |
+ ||||
| NETWORK_TYPE_CHILD_SHARED | +6 | +NETWORK_TYPE_CHILD_SHARED indicates a child network of a project which allows the allocation of ips from different projects. +Connectivity to external networks is not possible, as for normal child networks. +These networks are usually used to provide connectivity to shared services which are created in child networks, e.g. storage. +With this approach the number of hops can be reduced to the bare minimum in order to increase availability and performance. +Only one child shared network per project is allowed. |
IPServiceListRequest is the request payload for listing IP addresses.
- - -| Field | Type | Label | Description |
| query | -metalstack.api.v2.IPQuery | -- | Query to search for IP addresses. |
-
IPServiceListResponse is the response payload for listing IP addresses.
- - -| Field | Type | Label | Description |
| ips | -metalstack.api.v2.IP | -repeated | -IPs contains the list of IP addresses. |
-
IPService provides IP address management operations.
+NetworkService provides network management operations for end users, for example with project scope.
| Method Name | Request Type | Response Type | Description | ||||
| Get | +NetworkServiceGetRequest | +NetworkServiceGetResponse | +Returns the network with the specified ID. |
+ ||||
| Create | +NetworkServiceCreateRequest | +NetworkServiceCreateResponse | +Creates a child network from a super network. |
+ ||||
| Update | +NetworkServiceUpdateRequest | +NetworkServiceUpdateResponse | +Updates a network. |
+ ||||
| List | -IPServiceListRequest | -IPServiceListResponse | -Returns the list of all IP addresses. |
+ NetworkServiceListRequest | +NetworkServiceListResponse | +Returns the list of all project networks. |
+ |
| ListBaseNetworks | +NetworkServiceListBaseNetworksRequest | +NetworkServiceListBaseNetworksResponse | +ListBaseNetworks returns all base networks that can be used for either child network or IP allocation. |
+ ||||
| Delete | +NetworkServiceDeleteRequest | +NetworkServiceDeleteResponse | +Deletes a network. |
| ipv4 | -uint32 | -optional | -IPv4 bit length of this network in this addressfamily. |
+ ip | +string | ++ | IP address of this dns server. |
NTPServer.
+ + +| Field | Type | Label | Description | ||||
| ipv6 | -uint32 | -optional | -IPv6 bit length of this network in this addressfamily. |
+ address | +string | ++ | Address either as ip or hostname. |
| id | string | - | Id of this network. |
+ ID of this partition. |
|||
| meta | Meta | - | Meta for this network. |
- ||||
| name | -string | -optional | -Name of this network. |
+ Meta for this partition. |
|||
| description | string | -optional | -Description of this network. |
- ||||
| partition | -string | -optional | -Partition where this network will be created. |
- ||||
| project | -string | -optional | -Project where this network belongs to. |
- ||||
| namespace | -string | -optional | -Namespace if specified, this network is namespaced and can therefore overlap with others. -Will be equal with project most of the time. |
- ||||
| prefixes | -string | -repeated | -Prefixes in this network. |
- ||||
| destination_prefixes | -string | -repeated | -Destination Prefixes in this network. |
- ||||
| default_child_prefix_length | -ChildPrefixLength | -- | Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request. |
- ||||
| min_child_prefix_length | -ChildPrefixLength | - | Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. |
- ||||
| type | -NetworkType | -- | Type of the network. |
+ Description of this partition. |
|||
| nat_type | -NATType | +boot_configuration | +PartitionBootConfiguration | - | NATType of this network. |
+ PartitionBootConfiguration defines how metal-hammer boots. |
|
| vrf | -uint32 | -optional | -VRF of this network has this VNI. |
+ dns_servers | +DNSServer | +repeated | +DNSServers for this partition. |
| parent_network | -string | -optional | -Parent Network points to the id of the parent network if any. |
+ ntp_servers | +NTPServer | +repeated | +NTPServers for this partition. |
| additional_announcable_cidrs | +mgmt_service_addresses | string | repeated | -AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. |
- |||
| consumption | -NetworkConsumption | -- | Consumption of IPs and prefixes in this network. |
+ ManagementServiceAddresses defines where the management is reachable. +should be in the form <ip|host>:<port>. |
| ipv4 | -NetworkUsage | +image_url | +string | - | IPv4 network usage. |
+ ImageURL the url to download the initrd for the boot image. |
|
| ipv6 | -NetworkUsage | +kernel_url | +string | - | IPv6 network usage, this can be approximated for high numbers. |
+ KernelURL the url to download the kernel for the boot image. |
+ |
| commandline | +string | ++ | Commandline the kernel command line for the boot image. |
| id | string | optional | -Id of the network to query. |
-
-
- ||||
| name | -string | -optional | -Name of this network. |
- ||||
| description | -string | -optional | -Description of this network. |
- ||||
| partition | -string | -optional | -Partition where this network will be created. |
- ||||
| project | -string | -optional | -Project where this network belongs to. |
- ||||
| namespace | -string | -optional | -Namespace where this network belongs to. |
- ||||
| prefixes | -string | -repeated | -Prefixes in this network. |
- ||||
| destination_prefixes | -string | -repeated | -Destination Prefixes in this network. |
- ||||
| vrf | -uint32 | -optional | -VRF of this network has this VNI. |
- ||||
| parent_network | -string | -optional | -Parent Network points to the id of the parent network if any. |
- ||||
| address_family | -NetworkAddressFamily | -optional | -Addressfamily to query. |
- ||||
| type | -NetworkType | -optional | -Type of the network to query for. |
- ||||
| nat_type | -NATType | -optional | -NATType configured. |
+ ID of the partition to get. |
|||
| labels | Labels | optional | -Labels on this network. |
+ Labels lists only partitions containing the given labels. |
| project | -string | -- | Project where this network belongs to. |
- ||||
| name | -string | -optional | -Name of this network. |
- ||||
| description | -string | -optional | -Description of this network. |
- ||||
| partition | +id | string | -optional | -Partition where this network will be created. |
- |||
| labels | -Labels | - | Labels on this network. |
- ||||
| parent_network | -string | -optional | -Parent Network points to the id of the parent network if any. |
- ||||
| length | -ChildPrefixLength | -optional | -Length per addressfamily. |
- ||||
| address_family | -NetworkAddressFamily | -optional | -AddressFamily to create, defaults to the same as the parent. |
+ ID of the partition to get. |
| network | -Network | +partition | +Partition | - | Network is the created network. |
+ Partition is the partition. |
| id | -string | -- | ID of the network to get. |
- ||||
| project | -string | +query | +PartitionQuery | - | Project of the network. |
+ Query for partitions. |
| network | -Network | -- | Network is the deleted network. |
+ partitions | +Partition | +repeated | +Partitions are the partitions. |
| Method Name | Request Type | Response Type | Description |
| Get | +PartitionServiceGetRequest | +PartitionServiceGetResponse | +Returns the partition with the specified ID. |
+
| List | +PartitionServiceListRequest | +PartitionServiceListResponse | +Returns the list of all partitions. |
+
Size.
| string | - | ID of the network to get. |
+ Id of this size. |
|||
| project | -string | +meta | +Meta | - | Project of the network. |
+ Meta for this size. |
NetworkServiceGetResponse.
- - -| Field | Type | Label | Description | ||||
| name | +string | +optional | +Name of this size. |
+ ||||
| network | -Network | -- | Network which was requested to get. |
+ description | +string | +optional | +Description of this size. |
+
| constraints | +SizeConstraint | +repeated | +Constraints which must match that a specific machine is considered of this size. |
| project | -string | +type | +SizeConstraintType | - | Project of the base networks to list. |
+ Type a machine matches to a size in order to make them easier to categorize. |
| query | -NetworkQuery | +min | +uint64 | - | Query which specifies which networks to return. |
+ Min the minimum value of the constraint. |
NetworkServiceListResponse.
- - -| Field | Type | Label | Description | ||||
| max | +uint64 | ++ | Max the maximum value of the constraint. |
+ ||||
| networks | -Network | -repeated | -Networks are the requested networks. |
+ identifier | +string | +optional | +Identifier glob pattern which matches to the given type, for example gpu pci id. |
| project | +id | string | -- | Project of the networks to list. |
+ optional | +ID of the size to get. |
|
| query | -NetworkQuery | -- | Query which specifies which networks to return. |
+ name | +string | +optional | +Name of the size to query. |
+
| description | +string | +optional | +Description of the size to query. |
+ ||||
| labels | +Labels | +optional | +Labels lists only sizes containing the given labels. |
| networks | -Network | -repeated | -Networks are the requested networks. |
+ id | +string | ++ | ID of the size to get. |
| id | -string | -- | ID of the network to get. |
- ||||
| update_meta | -UpdateMeta | -- | UpdateMeta contains the timestamp and strategy to be used in this update request. |
- ||||
| project | -string | +size | +Size | - | Project of the network. |
- ||
| name | -string | -optional | -Name of this network. |
- ||||
| description | -string | -optional | -Description of this network. |
- ||||
| labels | -UpdateLabels | -optional | -Labels on this network. |
+ Size the size. |
| network | -Network | +query | +SizeQuery | - | Network is the updated network. |
+ Query for sizes. |
| available_ips | -uint64 | -- | the total available IPs. |
- ||||
| used_ips | -uint64 | -- | the total used IPs. |
- ||||
| available_prefixes | -uint64 | -- | the total available 2-bit prefixes. |
- ||||
| used_prefixes | -uint64 | -- | the total used Prefixes. |
+ sizes | +Size | +repeated | +Sizes the sizes. |
| Name | Number | Description | ||
| NAT_TYPE_UNSPECIFIED | +SIZE_CONSTRAINT_TYPE_UNSPECIFIED | 0 | -NAT_TYPE_UNSPECIFIED indicates a unspecified nat type. |
+ SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified. |
| NAT_TYPE_NONE | +SIZE_CONSTRAINT_TYPE_CORES | 1 | -NAT_TYPE_NONE indicates that no nat is configured. |
+ SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property. |
| NAT_TYPE_IPV4_MASQUERADE | +SIZE_CONSTRAINT_TYPE_MEMORY | 2 | -NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network. |
+ SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property. |
+
| SIZE_CONSTRAINT_TYPE_STORAGE | +3 | +SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property. |
+ ||
| SIZE_CONSTRAINT_TYPE_GPU | +4 | +SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property. |
NetworkAddressFamily defines the address family of a network.
+ + + + +SizeService provides size management operations.
| Name | Number | Description |
| NETWORK_ADDRESS_FAMILY_UNSPECIFIED | -0 | -NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified. |
-
| NETWORK_ADDRESS_FAMILY_V4 | -1 | -NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes. |
-
| NETWORK_ADDRESS_FAMILY_V6 | -2 | -NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes. |
-
| NETWORK_ADDRESS_FAMILY_DUAL_STACK | -3 | -NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes. |
-
NetworkType indicates the purpose of the network, it cannot be changed after creation.
-| Name | Number | Description |
| NETWORK_TYPE_UNSPECIFIED | -0 | -NETWORK_TYPE_UNSPECIFIED indicates a unknown network type. |
-
| NETWORK_TYPE_EXTERNAL | -1 | -NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks. -In most cases this is the internet network or a network which offers connectivity to legacy datacenter networks. -If it is not project scoped everyone can allocate Ips in this network, otherwise only from the same project ip allocation is possible. |
-
| NETWORK_TYPE_UNDERLAY | -2 | -NETWORK_TYPE_UNDERLAY indicates a underlay network. -The underlay network connects all switches and the firewalls to build a EVPN dataplane. -It is not project scoped. Is part of the dataplane and reserved for administrative purposes. |
-
| NETWORK_TYPE_SUPER | -3 | -NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks. -If the vrf id is given, child networks will inherit this vrf. -If the vrf id is nil in this network, child vrf is taken from the pool. -If the partition is given, child networks inherit the partition. -If the partition is nil, child networks also do not have a partition (i.e. requires vrf is distributed across all partitions). -If the partition is given, only one super network in that partition can be created. -If the partition is nil, multiple super networks can exist. Then, for child network creation the network id must be specified (base networks can be queried by label selector). -For child creation destination prefixes will be inherited. -If this is project scoped, the child project must match, otherwise can be freely specified. |
-
| NETWORK_TYPE_SUPER_NAMESPACED | -4 | -NETWORK_TYPE_SUPER_NAMESPACED indicates a super network which is only used to create child networks. -All rules from NETWORK_TYPE_SUPER apply for them as well. -In addition, a network namespace will be created for every project. Child networks per project will have disjunct prefixes. -Prefix allocation will start again with the same base cidr for every project / namespace. -This will allow the creation of much more child networks from a given super network size. |
-
| NETWORK_TYPE_CHILD | -5 | -NETWORK_TYPE_CHILD indicates a child network of a project. -This is the only network type that can be created by a user. -Connectivity to external networks is not possible without going through an additional firewall in this network which creates connectivity to other networks. -Such a network will be created either from a super, or super namespaced. |
-
| NETWORK_TYPE_CHILD_SHARED | -6 | -NETWORK_TYPE_CHILD_SHARED indicates a child network of a project which allows the allocation of ips from different projects. -Connectivity to external networks is not possible, as for normal child networks. -These networks are usually used to provide connectivity to shared services which are created in child networks, e.g. storage. -With this approach the number of hops can be reduced to the bare minimum in order to increase availability and performance. -Only one child shared network per project is allowed. |
-
NetworkService provides network management operations for end users, for example with project scope.
-| Method Name | Request Type | Response Type | Description | ||||
| Method Name | Request Type | Response Type | Description | ||||
| Get | -NetworkServiceGetRequest | -NetworkServiceGetResponse | -Returns the network with the specified ID. |
- ||||
| Create | -NetworkServiceCreateRequest | -NetworkServiceCreateResponse | -Creates a child network from a super network. |
- ||||
| Update | -NetworkServiceUpdateRequest | -NetworkServiceUpdateResponse | -Updates a network. |
+ SizeServiceGetRequest | +SizeServiceGetResponse | +Returns the size with the specified ID. |
|
| List | -NetworkServiceListRequest | -NetworkServiceListResponse | -Returns the list of all project networks. |
- ||||
| ListBaseNetworks | -NetworkServiceListBaseNetworksRequest | -NetworkServiceListBaseNetworksResponse | -ListBaseNetworks returns all base networks that can be used for either child network or IP allocation. |
- ||||
| Delete | -NetworkServiceDeleteRequest | -NetworkServiceDeleteResponse | -Deletes a network. |
+ SizeServiceListRequest | +SizeServiceListResponse | +Returns the list of all sizes. |
| ip | -string | +protocol | +IPProtocol | - | IP address of this dns server. |
+ Protocol the protocol for the rule, defaults to tcp. |
NTPServer.
- - -| Field | Type | Label | Description | ||||
| ports | +uint32 | +repeated | +Ports the ports affected by this rule. |
+ ||||
| address | +to | +string | +repeated | +To the destination cidrs affected by this rule. |
+ |||
| comment | string | - | Address either as ip or hostname. |
+ Comment for this rule. |
| id | -string | +protocol | +IPProtocol | - | ID of this partition. |
+ Protocol the protocol for the rule, defaults to tcp. |
|
| meta | -Meta | -- | Meta for this partition. |
+ ports | +uint32 | +repeated | +Ports the ports affected by this rule. |
| description | +to | string | -- | Description of this partition. |
- |||
| boot_configuration | -PartitionBootConfiguration | -- | PartitionBootConfiguration defines how metal-hammer boots. |
- ||||
| dns_servers | -DNSServer | repeated | -DNSServers for this partition. |
+ To the destination cidrs affected by this rule. |
|||
| ntp_servers | -NTPServer | +from | +string | repeated | -NTPServers for this partition. |
+ From the source cidrs affected by this rule. |
|
| mgmt_service_addresses | +comment | string | -repeated | -ManagementServiceAddresses defines where the management is reachable. -should be in the form <ip|host>:<port>. |
+ + | Comment for this rule. |
| image_url | -string | -- | ImageURL the url to download the initrd for the boot image. |
- ||||
| kernel_url | -string | -- | KernelURL the url to download the kernel for the boot image. |
+ egress | +FirewallEgressRule | +repeated | +Egress list of egress rules to be deployed during firewall allocation. |
| commandline | -string | -- | Commandline the kernel command line for the boot image. |
+ ingress | +FirewallIngressRule | +repeated | +Ingress list of ingress rules to be deployed during firewall allocation. |
| id | -string | -optional | -ID of the partition to get. |
- ||||
| labels | -Labels | -optional | -Labels lists only partitions containing the given labels. |
+ firewall_rules | +FirewallRules | ++ | FirewallRules to be applied if this is a firewall. |
| id | +uuid | string | - | ID of the partition to get. |
+ UUID of this machine. |
PartitionServiceGetResponse is the response payload for a partition get request.
- - -| Field | Type | Label | Description | |
| meta | +Meta | ++ | Meta for this machine. |
+ |
| partition | Partition | - | Partition is the partition. |
+ Partition where this machine resides. |
PartitionServiceListRequest is the request payload for a partition list request.
- - -| Field | Type | Label | Description | |||
| rack | +string | ++ | Rack where this machine is located. |
+ |||
| query | -PartitionQuery | +room | +string | - | Query for partitions. |
+ Room where this machine is located. |
PartitionServiceListResponse is the response payload for a partition list request.
- - -| Field | Type | Label | Description | ||||
| size | +Size | ++ | Size of this machine. |
+ ||||
| partitions | -Partition | -repeated | -Partitions are the partitions. |
+ hardware | +MachineHardware | ++ | Hardware specs of this machine. |
+
| allocation | +MachineAllocation | ++ | Allocation details. |
+ ||||
| status | +MachineStatus | ++ | Status contains several status details related to this machine. |
+ ||||
| recent_provisioning_events | +MachineRecentProvisioningEvents | ++ | MachineRecentProvisioningEvents contains the recent provisioning events. |
| Method Name | Request Type | Response Type | Description |
| Get | -PartitionServiceGetRequest | -PartitionServiceGetResponse | -Returns the partition with the specified ID. |
-
| List | -PartitionServiceListRequest | -PartitionServiceListResponse | -Returns the list of all partitions. |
-
Size.
+MachineAllocation contains properties if this machine is allocated.
| id | +uuid | string | - | Id of this size. |
+ UUID of this machine allocation. |
||
| meta | Meta | - | Meta for this size. |
+ Meta for this machine allocation. |
|||
| name | string | -optional | -Name of this size. |
+ + | Name of this allocation. |
||
| description | string | -optional | -Description of this size. |
+ + | Description of this allocation. |
||
| constraints | -SizeConstraint | -repeated | -Constraints which must match that a specific machine is considered of this size. |
+ created_by | +string | ++ | Created By indicates who created this machine allocation. |
SizeConstraint defines the boundaries for certain type of machine property which must match to identify this machine as this size.
- - -| Field | Type | Label | Description | |||
| type | -SizeConstraintType | +project | +string | - | Type a machine matches to a size in order to make them easier to categorize. |
+ Project of the allocation. |
| min | -uint64 | +image | +Image | - | Min the minimum value of the constraint. |
+ Image to be used to install on this machine. |
| max | -uint64 | +filesystem_layout | +FilesystemLayout | - | Max the maximum value of the constraint. |
+ FilesystemLayout to create on the disks. |
| identifier | -string | -optional | -Identifier glob pattern which matches to the given type, for example gpu pci id. |
- networks | +MachineNetwork | +repeated | +Networks this machine should be attached to. +Order of ips of external networks will be preserved. |
+
+
+
| hostname | +string | ++ | Hostname of the allocated machine. |
+ |||
| ssh_public_keys | +string | +repeated | +SSHPublicKeys which should be installed on this machine. |
+ |||
| userdata | +string | ++ | Userdata contains instructions required to bootstrap the machine. +AWS limits the max userdata size to 16k, lets allow twice as much. |
+ |||
| allocation_type | +MachineAllocationType | ++ | AllocationType of this machine. |
+ |||
| firewall_rules | +FirewallRules | ++ | FirewallRules to be applied if this is a firewall. |
+ |||
| dns_servers | +DNSServer | +repeated | +DNSServers for this machine. |
+ |||
| ntp_servers | +NTPServer | +repeated | +NTPServers for this machine. |
+ |||
| vpn | +MachineVPN | ++ | VPN connection configuration. |
+ |||
| placement_labels | +Labels | ++ | PlacementLabels by default machines are spread across the racks inside a partition for every project. +if placement labels are provided, the machine candidate has an additional anti-affinity to other machines having the same labels. |
+
SizeQuery is used to search sizes.
+MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired.
| id | +network | +string | ++ | Network the id of the network that this machine will be placed in. |
+
| ips | +string | +repeated | +IPs to to attach to this machine additionally. +If none given, one ip address is acquired per network for the machine. +Order of ips is preserved on the loopback interface. |
+
MachineAllocationQuery allocation specific query parameters.
+ + +| Field | Type | Label | Description | ||||
| uuid | string | optional | -ID of the size to get. |
+ UUID of the allocation of the machine to get. |
|||
| name | string | optional | -Name of the size to query. |
+ Name of the machine to get. |
|||
| description | +project | string | optional | -Description of the size to query. |
+ Project of the machine to get. |
+ ||
| image | +string | +optional | +Image of the machine to get. |
+ ||||
| filesystem_layout | +string | +optional | +FilesystemLayout of the machine to get. |
+ ||||
| hostname | +string | +optional | +Hostname of the machine to get. |
+ ||||
| allocation_type | +MachineAllocationType | +optional | +AllocationType of this machine. |
||||
| labels | Labels | optional | -Labels lists only sizes containing the given labels. |
+ Labels for which this machine allocation should get filtered. |
+ |||
| vpn | +MachineVPN | +optional | +VPN query if this machine has a vpn configuration. |
| id | +address | string | - | ID of the size to get. |
+ Address of this ipmi device from outside in the form of <ip or hostname>:<port>. |
+ ||
| mac | +string | ++ | Mac address of the network interface of this ipmi device. |
+ ||||
| user | +string | ++ | User of this ipmi device. |
+ ||||
| password | +string | ++ | Password of this ipmi device. |
+ ||||
| interface | +string | ++ | Interface of this ipmi device. |
+ ||||
| version | +string | ++ | Version of this bmc device. |
+ ||||
| power_state | +string | ++ | PowerState of this machine. |
| uuid | +string | ++ | UUID of this machine. |
+ ||||
| partition | +string | ++ | Partition where this machine resides. |
+ ||||
| rack | +string | ++ | Rack where this machine is located. |
+ ||||
| room | +string | ++ | Room where this machine is located. |
+ ||||
| size | -Size | +string | - | Size the size. |
+ Size of this machine. |
+ ||
| bmc_report | +MachineBMCReport | ++ | BMCReport contains the bmc details. |
| query | -SizeQuery | -- | Query for sizes. |
+ address | +string | +optional | +Address of the ipmi system of this machine. |
SizeServiceListResponse is the response payload for a size list request.
- - -| Field | Type | Label | Description | ||||
| mac | +string | +optional | +Mac of the ipmi system of this machine. |
+ ||||
| sizes | -Size | -repeated | -Sizes the sizes. |
+ user | +string | +optional | +User of the ipmi system of this machine. |
+
| interface | +string | +optional | +Interface of the ipmi system of this machine. |
| Name | Number | Description |
| SIZE_CONSTRAINT_TYPE_UNSPECIFIED | -0 | -SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified. |
-
| SIZE_CONSTRAINT_TYPE_CORES | -1 | -SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property. |
-
| SIZE_CONSTRAINT_TYPE_MEMORY | -2 | -SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property. |
-
| SIZE_CONSTRAINT_TYPE_STORAGE | -3 | -SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property. |
-
| SIZE_CONSTRAINT_TYPE_GPU | -4 | -SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property. |
-
SizeService provides size management operations.
-| Method Name | Request Type | Response Type | Description |
| Get | -SizeServiceGetRequest | -SizeServiceGetResponse | -Returns the size with the specified ID. |
-
| List | -SizeServiceListRequest | -SizeServiceListResponse | -Returns the list of all sizes. |
-
FirewallEgressRule defines rules for outgoing traffic.
+MachineBMCReport is sent from the metal-bmc to update bmc and power related details.
| protocol | -IPProtocol | +uuid | +string | - | Protocol the protocol for the rule, defaults to tcp. |
+ UUID of the machine. |
|
| ports | -uint32 | -repeated | -Ports the ports affected by this rule. |
+ bmc | +MachineBMC | ++ | Bmc contains bmc details. |
| to | -string | +bios | +MachineBios | ++ | Bios contains bios details. |
+ ||
| fru | +MachineFRU | ++ | Fru contains field replaceable unit details. |
+ ||||
| power_metric | +MachinePowerMetric | ++ | PowerMetric contains the power statistics of the machine. |
+ ||||
| power_supplies | +MachinePowerSupply | repeated | -To the destination cidrs affected by this rule. |
+ PowerSupplies contains details about all power supplies and their state. |
|||
| comment | -string | +led_state | +MachineChassisIdentifyLEDState | - | Comment for this rule. |
+ LedState indicates the state of the indicator LED on this machine. |
+ |
| updated_at | +google.protobuf.Timestamp | ++ | UpdatedAt contains the date when this data was last updated. |
| protocol | -IPProtocol | -- | Protocol the protocol for the rule, defaults to tcp. |
- ||||
| ports | -uint32 | -repeated | -Ports the ports affected by this rule. |
- ||||
| to | +version | string | -repeated | -To the destination cidrs affected by this rule. |
+ + | Version the bios version. |
|
| from | +vendor | string | -repeated | -From the source cidrs affected by this rule. |
+ + | Vendor the bios vendor. |
|
| comment | +date | string | - | Comment for this rule. |
+ Date the bios date as string because every vendor has different ideas how to describe the date. |
| egress | -FirewallEgressRule | -repeated | -Egress list of egress rules to be deployed during firewall allocation. |
+ name | +string | ++ | Name of this block device. |
| ingress | -FirewallIngressRule | -repeated | -Ingress list of ingress rules to be deployed during firewall allocation. |
+ size | +uint64 | ++ | Size of this block device in bytes. |
| firewall_rules | -FirewallRules | +value | +string | - | FirewallRules to be applied if this is a firewall. |
+ Value the state of this chassis identify LED. empty means LED-OF. |
+ |
| description | +string | ++ | Description a description why this chassis identify LED is in the given state. |
| uuid | -string | -- | UUID of this machine. |
- |||
| meta | -Meta | -- | Meta for this machine. |
- |||
| partition | -Partition | +state | +MachineState | - | Partition where this machine resides. |
+ State the state of this machine. empty means available for al. |
| rack | +description | string | - | Rack where this machine is located. |
+ Description a description why this machine is in the given state. |
|
| room | +issuer | string | - | Room where this machine is located. |
- ||
| size | -Size | -- | Size of this machine. |
- |||
| hardware | -MachineHardware | -- | Hardware specs of this machine. |
+ Issuer the user that changed the state. |
||
| allocation | -MachineAllocation | -- | Allocation details. |
-
MachineDiskQuery disk specific machine queries.
+ + +| Field | Type | Label | Description | ||||
| status | -MachineStatus | -- | Status contains several status details related to this machine. |
+ names | +string | +repeated | +Names of disks in this machine. |
| recent_provisioning_events | -MachineRecentProvisioningEvents | -- | MachineRecentProvisioningEvents contains the recent provisioning events. |
+ sizes | +uint64 | +repeated | +Sizes of disks in this machine. |
| uuid | +chassis_part_number | string | -- | UUID of this machine allocation. |
+ optional | +ChassisPartNumber is the part number of the machine chassis. |
|
| meta | -Meta | -- | Meta for this machine allocation. |
+ chassis_part_serial | +string | +optional | +ChassisPartSerial is the serial number of the machine chassis. |
| name | +board_mfg | string | -- | Name of this allocation. |
+ optional | +BoardMfg is the short description of the mainboard. |
|
| description | +board_mfg_serial | string | -- | Description of this allocation. |
+ optional | +BoardMfgSerial is the serial number of the mainboard. |
|
| created_by | +board_part_number | string | -- | Created By indicates who created this machine allocation. |
+ optional | +BoardPartNumber is the part number of the mainboard. |
|
| project | +product_manufacturer | string | -- | Project of the allocation. |
+ optional | +ProductManufacturer is the manufacturer of the machine. |
|
| image | -Image | -- | Image to be used to install on this machine. |
+ product_part_number | +string | +optional | +ProductPartNumber is the part number of the machine. |
| filesystem_layout | -FilesystemLayout | -- | FilesystemLayout to create on the disks. |
+ product_serial | +string | +optional | +ProductSerial is the serial number of the machine. |
| networks | -MachineNetwork | -repeated | -Networks this machine should be attached to. -Order of ips of external networks will be preserved. |
-
MachineFRUQuery machine fru specific machine queries.
+ + +| Field | Type | Label | Description | ||||
| hostname | +chassis_part_number | string | -- | Hostname of the allocated machine. |
+ optional | +ChassisPartNumber of this machine. |
|
| ssh_public_keys | +chassis_part_serial | string | -repeated | -SSHPublicKeys which should be installed on this machine. |
+ optional | +ChassisPartSerial of this machine. |
|
| userdata | +board_mfg | string | -- | Userdata contains instructions required to bootstrap the machine. -AWS limits the max userdata size to 16k, lets allow twice as much. |
- |||
| allocation_type | -MachineAllocationType | -- | AllocationType of this machine. |
+ optional | +BoardMFG of this machine. |
||
| firewall_rules | -FirewallRules | -- | FirewallRules to be applied if this is a firewall. |
+ board_serial | +string | +optional | +BoardSerial of this machine. |
| dns_servers | -DNSServer | -repeated | -DNSServers for this machine. |
+ board_part_number | +string | +optional | +BoardPartNumber of this machine. |
| ntp_servers | -NTPServer | -repeated | -NTPServers for this machine. |
+ product_manufacturer | +string | +optional | +ProductManufacturer of this machine. |
| vpn | -MachineVPN | -- | VPN connection configuration. |
+ product_part_number | +string | +optional | +ProductPartNumber of this machine. |
| placement_labels | -Labels | -- | PlacementLabels by default machines are spread across the racks inside a partition for every project. -if placement labels are provided, the machine candidate has an additional anti-affinity to other machines having the same labels. |
+ product_serial | +string | +optional | +ProductSerial of this machine. |
| network | -string | +memory | +uint64 | - | Network the id of the network that this machine will be placed in. |
+ Memory the total memory of the machine in bytes. |
| ips | -string | +disks | +MachineBlockDevice | repeated | -IPs to to attach to this machine additionally. -If none given, one ip address is acquired per network for the machine. -Order of ips is preserved on the loopback interface. |
-
MachineAllocationQuery allocation specific query parameters.
- - -| Field | Type | Label | Description | ||||
| uuid | -string | -optional | -UUID of the allocation of the machine to get. |
- ||||
| name | -string | -optional | -Name of the machine to get. |
- ||||
| project | -string | -optional | -Project of the machine to get. |
+ Disks the list of block devices of this machine. |
|||
| image | -string | -optional | -Image of the machine to get. |
+ cpus | +MetalCPU | +repeated | +CPUs the cpu details. |
| filesystem_layout | -string | -optional | -FilesystemLayout of the machine to get. |
+ gpus | +MetalGPU | +repeated | +GPUs the gpu details. |
| hostname | -string | -optional | -Hostname of the machine to get. |
+ nics | +MachineNic | +repeated | +Nics the list of network interfaces of this machine. |
| allocation_type | -MachineAllocationType | -optional | -AllocationType of this machine. |
-
MachineHardwareQuery machine hardware specific machine queries.
+ + +| Field | Type | Label | Description | ||||
| labels | -Labels | +memory | +uint64 | optional | -Labels for which this machine allocation should get filtered. |
+ Memory the total memory of the machine in bytes. |
|
| vpn | -MachineVPN | +cpu_cores | +uint32 | optional | -VPN query if this machine has a vpn configuration. |
+ CPUCores the number of cpu cores. |
| address | -string | +type | +MachineIssueType | - | Address of this ipmi device from outside in the form of <ip or hostname>:<port>. |
+ Type specifies the issue type (id). |
| mac | -string | +severity | +MachineIssueSeverity | - | Mac address of the network interface of this ipmi device. |
+ Severity specifies the severity of an issue. |
| user | +description | string | - | User of this ipmi device. |
+ Description provides an issue description. |
|
| password | +reference_url | string | - | Password of this ipmi device. |
+ RefURL provides a link to a more detailed issue description in the metal-stack documentation. |
|
| interface | +details | string | - | Interface of this ipmi device. |
+ Details may contain additional details on an evaluated issue. |
MachineIssues is a list of issues for a machine.
+ + +| Field | Type | Label | Description | ||||
| version | +uuid | string | - | Version of this bmc device. |
+ UUID of the machine for which the issues are listed. |
||
| power_state | -string | -- | PowerState of this machine. |
+ issues | +MachineIssue | +repeated | +Issues of this machine. |
| uuid | -string | -- | UUID of this machine. |
- ||||
| partition | -string | +machine_query | +MachineQuery | - | Partition where this machine resides. |
+ MachineQuery to select specific machines. |
|
| rack | -string | -- | Rack where this machine is located. |
+ only | +MachineIssueType | +repeated | +Only includes the specified machine issue types. |
| room | -string | -- | Room where this machine is located. |
+ omit | +MachineIssueType | +repeated | +Omits the specified machine issues. |
| size | -string | -- | Size of this machine. |
+ severity | +MachineIssueSeverity | +optional | +Severity filters issue for given severity. |
| bmc_report | -MachineBMCReport | +last_error_threshold | +google.protobuf.Duration | - | BMCReport contains the bmc details. |
+ LastErrorThreshold defines the last error threshold. |
| address | +network | string | -optional | -Address of the ipmi system of this machine. |
+ + | Network the networkID of the allocated machine in this vrf. |
|
| mac | +prefixes | string | -optional | -Mac of the ipmi system of this machine. |
+ repeated | +Prefixes the prefixes of this network. |
|
| user | +destination_prefixes | string | -optional | -User of the ipmi system of this machine. |
+ repeated | +DestinationPrefixes prefixes that are reachable within this network. |
|
| interface | +ips | +string | +repeated | +IPs the ip addresses of the allocated machine in this vrf. |
+ |||
| network_type | +NetworkType | ++ | NetworkType the type of network of this vrf. |
+ ||||
| nat_type | +NATType | ++ | NatType what type of nat if any should be used. |
+ ||||
| vrf | +uint64 | ++ | VRF the vrf id. |
+ ||||
| asn | +uint32 | ++ | ASN the autonomous system number for this network. |
+ ||||
| project | string | optional | -Interface of the ipmi system of this machine. |
+ Project is the project uuid associated with this network. |
| uuid | +networks | string | -- | UUID of the machine. |
- |||
| bmc | -MachineBMC | -- | Bmc contains bmc details. |
- ||||
| bios | -MachineBios | -- | Bios contains bios details. |
+ repeated | +Networks this machine is connected to. |
||
| fru | -MachineFRU | -- | Fru contains field replaceable unit details. |
+ prefixes | +string | +repeated | +Prefixes this machine is connected to. |
| power_metric | -MachinePowerMetric | -- | PowerMetric contains the power statistics of the machine. |
+ destination_prefixes | +string | +repeated | +DestinationPrefixes this machine is connected to. |
| power_supplies | -MachinePowerSupply | +ips | +string | repeated | -PowerSupplies contains details about all power supplies and their state. |
+ IPs this machine has. |
|
| led_state | -MachineChassisIdentifyLEDState | -- | LedState indicates the state of the indicator LED on this machine. |
+ vrfs | +uint64 | +repeated | +VRFs this machine is connected to. |
| updated_at | -google.protobuf.Timestamp | -- | UpdatedAt contains the date when this data was last updated. |
+ asns | +uint32 | +repeated | +ASNs this machine is connected to. |
| version | +mac | string | - | Version the bios version. |
+ Deprecated. Mac the macaddress of this interface. |
+
| name | +string | ++ | Name of this interface. |
+ ||
| identifier | +string | ++ | Identifier the unique identifier of this network interface. |
||
| vendor | string | - | Vendor the bios vendor. |
+ Vendor of this network card. |
|
| date | +model | string | - | Date the bios date as string because every vendor has different ideas how to describe the date. |
+ Model of this network card. |
+
| speed | +uint64 | ++ | Speed in bits/second of this network card. |
+ ||
| neighbors | +MachineNic | +repeated | +Neighbors the neighbors visible to this network interface. |
+ ||
| hostname | +string | ++ | Hostname the nic belongs to. |
| Name | +Option | +
| mac | +true |
+
MachineBlockDevice contains details of a block device of this machine.
+MachineNicQuery nic specific machine queries.
| name | +macs | string | -- | Name of this block device. |
+ repeated | +Macs this machine nic has. |
|
| size | -uint64 | -- | Size of this block device in bytes. |
+ names | +string | +repeated | +Names this machine nic has. |
+
| neighbor_macs | +string | +repeated | +NeighborMacs this machine nic has. |
+ ||||
| neighbor_names | +string | +repeated | +NeighborNames this machine nic has. |
| value | -string | +average_consumed_watts | +float | - | Value the state of this chassis identify LED. empty means LED-OF. |
+ AverageConsumedWatts shall represent the average power level that occurred averaged over the last IntervalInMin minutes. |
|
| description | -string | +interval_in_min | +float | - | Description a description why this chassis identify LED is in the given state. |
+ IntervalInMin shall represent the time interval (or window), in minutes, in which the PowerMetrics properties are measured over. +Should be an integer, but some Dell implementations return as a float. |
+ |
| max_consumed_watts | +float | ++ | MaxConsumedWatts shall represent the maximum power level in watts that occurred within the last IntervalInMin minutes. |
+ ||||
| min_consumed_watts | +float | ++ | MinConsumedWatts shall represent the minimum power level in watts that occurred within the last IntervalInMin minutes. |
| state | -MachineState | -- | State the state of this machine. empty means available for al. |
- ||||
| description | +health | string | - | Description a description why this machine is in the given state. |
+ Health of the powersupply. |
||
| issuer | +state | string | - | Issuer the user that changed the state. |
+ State of the powersupply. |
| names | -string | -repeated | -Names of disks in this machine. |
+ time | +google.protobuf.Timestamp | ++ | Time the time that this event was received. |
| sizes | -uint64 | -repeated | -Sizes of disks in this machine. |
+ event | +MachineProvisioningEventType | ++ | Event the event emitted by the machine. |
+
| message | +string | ++ | Message an additional message to add to the event. |
| chassis_part_number | +uuid | string | optional | -ChassisPartNumber is the part number of the machine chassis. |
+ UUID of the machine to get. |
|
| chassis_part_serial | +name | string | optional | -ChassisPartSerial is the serial number of the machine chassis. |
+ Name of the machine to get. |
|
| board_mfg | +partition | string | optional | -BoardMfg is the short description of the mainboard. |
+ Partition of the machine to get. |
|
| board_mfg_serial | +size | string | optional | -BoardMfgSerial is the serial number of the mainboard. |
+ Size of the machine to get. |
|
| board_part_number | +rack | string | optional | -BoardPartNumber is the part number of the mainboard. |
+ Rack of the machine to get. |
|
| product_manufacturer | +room | string | optional | -ProductManufacturer is the manufacturer of the machine. |
+ Room of the machine to get. |
|
| product_part_number | -string | +labels | +Labels | optional | -ProductPartNumber is the part number of the machine. |
+ Labels for which this machine should get filtered. |
| product_serial | -string | +allocation | +MachineAllocationQuery | optional | -ProductSerial is the serial number of the machine. |
+ Allocation specific machine queries. |
MachineFRUQuery machine fru specific machine queries.
- - -| Field | Type | Label | Description | ||||
| network | +MachineNetworkQuery | +optional | +Network specific machine queries. |
+ ||||
| chassis_part_number | -string | +nic | +MachineNicQuery | optional | -ChassisPartNumber of this machine. |
+ Nic specific machine queries. |
|
| chassis_part_serial | -string | +disk | +MachineDiskQuery | optional | -ChassisPartSerial of this machine. |
+ Disk specific machine queries. |
|
| board_mfg | -string | +bmc | +MachineBMCQuery | optional | -BoardMFG of this machine. |
+ Bmc specific machine queries. |
|
| board_serial | -string | +fru | +MachineFRUQuery | optional | -BoardSerial of this machine. |
+ Fru specific machine queries. |
|
| board_part_number | -string | +hardware | +MachineHardwareQuery | optional | -BoardPartNumber of this machine. |
+ Hardware specific machine query. |
|
| product_manufacturer | -string | +state | +MachineState | optional | -ProductManufacturer of this machine. |
+ State this machine has. |
|
| product_part_number | -string | +waiting | +bool | optional | -ProductPartNumber of this machine. |
+ Waiting if set to true, only waiting machines are returned. +Only useful for admins. |
|
| product_serial | -string | +preallocated | +bool | optional | -ProductSerial of this machine. |
+ Preallocated if set to true, only machines which are preallocated are returned. +Only useful for admins. |
+ |
| not_allocated | +bool | +optional | +NotAllocated if set to true, only machines which are not allocated are returned. +Only useful for admins. |
| memory | -uint64 | -- | Memory the total memory of the machine in bytes. |
- ||||
| disks | -MachineBlockDevice | -repeated | -Disks the list of block devices of this machine. |
- ||||
| cpus | -MetalCPU | -repeated | -CPUs the cpu details. |
- ||||
| gpus | -MetalGPU | +events | +MachineProvisioningEvent | repeated | -GPUs the gpu details. |
+ Events the log of recent machine provisioning events. |
|
| nics | -MachineNic | -repeated | -Nics the list of network interfaces of this machine. |
+ last_event_time | +google.protobuf.Timestamp | ++ | LastEventTime the time where the last event was received. |
MachineHardwareQuery machine hardware specific machine queries.
- - -| Field | Type | Label | Description | ||||
| memory | -uint64 | -optional | -Memory the total memory of the machine in bytes. |
+ last_error_event | +MachineProvisioningEvent | ++ | LastErrorEvent the last erroneous event received. |
| cpu_cores | -uint32 | -optional | -CPUCores the number of cpu cores. |
+ state | +MachineProvisioningEventState | ++ | State can be either CrashLoop, FailedReclaim or something else. |
| type | -MachineIssueType | -- | Type specifies the issue type (id). |
- ||||
| severity | -MachineIssueSeverity | -- | Severity specifies the severity of an issue. |
- ||||
| description | +uuid | string | - | Description provides an issue description. |
+ UUID of the machine to send the command to. |
||
| reference_url | +project | string | - | RefURL provides a link to a more detailed issue description in the metal-stack documentation. |
+ Project of the machine. |
||
| details | -string | +command | +MachineBMCCommand | - | Details may contain additional details on an evaluated issue. |
+ Command to send to the bmc of the machine. |
| uuid | +task_id | string | - | UUID of the machine for which the issues are listed. |
- |||
| issues | -MachineIssue | -repeated | -Issues of this machine. |
+ TaskId is the identifier of the task that managed the bmc command execution. +Only useful for admins. |
| machine_query | -MachineQuery | +project | +string | - | MachineQuery to select specific machines. |
+ Project of the machine. |
|
| only | -MachineIssueType | -repeated | -Only includes the specified machine issue types. |
+ uuid | +string | +optional | +UUID if this field is set, this specific machine will be allocated if it is not in available state and not currently allocated. +this field takes precedence over size and partition. +Can only be used with ADMIN_ROLE_EDITOR. |
| omit | -MachineIssueType | -repeated | -Omits the specified machine issues. |
+ name | +string | ++ | Name of this machine. |
| severity | -MachineIssueSeverity | +description | +string | optional | -Severity filters issue for given severity. |
+ Description for this machine. |
|
| last_error_threshold | -google.protobuf.Duration | -- | LastErrorThreshold defines the last error threshold. |
+ hostname | +string | +optional | +Hostname the hostname for the allocated machine (defaults to metal). |
MachineNetwork contains details which network should be created on a allocated machine.
- - -| Field | Type | Label | Description | ||||
| partition | +string | +optional | +Partition the partition id to assign this machine to, must be omitted if uuid is given. |
+ ||||
| network | +size | +string | +optional | +Size of the machine to create, must be omitted if uuid is given. |
+ |||
| image | string | - | Network the networkID of the allocated machine in this vrf. |
+ Image which should be installed on this machine. +The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch +- debian-13.0.2026040 +- or in a simplified form which omits the patch version. +- debian-13. +If the fully qualified form is specified, exactly this image is taken regardless of the image classification. +If the short form is given, only the most recent images which has image classification supported is used. |
|||
| prefixes | +filesystem_layout | string | -repeated | -Prefixes the prefixes of this network. |
+ optional | +FilesystemLayout which should be applied for the operating system installation. +Is defaulted by a lookup at the available fsls for this size and image. +Can be specified to test new fsls during development of fsls. |
|
| destination_prefixes | +ssh_public_keys | string | repeated | -DestinationPrefixes prefixes that are reachable within this network. |
+ SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh. |
||
| ips | +userdata | string | -repeated | -IPs the ip addresses of the allocated machine in this vrf. |
+ optional | +Userdata contains instructions required to bootstrap the machine. +AWS limits the max userdata size to 16k, lets allow twice as much. +Must be base64 encoded. |
|
| network_type | -NetworkType | +labels | +Labels | - | NetworkType the type of network of this vrf. |
+ Labels to be attached to this machine allocation. |
|
| nat_type | -NATType | -- | NatType what type of nat if any should be used. |
+ networks | +MachineAllocationNetwork | +repeated | +Networks the networks that this machine will be placed in. |
| vrf | -uint64 | +placement_labels | +Labels | - | VRF the vrf id. |
+ PlacementLabels by default machines are spread across the racks inside a partition for every project. +if placement labels are provided, the machine candidate has an additional anti-affinity to other machines having the same labels. |
|
| asn | -uint32 | +dns_servers | +DNSServer | +repeated | +DNSServer the dns servers used for the machine. |
+ ||
| ntp_servers | +NTPServer | +repeated | +NTPServer the ntp servers used for the machine. |
+ ||||
| allocation_type | +MachineAllocationType | - | ASN the autonomous system number for this network. |
+ AllocationType of this machine. |
|||
| project | -string | -optional | -Project is the project uuid associated with this network. |
+ firewall_spec | +FirewallSpec | ++ | FirewallSpec provides firewall specific parameters if allocationType is firewall. |
| networks | -string | -repeated | -Networks this machine is connected to. |
+ machine | +Machine | ++ | Machine which was created. |
| prefixes | -string | -repeated | -Prefixes this machine is connected to. |
-
MachineServiceDeleteRequest is the request payload for a machine delete request.
+ + +| Field | Type | Label | Description | |||
| destination_prefixes | +uuid | string | -repeated | -DestinationPrefixes this machine is connected to. |
+ + | UUID of the machine to delete. |
| ips | +project | string | -repeated | -IPs this machine has. |
+ + | Project of the machine. |
| vrfs | -uint64 | -repeated | -VRFs this machine is connected to. |
-
MachineServiceDeleteResponse is the response payload for a machine delete request.
+ + +| Field | Type | Label | Description | ||||
| asns | -uint32 | -repeated | -ASNs this machine is connected to. |
+ machine | +Machine | ++ | Machine which was deleted. |
| mac | +uuid | string | - | Deprecated. Mac the macaddress of this interface. |
+ UUID of the machine to get. |
| name | +project | string | - | Name of this interface. |
+ Project of the machine. |
MachineServiceGetBMCResponse is the response payload for a machine getbmc request.
+ + +| Field | Type | Label | Description | |||
| identifier | -string | +bmc_details | +MachineBMCDetails | - | Identifier the unique identifier of this network interface. |
+ BMCDetails contains the BMC details of this machine. |
MachineServiceGetRequest is the request payload for a machine get request.
+ + +| Field | Type | Label | Description | ||
| vendor | +uuid | string | - | Vendor of this network card. |
+ UUID of the machine to get. |
| model | +project | string | - | Model of this network card. |
+ Project of the machine. |
| speed | -uint64 | -- | Speed in bits/second of this network card. |
-
MachineServiceGetResponse is the response payload for a machine get request.
+ + +| Field | Type | Label | Description | ||||
| neighbors | -MachineNic | -repeated | -Neighbors the neighbors visible to this network interface. |
+ machine | +Machine | ++ | Machine is the machine requested. |
MachineServiceListRequest is the request payload for a machine list request.
+ + +| Field | Type | Label | Description | ||
| hostname | +project | string | - | Hostname the nic belongs to. |
+ Project of the machines to list. |
+
| query | +MachineQuery | ++ | Query to list one ore more machines. |
| Name | -Option | -
| Field | Type | Label | Description | ||
| mac | -true |
+ machines | +Machine | +repeated | +Machines are the machines requested by a list request. |
MachineNicQuery nic specific machine queries.
+MachineServiceUpdateRequest is the request payload for a machine update request.
| macs | +uuid | string | -repeated | -Macs this machine nic has. |
+ + | UUID of the machine to modify. |
|
| names | +update_meta | +UpdateMeta | ++ | UpdateMeta contains the timestamp and strategy to be used in this update request. |
+ |||
| project | string | -repeated | -Names this machine nic has. |
+ + | Project of the machine. |
||
| neighbor_macs | +description | string | -repeated | -NeighborMacs this machine nic has. |
+ optional | +Description of this machine allocation. |
|
| neighbor_names | +labels | +UpdateLabels | +optional | +Labels to update on this machine allocation. |
+ |||
| ssh_public_keys | string | repeated | -NeighborNames this machine nic has. |
+ SSHPublicKeys which should be update of this machine allocation. |
| average_consumed_watts | -float | +machine | +Machine | - | AverageConsumedWatts shall represent the average power level that occurred averaged over the last IntervalInMin minutes. |
+ Machine which was updated. |
MachineStatus contains several status details related to this machine.
+ + +| Field | Type | Label | Description | ||||
| interval_in_min | -float | +condition | +MachineCondition | - | IntervalInMin shall represent the time interval (or window), in minutes, in which the PowerMetrics properties are measured over. -Should be an integer, but some Dell implementations return as a float. |
+ Condition describes the availability. |
|
| max_consumed_watts | -float | +led_state | +MachineChassisIdentifyLEDState | - | MaxConsumedWatts shall represent the maximum power level in watts that occurred within the last IntervalInMin minutes. |
+ LEDState indicates the state of the indicator LED on this machine. |
|
| min_consumed_watts | -float | +liveliness | +MachineLiveliness | - | MinConsumedWatts shall represent the minimum power level in watts that occurred within the last IntervalInMin minutes. |
+ Liveliness of this machine. |
+ |
| metal_hammer_version | +string | ++ | MetalHammerVersion the version of metal hammer which put the machine in waiting state. |
| health | +control_plane_address | string | - | Health of the powersupply. |
+ Address of VPN control plane. |
||
| state | +auth_key | string | - | State of the powersupply. |
+ Auth key used to connect to VPN. |
+ ||
| connected | +bool | ++ | Connected indicate if this machine is connected to the VPN. |
+ ||||
| ips | +string | +repeated | +IPs of the machine connected to the vpn. |
| time | -google.protobuf.Timestamp | +vendor | +string | - | Time the time that this event was received. |
+ Vendor of this cpu. |
|
| event | -MachineProvisioningEventType | +model | +string | - | Event the event emitted by the machine. |
+ Model of this cpu. |
|
| message | -string | +cores | +uint32 | - | Message an additional message to add to the event. |
+ Cores of this cpu. |
+ |
| threads | +uint32 | ++ | Threads of this cpu. |
| uuid | +vendor | string | -optional | -UUID of the machine to get. |
+ + | Vendor of this gpu. |
| name | +model | string | -optional | -Name of the machine to get. |
- ||
| partition | -string | -optional | -Partition of the machine to get. |
- |||
| size | -string | -optional | -Size of the machine to get. |
- |||
| rack | -string | -optional | -Rack of the machine to get. |
- |||
| room | -string | -optional | -Room of the machine to get. |
- |||
| labels | -Labels | -optional | -Labels for which this machine should get filtered. |
- |||
| allocation | -MachineAllocationQuery | -optional | -Allocation specific machine queries. |
- |||
| network | -MachineNetworkQuery | -optional | -Network specific machine queries. |
- |||
| nic | -MachineNicQuery | -optional | -Nic specific machine queries. |
- |||
| disk | -MachineDiskQuery | -optional | -Disk specific machine queries. |
- |||
| bmc | -MachineBMCQuery | -optional | -Bmc specific machine queries. |
- |||
| fru | -MachineFRUQuery | -optional | -Fru specific machine queries. |
- |||
| hardware | -MachineHardwareQuery | -optional | -Hardware specific machine query. |
- |||
| state | -MachineState | -optional | -State this machine has. |
- |||
| waiting | -bool | -optional | -Waiting if set to true, only waiting machines are returned. -Only useful for admins. |
- |||
| preallocated | -bool | -optional | -Preallocated if set to true, only machines which are preallocated are returned. -Only useful for admins. |
- |||
| not_allocated | -bool | -optional | -NotAllocated if set to true, only machines which are not allocated are returned. -Only useful for admins. |
-
MachineRecentProvisioningEvents the recent provisioning events for this machine.
- - -| Field | Type | Label | Description | ||||
| events | -MachineProvisioningEvent | -repeated | -Events the log of recent machine provisioning events. |
- ||||
| last_event_time | -google.protobuf.Timestamp | -- | LastEventTime the time where the last event was received. |
- ||||
| last_error_event | -MachineProvisioningEvent | -- | LastErrorEvent the last erroneous event received. |
- ||||
| state | -MachineProvisioningEventState | -- | State can be either CrashLoop, FailedReclaim or something else. |
+ + | Model of this gpu. |
| Field | Type | Label | Description |
| uuid | -string | -- | UUID of the machine to send the command to. |
-
| project | -string | -- | Project of the machine. |
-
| command | -MachineBMCCommand | -- | Command to send to the bmc of the machine. |
-
MachineServiceBMCCommandResponse is the response payload for a machine bmc command.
- - -| Field | Type | Label | Description |
| task_id | -string | -- | TaskId is the identifier of the task that managed the bmc command execution. -Only useful for admins. |
-
IPProtocol defines tcp|udp.
+| Name | Number | Description |
| IP_PROTOCOL_UNSPECIFIED | +0 | +IP_PROTOCOL_UNSPECIFIED is not specified. |
+
| IP_PROTOCOL_TCP | +1 | +IP_PROTOCOL_TCP is tcp. |
+
| IP_PROTOCOL_UDP | +2 | +IP_PROTOCOL_UDP is udp. |
+
MachineServiceCreateRequest is the request payload for a machine create request.
- - -| Field | Type | Label | Description | ||||
| project | -string | -- | Project of the machine. |
- ||||
| uuid | -string | -optional | -UUID if this field is set, this specific machine will be allocated if it is not in available state and not currently allocated. -this field takes precedence over size and partition. -Can only be used with ADMIN_ROLE_EDITOR. |
- ||||
| name | -string | -- | Name of this machine. |
- ||||
| description | -string | -optional | -Description for this machine. |
- ||||
| hostname | -string | -optional | -Hostname the hostname for the allocated machine (defaults to metal). |
- ||||
| partition | -string | -optional | -Partition the partition id to assign this machine to, must be omitted if uuid is given. |
- ||||
| size | -string | -optional | -Size of the machine to create, must be omitted if uuid is given. |
- ||||
| image | -string | -- | Image which should be installed on this machine. -The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch -- debian-13.0.2026040 -- or in a simplified form which omits the patch version. -- debian-13. -If the fully qualified form is specified, exactly this image is taken regardless of the image classification. -If the short form is given, only the most recent images which has image classification supported is used. |
- ||||
| filesystem_layout | -string | -optional | -FilesystemLayout which should be applied for the operating system installation. -Is defaulted by a lookup at the available fsls for this size and image. -Can be specified to test new fsls during development of fsls. |
-
| Name | Number | Description |
| MACHINE_ALLOCATION_TYPE_UNSPECIFIED | +0 | +MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified. |
+
| MACHINE_ALLOCATION_TYPE_MACHINE | +1 | +MACHINE_ALLOCATION_TYPE_MACHINE is a machine. |
+
| MACHINE_ALLOCATION_TYPE_FIREWALL | +2 | +MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall. |
+
MachineBMCCommand defines commands send to the BMC of the machine.
+| Name | Number | Description |
| MACHINE_BMC_COMMAND_UNSPECIFIED | +0 | +MACHINE_BMC_COMMAND_UNSPECIFIED is not defined. |
+
| MACHINE_BMC_COMMAND_ON | +1 | +MACHINE_BMC_COMMAND_ON Power on the machine. |
+
| MACHINE_BMC_COMMAND_OFF | +2 | +MACHINE_BMC_COMMAND_OFF Power off the machine. |
+
| MACHINE_BMC_COMMAND_RESET | +3 | +MACHINE_BMC_COMMAND_RESET Power reset the machine. |
+
| MACHINE_BMC_COMMAND_CYCLE | +4 | +MACHINE_BMC_COMMAND_CYCLE Power cycle the machine. |
+
| MACHINE_BMC_COMMAND_BOOT_TO_BIOS | +5 | +MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios. |
+
| MACHINE_BMC_COMMAND_BOOT_FROM_DISK | +6 | +MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk. |
+
| MACHINE_BMC_COMMAND_BOOT_FROM_PXE | +7 | +MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe. |
+
| MACHINE_BMC_COMMAND_IDENTIFY_LED_ON | +8 | +MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on. |
+
| MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF | +9 | +MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off. |
+
| MACHINE_BMC_COMMAND_MACHINE_DELETED | +10 | +MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe. |
+
| MACHINE_BMC_COMMAND_MACHINE_CREATED | +11 | +MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk. |
+
MachineIssueSeverity defines the severity of an issue.
+| Name | Number | Description |
| MACHINE_ISSUE_SEVERITY_UNSPECIFIED | +0 | +MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified. |
+
| MACHINE_ISSUE_SEVERITY_MINOR | +1 | +MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor. |
+
| MACHINE_ISSUE_SEVERITY_MAJOR | +2 | +MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major. |
+
| MACHINE_ISSUE_SEVERITY_CRITICAL | +3 | +MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical. |
+
MachineIssueType defines which type of issue it is.
+| Name | Number | Description |
| MACHINE_ISSUE_TYPE_UNSPECIFIED | +0 | +MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified. |
+
| MACHINE_ISSUE_TYPE_ASN_UNIQUENESS | +1 | +MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique. |
+
| MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED | +2 | +MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date. |
+
| MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP | +3 | +MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct. |
+
| MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP | +4 | +MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip. |
+
| MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC | +5 | +MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address. |
+
| MACHINE_ISSUE_TYPE_CRASH_LOOP | +6 | +MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop. |
+
| MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM | +7 | +MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete. |
+
| MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR | +8 | +MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error. |
+
| MACHINE_ISSUE_TYPE_LIVELINESS_DEAD | +9 | +MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead. |
+
| MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE | +10 | +MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available. |
+
| MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN | +11 | +MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown. |
+
| MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER | +12 | +MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container. |
+
| MACHINE_ISSUE_TYPE_NO_PARTITION | +13 | +MACHINE_ISSUE_TYPE_NO_PARTITION no partition set. |
+
MachineLiveliness specifies the liveliness of a machine.
+| Name | Number | Description |
| MACHINE_LIVELINESS_UNSPECIFIED | +0 | +MACHINE_LIVELINESS_UNSPECIFIED is not defined. |
+
| MACHINE_LIVELINESS_ALIVE | +1 | +MACHINE_LIVELINESS_ALIVE liveliness is alive. |
+
| MACHINE_LIVELINESS_DEAD | +2 | +MACHINE_LIVELINESS_DEAD liveliness is dead. |
+
| MACHINE_LIVELINESS_UNKNOWN | +3 | +MACHINE_LIVELINESS_UNKNOWN liveliness is unknown. |
+
MachineProvisioningEventState possible event states.
+| Name | Number | Description |
| MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED | +0 | +MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified. |
+
| MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP | +1 | +MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop. |
+
| MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM | +2 | +MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim. |
+
MachineProvisioningEventType defines in which phase the machine actually is.
+| Name | Number | Description |
| MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED | +0 | +MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified. |
+
| MACHINE_PROVISIONING_EVENT_TYPE_ALIVE | +1 | +MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive. |
+
| MACHINE_PROVISIONING_EVENT_TYPE_CRASHED | +2 | +MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed. |
+
| MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING | +3 | +MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer. |
+
| MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT | +4 | +MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction. |
+
| MACHINE_PROVISIONING_EVENT_TYPE_PREPARING | +5 | +MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine. |
+
| MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING | +6 | +MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver. |
+
| MACHINE_PROVISIONING_EVENT_TYPE_WAITING | +7 | +MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation. |
+
| MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING | +8 | +MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os. |
+
| MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL | +9 | +MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os. |
+
| MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME | +10 | +MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home. |
+
| MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM | +11 | +MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home. |
+
MachineState defines if the machine was locked or reserved from a operator.
+| Name | Number | Description |
| MACHINE_STATE_UNSPECIFIED | +0 | +MACHINE_STATE_UNSPECIFIED is not specified. |
+
| MACHINE_STATE_TAINTED | +1 | +MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uui. |
+
| MACHINE_STATE_LOCKED | +2 | +MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or delete. |
+
| MACHINE_STATE_AVAILABLE | +3 | +MACHINE_STATE_AVAILABLE this machine is available for all. |
+
MachineService provides machine lifecycle management operations.
+| Method Name | Request Type | Response Type | Description |
| Get | +MachineServiceGetRequest | +MachineServiceGetResponse | +Returns the machine with the specified UUID. |
+
| Create | +MachineServiceCreateRequest | +MachineServiceCreateResponse | +Creates a new machine. |
+
| Update | +MachineServiceUpdateRequest | +MachineServiceUpdateResponse | +Updates a machine. |
+
| List | +MachineServiceListRequest | +MachineServiceListResponse | +Returns the list of all machines. |
+
| Delete | +MachineServiceDeleteRequest | +MachineServiceDeleteResponse | +Deletes a machine. |
+
| BMCCommand | +MachineServiceBMCCommandRequest | +MachineServiceBMCCommandResponse | +BMCCommand sends a command to the BMC of a machine. |
+
| GetBMC | +MachineServiceGetBMCRequest | +MachineServiceGetBMCResponse | +Returns the BMC details of a machine. |
+
VPNNode represents a machine connected to the VPN.
+ + +| Field | Type | Label | Description | ||||
| ssh_public_keys | -string | -repeated | -SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh. |
+ id | +uint64 | ++ | ID of this node. |
| userdata | +name | string | -optional | -Userdata contains instructions required to bootstrap the machine. -AWS limits the max userdata size to 16k, lets allow twice as much. -Must be base64 encoded. |
+ + | Name of this node. |
|
| labels | -Labels | +project | +string | - | Labels to be attached to this machine allocation. |
+ Project of this node, maps to a project. |
|
| networks | -MachineAllocationNetwork | +ip_addresses | +string | repeated | -Networks the networks that this machine will be placed in. |
+ IPAddresses of this node in the VPN. |
|
| placement_labels | -Labels | +last_seen | +google.protobuf.Timestamp | - | PlacementLabels by default machines are spread across the racks inside a partition for every project. -if placement labels are provided, the machine candidate has an additional anti-affinity to other machines having the same labels. |
+ LastSeen timestamp when this node reached out to the control plane. |
|
| dns_servers | -DNSServer | -repeated | -DNSServer the dns servers used for the machine. |
+ online | +bool | ++ | Online indicates if this node is online. |
HousekeepingServiceMachineLivelinessRequest is the request payload for a machine liveliness housekeeping request.
+ + + + + +HousekeepingServiceMachineLivelinessResponse is the response payload for a machine liveliness housekeeping request.
+ + +| Field | Type | Label | Description | |||
| ntp_servers | -NTPServer | +modified_machines | +MachineWithLiveliness | repeated | -NTPServer the ntp servers used for the machine. |
+ Modified Machines modified during this housekeeping action. |
| allocation_type | -MachineAllocationType | -- | AllocationType of this machine. |
-
HousekeepingServiceMachineResurrectRequest is the request payload for a machine resurrect housekeeping request.
+ + + + + +HousekeepingServiceMachineResurrectResponse is the response payload for a machine resurrect housekeeping request.
+ + +| Field | Type | Label | Description | ||||
| firewall_spec | -FirewallSpec | -- | FirewallSpec provides firewall specific parameters if allocationType is firewall. |
+ modified_machines | +metalstack.api.v2.Machine | +repeated | +Machines which have been resurrected |
| machine | -Machine | -- | Machine which was created. |
+ modified_machines | +metalstack.api.v2.VPNNode | +repeated | +Nodes connected to the VPN. |
| uuid | string | - | UUID of the machine to delete. |
+ UUID of this machine. |
|||
| project | -string | +liveliness | +metalstack.api.v2.MachineLiveliness | - | Project of the machine. |
+ Liveliness of this machine. |
| Method Name | Request Type | Response Type | Description |
| MachineLiveliness | +HousekeepingServiceMachineLivelinessRequest | +HousekeepingServiceMachineLivelinessResponse | +Machine liveliness |
+
| MachineVPNConnected | +HousekeepingServiceMachineVPNConnectedRequest | +HousekeepingServiceMachineVPNConnectedResponse | +Machine vpn connected |
+
| MachineResurrect | +HousekeepingServiceMachineResurrectRequest | +HousekeepingServiceMachineResurrectResponse | +Machine resurrect dead machines |
+
ImageServiceCreateRequest is the request payload for creating an image.
| machine | -Machine | +image | +metalstack.api.v2.Image | - | Machine which was deleted. |
+ Image is the image to create. |
| uuid | -string | +image | +metalstack.api.v2.Image | - | UUID of the machine to get. |
+ Image contains the created image. |
ImageServiceDeleteRequest is the request payload for deleting an image.
+ + +| Field | Type | Label | Description | ||||
| project | +id | string | - | Project of the machine. |
+ ID of the image to delete. |
| bmc_details | -MachineBMCDetails | +image | +metalstack.api.v2.Image | - | BMCDetails contains the BMC details of this machine. |
+ Image contains the deleted image. |
| uuid | -string | +id | +string | ++ | Id of this image. |
+ ||
| update_meta | +metalstack.api.v2.UpdateMeta | ++ | UpdateMeta contains the timestamp and strategy to be used in this update request. |
+ ||||
| url | +string | +optional | +URL where this image is located. |
+ ||||
| name | +string | +optional | +Name of this image. |
+ ||||
| description | +string | +optional | +Description of this image. |
+ ||||
| features | +metalstack.api.v2.ImageFeature | +repeated | +Features of this image. |
+ ||||
| classification | +metalstack.api.v2.ImageClassification | - | UUID of the machine to get. |
+ Classification of this image. |
|||
| project | -string | +expires_at | +google.protobuf.Timestamp | - | Project of the machine. |
+ ExpiresAt indicates that usage is not possible after this date. |
+ |
| labels | +metalstack.api.v2.UpdateLabels | +optional | +Labels to update on this image. |
| machine | -Machine | +image | +metalstack.api.v2.Image | - | Machine is the machine requested. |
+ Image contains the updated image. |
| project | -string | -- | Project of the machines to list. |
- ||||
| query | -MachineQuery | +metalstack.api.v2.ImageQuery | - | Query to list one ore more machines. |
+ Query for which images the usage should be reported. |
| machines | -Machine | +image_usage | +metalstack.api.v2.ImageUsage | repeated | -Machines are the machines requested by a list request. |
+ Images contains usage information. |
| Method Name | Request Type | Response Type | Description |
| Create | +ImageServiceCreateRequest | +ImageServiceCreateResponse | +Creates a new image. |
+
| Update | +ImageServiceUpdateRequest | +ImageServiceUpdateResponse | +Updates an image. |
+
| Delete | +ImageServiceDeleteRequest | +ImageServiceDeleteResponse | +Deletes an image. |
+
| Usage | +ImageServiceUsageRequest | +ImageServiceUsageResponse | +Returns the usage of images. |
+
IP is an IP address which can be used as loadbalancer addresses.
| uuid | string | - | UUID of the machine to modify. |
+ Uuid of this ip. |
|||
| update_meta | -UpdateMeta | +meta | +Meta | - | UpdateMeta contains the timestamp and strategy to be used in this update request. |
+ Meta for this ip. |
|
| project | +ip | string | - | Project of the machine. |
+ Ip is either ipv4 or ipv6 address. |
+ ||
| name | +string | ++ | Name of this ip. |
||||
| description | string | -optional | -Description of this machine allocation. |
+ + | Description of this ip. |
||
| labels | -UpdateLabels | -optional | -Labels to update on this machine allocation. |
+ network | +string | ++ | Network is the network this ip belongs to. |
| ssh_public_keys | +project | string | -repeated | -SSHPublicKeys which should be update of this machine allocation. |
+ + | Project where this ip address belongs to. |
+ |
| type | +IPType | ++ | Type of this ip. |
+ ||||
| namespace | +string | +optional | +Namespace if specified this ip is from a namespaced network and can therefore overlap with others. +Will be equal with project most of the time. |
| ip | +string | +optional | +Ip the ip to list. |
+ |||
| network | +string | +optional | +Network from which the IPs are to list. |
+ |||
| project | +string | +optional | +Project of the ips to list. |
+ |||
| name | +string | +optional | +Name of this ip. |
+ |||
| uuid | +string | +optional | +UUID for which these IPs should be filtered. |
+ |||
| machine | -Machine | -- | Machine which was updated. |
+ string | +optional | +Machine for which these IPs should be filtered. |
MachineStatus contains several status details related to this machine.
- - -| Field | Type | Label | Description | ||||
| parent_prefix_cidr | +string | +optional | +ParentPrefixCidr for which this ips should get filtered. |
+ ||||
| condition | -MachineCondition | -- | Condition describes the availability. |
+ labels | +Labels | +optional | +Labels for which these IPs should be filtered. |
| led_state | -MachineChassisIdentifyLEDState | -- | LEDState indicates the state of the indicator LED on this machine. |
+ type | +IPType | +optional | +Static if set to true, this will be a Static ip. |
| liveliness | -MachineLiveliness | -- | Liveliness of this machine. |
+ address_family | +IPAddressFamily | +optional | +Address family of the IPs to list, defaults to all address families. |
| metal_hammer_version | +namespace | string | -- | MetalHammerVersion the version of metal hammer which put the machine in waiting state. |
+ optional | +Namespace can be specified to get the ip of a namespace. |
| control_plane_address | +network | string | - | Address of VPN control plane. |
+ Network from which the IP should be created. |
||
| auth_key | +project | string | - | Auth key used to connect to VPN. |
+ Project of the ip. |
||
| connected | -bool | -- | Connected indicate if this machine is connected to the VPN. |
+ name | +string | +optional | +Name of the ip. |
| ips | +description | string | -repeated | -IPs of the machine connected to the vpn. |
+ optional | +Description of the ip. |
MetalCPU contains details of a cpu in this machine.
- - -| Field | Type | Label | Description | ||||
| vendor | +ip | string | -- | Vendor of this cpu. |
+ optional | +IP if given try to create this ip if still available. |
|
| model | +machine | string | -- | Model of this cpu. |
+ optional | +Machine for which this ip should get created. |
|
| cores | -uint32 | -- | Cores of this cpu. |
+ labels | +Labels | +optional | +Labels to put onto the ip. |
| threads | -uint32 | -- | Threads of this cpu. |
+ type | +IPType | +optional | +Type of the IP, ether ephemeral (default), or static. |
+
| address_family | +IPAddressFamily | +optional | +Addressfamily of the IP to create, defaults to ipv4. |
| Field | Type | Label | Description |
| vendor | -string | -- | Vendor of this gpu. |
-
| model | -string | -- | Model of this gpu. |
-
IPProtocol defines tcp|udp.
-| Name | Number | Description |
| IP_PROTOCOL_UNSPECIFIED | -0 | -IP_PROTOCOL_UNSPECIFIED is not specified. |
-
| IP_PROTOCOL_TCP | -1 | -IP_PROTOCOL_TCP is tcp. |
-
| IP_PROTOCOL_UDP | -2 | -IP_PROTOCOL_UDP is udp. |
-
MachineAllocationType defines if this is a machine or a firewall.
-| Name | Number | Description |
| MACHINE_ALLOCATION_TYPE_UNSPECIFIED | -0 | -MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified. |
-
| MACHINE_ALLOCATION_TYPE_MACHINE | -1 | -MACHINE_ALLOCATION_TYPE_MACHINE is a machine. |
-
| MACHINE_ALLOCATION_TYPE_FIREWALL | -2 | -MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall. |
-
MachineBMCCommand defines commands send to the BMC of the machine.
-| Name | Number | Description |
| MACHINE_BMC_COMMAND_UNSPECIFIED | -0 | -MACHINE_BMC_COMMAND_UNSPECIFIED is not defined. |
-
| MACHINE_BMC_COMMAND_ON | -1 | -MACHINE_BMC_COMMAND_ON Power on the machine. |
-
| MACHINE_BMC_COMMAND_OFF | -2 | -MACHINE_BMC_COMMAND_OFF Power off the machine. |
-
| MACHINE_BMC_COMMAND_RESET | -3 | -MACHINE_BMC_COMMAND_RESET Power reset the machine. |
-
| MACHINE_BMC_COMMAND_CYCLE | -4 | -MACHINE_BMC_COMMAND_CYCLE Power cycle the machine. |
-
| MACHINE_BMC_COMMAND_BOOT_TO_BIOS | -5 | -MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios. |
-
| MACHINE_BMC_COMMAND_BOOT_FROM_DISK | -6 | -MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk. |
-
| MACHINE_BMC_COMMAND_BOOT_FROM_PXE | -7 | -MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe. |
-
| MACHINE_BMC_COMMAND_IDENTIFY_LED_ON | -8 | -MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on. |
-
| MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF | -9 | -MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off. |
-
| MACHINE_BMC_COMMAND_MACHINE_DELETED | -10 | -MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe. |
-
| MACHINE_BMC_COMMAND_MACHINE_CREATED | -11 | -MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk. |
-
Ip the ip.
MachineIssueSeverity defines the severity of an issue.
-| Name | Number | Description |
| MACHINE_ISSUE_SEVERITY_UNSPECIFIED | -0 | -MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified. |
-
| MACHINE_ISSUE_SEVERITY_MINOR | -1 | -MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor. |
-
| MACHINE_ISSUE_SEVERITY_MAJOR | -2 | -MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major. |
-
| MACHINE_ISSUE_SEVERITY_CRITICAL | -3 | -MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical. |
-
IPServiceDeleteRequest is the request payload for a ip delete request.
+ + +| Field | Type | Label | Description |
| ip | +string | ++ | IP of the ip to delete. |
+
| project | +string | ++ | Project of the ip. |
+
MachineIssueType defines which type of issue it is.
-| Name | Number | Description |
| MACHINE_ISSUE_TYPE_UNSPECIFIED | -0 | -MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified. |
-
| MACHINE_ISSUE_TYPE_ASN_UNIQUENESS | -1 | -MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique. |
-
| MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED | -2 | -MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date. |
-
| MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP | -3 | -MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct. |
-
| MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP | -4 | -MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip. |
-
| MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC | -5 | -MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address. |
-
| MACHINE_ISSUE_TYPE_CRASH_LOOP | -6 | -MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop. |
-
| MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM | -7 | -MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete. |
-
| MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR | -8 | -MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error. |
-
| MACHINE_ISSUE_TYPE_LIVELINESS_DEAD | -9 | -MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead. |
-
| MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE | -10 | -MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available. |
-
| MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN | -11 | -MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown. |
-
| MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER | -12 | -MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container. |
-
| MACHINE_ISSUE_TYPE_NO_PARTITION | -13 | -MACHINE_ISSUE_TYPE_NO_PARTITION no partition set. |
-
IPServiceDeleteResponse is the response payload for an IP delete request.
+ + +| Field | Type | Label | Description |
| ip | +IP | ++ | Ip the ip. |
+
IPServiceGetRequest is the request payload for an IP get request.
+ + +| Field | Type | Label | Description |
| ip | +string | ++ | IP of the ip to get. |
+
| project | +string | ++ | Project of the ip. |
+
| namespace | +string | +optional | +Namespace can be specified to get the ip of a namespace. |
+
IPServiceGetResponse is the response payload for an IP get request.
+ + +| Field | Type | Label | Description |
| ip | +IP | ++ | Ip the ip. |
+
MachineLiveliness specifies the liveliness of a machine.
-| Name | Number | Description |
| MACHINE_LIVELINESS_UNSPECIFIED | -0 | -MACHINE_LIVELINESS_UNSPECIFIED is not defined. |
-
| MACHINE_LIVELINESS_ALIVE | -1 | -MACHINE_LIVELINESS_ALIVE liveliness is alive. |
-
| MACHINE_LIVELINESS_DEAD | -2 | -MACHINE_LIVELINESS_DEAD liveliness is dead. |
-
| MACHINE_LIVELINESS_UNKNOWN | -3 | -MACHINE_LIVELINESS_UNKNOWN liveliness is unknown. |
-
IPServiceListRequest is the request payload for an IP list request.
+ + +| Field | Type | Label | Description |
| project | +string | ++ | Project of the ips to list. |
+
| query | +IPQuery | ++ | Query to list one or more IPs. |
+
MachineProvisioningEventState possible event states.
-| Name | Number | Description |
| MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED | -0 | -MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified. |
-
| MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP | -1 | -MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop. |
-
| MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM | -2 | -MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim. |
-
IPServiceListResponse is the response payload for an IP list request.
+ + +| Field | Type | Label | Description |
| ips | +IP | +repeated | +Ips the ips. |
+
MachineProvisioningEventType defines in which phase the machine actually is.
-| Name | Number | Description | |||||
| MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED | -0 | -MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified. |
- |||||
| MACHINE_PROVISIONING_EVENT_TYPE_ALIVE | -1 | -MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive. |
- |||||
| MACHINE_PROVISIONING_EVENT_TYPE_CRASHED | -2 | -MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed. |
- |||||
| MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING | -3 | -MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer. |
- |||||
| MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT | -4 | -MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction. |
- |||||
| MACHINE_PROVISIONING_EVENT_TYPE_PREPARING | -5 | -MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine. |
- |||||
| MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING | -6 | -MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver. |
- |||||
| MACHINE_PROVISIONING_EVENT_TYPE_WAITING | -7 | -MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation. |
- |||||
| MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING | -8 | -MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os. |
-
| Field | Type | Label | Description |
| ip | +string | ++ | Ip the ip address to update. |
+
| update_meta | +UpdateMeta | ++ | UpdateMeta contains the timestamp and strategy to be used in this update request. |
+
| project | +string | ++ | Project id of the ip. |
+
| name | +string | +optional | +Name of this ip. |
+
| description | +string | +optional | +Description of this ip. |
+
| type | +IPType | +optional | +Type of this ip. |
+
| labels | +UpdateLabels | +optional | +Labels on this ip. |
+
IPServiceUpdateResponse is the response payload for a ip update request.
+ + +| Field | Type | Label | Description |
| ip | +IP | ++ | Ip the ip. |
+
IPAddressFamily defines either IPv4 or IPv6 Addressfamily.
+| Name | Number | Description | |||
| MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL | -9 | -MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os. |
+ IP_ADDRESS_FAMILY_UNSPECIFIED | +0 | +IP_ADDRESS_FAMILY_UNSPECIFIED is not specified. |
| MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME | -10 | -MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home. |
+ IP_ADDRESS_FAMILY_V4 | +1 | +IP_ADDRESS_FAMILY_V4 defines a IPv4 address. |
| MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM | -11 | -MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home. |
+ IP_ADDRESS_FAMILY_V6 | +2 | +IP_ADDRESS_FAMILY_V6 defines a IPv6 address. |
MachineState defines if the machine was locked or reserved from a operator.
+IPType specifies different IP address types.
| Name | Number | Description | |||||
| MACHINE_STATE_UNSPECIFIED | +IP_TYPE_UNSPECIFIED | 0 | -MACHINE_STATE_UNSPECIFIED is not specified. |
+ IP_TYPE_UNSPECIFIED is not specified. |
|||
| MACHINE_STATE_TAINTED | +IP_TYPE_EPHEMERAL | 1 | -MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uui. |
+ IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage. |
|||
| MACHINE_STATE_LOCKED | +IP_TYPE_STATIC | 2 | -MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or delete. |
- ||||
| MACHINE_STATE_AVAILABLE | -3 | -MACHINE_STATE_AVAILABLE this machine is available for all. |
+ IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly. |
| Method Name | Request Type | Response Type | Description | |||
| Get | -MachineServiceGetRequest | -MachineServiceGetResponse | -Returns the machine with the specified UUID. |
+ IPServiceGetRequest | +IPServiceGetResponse | +Returns the IP address with the specified IP. |
| Create | -MachineServiceCreateRequest | -MachineServiceCreateResponse | -Creates a new machine. |
+ IPServiceCreateRequest | +IPServiceCreateResponse | +Creates a new IP address. |
| Update | -MachineServiceUpdateRequest | -MachineServiceUpdateResponse | -Updates a machine. |
+ IPServiceUpdateRequest | +IPServiceUpdateResponse | +Updates an IP address. |
| List | -MachineServiceListRequest | -MachineServiceListResponse | -Returns the list of all machines. |
+ IPServiceListRequest | +IPServiceListResponse | +Returns the list of all IP addresses. |
| Delete | -MachineServiceDeleteRequest | -MachineServiceDeleteResponse | -Deletes a machine. |
+ IPServiceDeleteRequest | +IPServiceDeleteResponse | +Deletes an IP address. |
| BMCCommand | -MachineServiceBMCCommandRequest | -MachineServiceBMCCommandResponse | -BMCCommand sends a command to the BMC of a machine. |
-
IPServiceListRequest is the request payload for listing IP addresses.
+ + +| Field | Type | Label | Description |
| query | +metalstack.api.v2.IPQuery | ++ | Query to search for IP addresses. |
+
IPServiceListResponse is the response payload for listing IP addresses.
+ + +| Field | Type | Label | Description |
| ips | +metalstack.api.v2.IP | +repeated | +IPs contains the list of IP addresses. |
+
IPService provides IP address management operations.
+| Method Name | Request Type | Response Type | Description | ||||
| GetBMC | -MachineServiceGetBMCRequest | -MachineServiceGetBMCResponse | -Returns the BMC details of a machine. |
+ List | +IPServiceListRequest | +IPServiceListResponse | +Returns the list of all IP addresses. |
| Field | Type | Label | Description |
| id | -uint64 | -- | ID of this node. |
-
| name | -string | -- | Name of this node. |
-
| project | -string | -- | Project of this node, maps to a project. |
-
| ip_addresses | -string | -repeated | -IPAddresses of this node in the VPN. |
-
| last_seen | -google.protobuf.Timestamp | -- | LastSeen timestamp when this node reached out to the control plane. |
-
| online | -bool | -- | Online indicates if this node is online. |
-