rover.oracle.com/v1beta1
Back to API Reference
APIVersion: rover.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages
No customer-visible package currently exposes rover.oracle.com/v1beta1.
Resources
RoverCluster
Manage OCI Rover clusters.
Plural: roverclustersScope: NamespacedAPIVersion: rover.oracle.com/v1beta1Sample: Sample (config/samples/rover_v1beta1_rovercluster.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
RoverClusterSpec defines the desired state of RoverCluster.
| Field |
Description |
Type |
Required |
Default |
Enum |
clusterSize |
Number of nodes desired in the cluster, in standalone clusters, between 5 and 15 inclusive. In station clusters, between 15 and 30 inclusive. |
integer |
Yes |
- |
- |
clusterType |
Type of cluster. |
string |
No |
- |
- |
clusterWorkloads |
List of existing workloads that should be provisioned on the nodes. |
list[object] |
No |
- |
- |
compartmentId |
The OCID of the compartment containing the RoverCluster. |
string |
Yes |
- |
- |
customerShippingAddress |
RoverClusterCustomerShippingAddress defines nested fields for RoverCluster.CustomerShippingAddress. |
object |
No |
- |
- |
dataValidationCode |
Validation code returned by data validation tool. Required for return shipping label generation if data import was requested. |
string |
No |
- |
- |
definedTags |
The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
string |
Yes |
- |
- |
enclosureType |
The type of enclosure rover nodes in this cluster are shipped in. |
string |
No |
- |
- |
freeformTags |
The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
importCompartmentId |
An OCID of a compartment where data will be imported to upon Rover cluster return. |
string |
No |
- |
- |
importFileBucket |
Name of a bucket where files from NFS share will be imported to upon Rover cluster return. |
string |
No |
- |
- |
isImportRequested |
The flag indicating that customer requests data to be imported to OCI upon Rover cluster return. |
boolean |
No |
- |
- |
lifecycleState |
The current state of the RoverCluster. |
string |
No |
- |
- |
lifecycleStateDetails |
A property that can contain details on the lifecycle. |
string |
No |
- |
- |
masterKeyId |
Customer provided master key ID to encrypt secret information. If not provided, Rover's master key will be used for encryption. |
string |
No |
- |
- |
oracleShippingTrackingUrl |
Tracking Url for the shipped Rover Cluster. |
string |
No |
- |
- |
pointOfContact |
Name of point of contact for this order if customer is picking up. |
string |
No |
- |
- |
pointOfContactPhoneNumber |
Phone number of point of contact for this order if customer is picking up. |
string |
No |
- |
- |
shippingPreference |
Preference for device delivery. |
string |
No |
- |
- |
shippingVendor |
Shipping vendor of choice for orace to customer shipping. |
string |
No |
- |
- |
subscriptionId |
ID provided to customer after successful subscription to Rover Stations. |
string |
No |
- |
- |
superUserPassword |
Root password for the rover cluster. |
string |
No |
- |
- |
systemTags |
The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {orcl-cloud: {free-tier-retain: true}} |
map[string, map[string, string]] |
No |
- |
- |
timePickupExpected |
Expected date when customer wants to pickup the cluster if they chose customer pickup. |
string |
No |
- |
- |
unlockPassphrase |
Password to unlock the rover cluster. |
string |
No |
- |
- |
Spec.clusterWorkloads[]
Back to RoverCluster spec
RoverClusterClusterWorkload defines nested fields for RoverCluster.ClusterWorkload.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment containing the workload. |
string |
Yes |
- |
- |
id |
The Unique Oracle ID (OCID) that is immutable on creation. |
string |
Yes |
- |
- |
name |
Name of the Rover Workload |
string |
No |
- |
- |
objectCount |
Number of objects in a workload. |
string |
No |
- |
- |
prefix |
Prefix to filter objects in case it is a bucket. |
string |
No |
- |
- |
rangeEnd |
End of the range in a bucket. |
string |
No |
- |
- |
rangeStart |
Start of the range in a bucket. |
string |
No |
- |
- |
size |
Size of the workload. |
string |
No |
- |
- |
workRequestId |
The compute work request id to track progress of custom image exports. |
string |
No |
- |
- |
workloadType |
The type of workload |
string |
Yes |
- |
- |
Spec.customerShippingAddress
Back to RoverCluster spec
RoverClusterCustomerShippingAddress defines nested fields for RoverCluster.CustomerShippingAddress.
| Field |
Description |
Type |
Required |
Default |
Enum |
address1 |
Address line 1. |
string |
Yes |
- |
- |
address2 |
Address line 2. |
string |
No |
- |
- |
address3 |
Address line 3. |
string |
No |
- |
- |
address4 |
Address line 4. |
string |
No |
- |
- |
addressee |
Addressee in shipping address. |
string |
Yes |
- |
- |
careOf |
CareOf for shipping address. |
string |
No |
- |
- |
cityOrLocality |
city or locality for shipping address. |
string |
Yes |
- |
- |
country |
country for shipping address. |
string |
Yes |
- |
- |
email |
recipient email address. |
string |
No |
- |
- |
phoneNumber |
recipient phone number. |
string |
Yes |
- |
- |
stateOrRegion |
state or region for shipping address. |
string |
Yes |
- |
- |
zipcode |
zipcode for shipping address. |
string |
Yes |
- |
- |
Status
RoverClusterStatus defines the observed state of RoverCluster.
| Field |
Description |
Type |
Required |
Default |
Enum |
clusterSize |
Size of the cluster. |
integer |
No |
- |
- |
clusterType |
Type of cluster. |
string |
No |
- |
- |
clusterWorkloads |
List of existing workloads that should be provisioned on the nodes. |
list[object] |
No |
- |
- |
compartmentId |
The OCID of the compartment containing the RoverCluster. |
string |
No |
- |
- |
customerShippingAddress |
RoverClusterCustomerShippingAddress defines nested fields for RoverCluster.CustomerShippingAddress. |
object |
No |
- |
- |
definedTags |
The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
deliveryTrackingInfo |
Tracking information for device shipping. |
string |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
string |
No |
- |
- |
enclosureType |
The type of enclosure rover nodes in this cluster are shipped in. |
string |
No |
- |
- |
freeformTags |
The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
id |
The OCID of RoverCluster. |
string |
No |
- |
- |
importCompartmentId |
An OCID of a compartment where data will be imported to upon Rover cluster return. |
string |
No |
- |
- |
importFileBucket |
Name of a bucket where files from NFS share will be imported to upon Rover cluster return. |
string |
No |
- |
- |
isImportRequested |
The flag indicating that customer requests data to be imported to OCI upon Rover cluster return. |
boolean |
No |
- |
- |
lifecycleState |
The current state of the RoverCluster. |
string |
No |
- |
- |
lifecycleStateDetails |
A property that can contain details on the lifecycle. |
string |
No |
- |
- |
masterKeyId |
Customer provided master key ID to encrypt secret information. If not provided, Rover's master key will be used for encryption. |
string |
No |
- |
- |
nodes |
The summary of nodes that are part of this cluster. |
list[object] |
No |
- |
- |
oracleShippingTrackingUrl |
Tracking Url for the shipped Rover Cluster. |
string |
No |
- |
- |
pointOfContact |
Name of point of contact for this order if customer is picking up. |
string |
No |
- |
- |
pointOfContactPhoneNumber |
Phone number of point of contact for this order if customer is picking up. |
string |
No |
- |
- |
shippingPreference |
Preference for device delivery. |
string |
No |
- |
- |
shippingVendor |
Shipping vendor of choice for orace to customer shipping. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
subscriptionId |
ID provided to customer after successful subscription to Rover Stations. |
string |
No |
- |
- |
systemTags |
The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {orcl-cloud: {free-tier-retain: true}} |
map[string, map[string, string]] |
No |
- |
- |
tags |
The tags associated with tagSlug. |
string |
No |
- |
- |
timeCreated |
The time the the RoverCluster was created. An RFC3339 formatted datetime string |
string |
No |
- |
- |
timeCustomerReceived |
Time when customer received the cluster. |
string |
No |
- |
- |
timeCustomerReturned |
Time when customer returned the cluster. |
string |
No |
- |
- |
timePickupExpected |
Expected date when customer wants to pickup the device if they chose customer pickup. |
string |
No |
- |
- |
timeReturnWindowEnds |
End time for the window to pickup the device from customer. |
string |
No |
- |
- |
timeReturnWindowStarts |
Start time for the window to pickup the device from customer. |
string |
No |
- |
- |
Status.clusterWorkloads[]
Back to RoverCluster status
RoverClusterClusterWorkload defines nested fields for RoverCluster.ClusterWorkload.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment containing the workload. |
string |
Yes |
- |
- |
id |
The Unique Oracle ID (OCID) that is immutable on creation. |
string |
Yes |
- |
- |
name |
Name of the Rover Workload |
string |
No |
- |
- |
objectCount |
Number of objects in a workload. |
string |
No |
- |
- |
prefix |
Prefix to filter objects in case it is a bucket. |
string |
No |
- |
- |
rangeEnd |
End of the range in a bucket. |
string |
No |
- |
- |
rangeStart |
Start of the range in a bucket. |
string |
No |
- |
- |
size |
Size of the workload. |
string |
No |
- |
- |
workRequestId |
The compute work request id to track progress of custom image exports. |
string |
No |
- |
- |
workloadType |
The type of workload |
string |
Yes |
- |
- |
Status.customerShippingAddress
Back to RoverCluster status
RoverClusterCustomerShippingAddress defines nested fields for RoverCluster.CustomerShippingAddress.
| Field |
Description |
Type |
Required |
Default |
Enum |
address1 |
Address line 1. |
string |
Yes |
- |
- |
address2 |
Address line 2. |
string |
No |
- |
- |
address3 |
Address line 3. |
string |
No |
- |
- |
address4 |
Address line 4. |
string |
No |
- |
- |
addressee |
Addressee in shipping address. |
string |
Yes |
- |
- |
careOf |
CareOf for shipping address. |
string |
No |
- |
- |
cityOrLocality |
city or locality for shipping address. |
string |
Yes |
- |
- |
country |
country for shipping address. |
string |
Yes |
- |
- |
email |
recipient email address. |
string |
No |
- |
- |
phoneNumber |
recipient phone number. |
string |
Yes |
- |
- |
stateOrRegion |
state or region for shipping address. |
string |
Yes |
- |
- |
zipcode |
zipcode for shipping address. |
string |
Yes |
- |
- |
Status.nodes[]
Back to RoverCluster status
RoverClusterNode defines nested fields for RoverCluster.Node.
| Field |
Description |
Type |
Required |
Default |
Enum |
clusterId |
The cluster ID if the node is part of a cluster. |
string |
No |
- |
- |
compartmentId |
The OCID of the compartment containing the RoverNode. |
string |
No |
- |
- |
definedTags |
The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
string |
No |
- |
- |
freeformTags |
The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
id |
The OCID of the RoverNode. |
string |
No |
- |
- |
lifecycleState |
The current state of the RoverNode. |
string |
No |
- |
- |
lifecycleStateDetails |
A property that can contain details on the lifecycle. |
string |
No |
- |
- |
nodeType |
The type of node indicating if it belongs to a cluster |
string |
No |
- |
- |
serialNumber |
Serial number of the node. |
string |
No |
- |
- |
shape |
The shape of the node. |
string |
No |
- |
- |
systemTags |
The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {orcl-cloud: {free-tier-retain: true}} |
map[string, map[string, string]] |
No |
- |
- |
timeCreated |
The time the the RoverNode was created. An RFC3339 formatted datetime string |
string |
No |
- |
- |
Status.status
Back to RoverCluster status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to RoverCluster status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to RoverCluster status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to RoverCluster status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
RoverNode
Manage OCI Rover nodes.
Plural: rovernodesScope: NamespacedAPIVersion: rover.oracle.com/v1beta1Sample: Sample (config/samples/rover_v1beta1_rovernode.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
RoverNodeSpec defines the desired state of RoverNode.
| Field |
Description |
Type |
Required |
Default |
Enum |
certCompartmentId |
The compartmentId of the leaf certificate. |
string |
No |
- |
- |
certKeyAlgorithm |
key algorithm for issuing leaf certificate. |
string |
No |
- |
- |
certSignatureAlgorithm |
signature algorithm for issuing leaf certificate. |
string |
No |
- |
- |
certificateAuthorityId |
The certificateAuthorityId of subordinate/intermediate certificate authority. |
string |
No |
- |
- |
commonName |
The common name for the leaf certificate. |
string |
No |
- |
- |
compartmentId |
The OCID of the compartment containing the RoverNode. |
string |
Yes |
- |
- |
customerShippingAddress |
RoverNodeCustomerShippingAddress defines nested fields for RoverNode.CustomerShippingAddress. |
object |
No |
- |
- |
dataValidationCode |
Validation code returned by data validation tool. Required for return shipping label generation if data import was requested. |
string |
No |
- |
- |
definedTags |
The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
string |
Yes |
- |
- |
enclosureType |
The type of enclosure rover nodes in this cluster are shipped in. |
string |
No |
- |
- |
freeformTags |
The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
importCompartmentId |
An OCID of a compartment where data will be imported to upon Rover node return. |
string |
No |
- |
- |
importFileBucket |
Name of a bucket where files from NFS share will be imported to upon Rover node return. |
string |
No |
- |
- |
isImportRequested |
The flag indicating that customer requests data to be imported to OCI upon Rover node return. |
boolean |
No |
- |
- |
lifecycleState |
The current state of the RoverNode. |
string |
No |
- |
- |
lifecycleStateDetails |
A property that can contain details on the lifecycle. |
string |
No |
- |
- |
masterKeyId |
Customer provided master key ID to encrypt secret information. If not provided, Rover's master key will be used for encryption. |
string |
No |
- |
- |
nodeWorkloads |
List of existing workloads that should be provisioned on the node. |
list[object] |
No |
- |
- |
oracleShippingTrackingUrl |
Tracking Url for the shipped FmsRoverNode. |
string |
No |
- |
- |
pointOfContact |
Name of point of contact for this order if customer is picking up. |
string |
No |
- |
- |
pointOfContactPhoneNumber |
Phone number of point of contact for this order if customer is picking up. |
string |
No |
- |
- |
publicKey |
The public key of the resource principal |
string |
No |
- |
- |
serialNumber |
Serial number of the node. |
string |
No |
- |
- |
shape |
The shape of the node. |
string |
No |
- |
- |
shippingPreference |
Preference for device delivery. |
string |
No |
- |
- |
shippingVendor |
Shipping vendor of choice for orace to customer shipping. |
string |
No |
- |
- |
superUserPassword |
Root password for the rover node. |
string |
No |
- |
- |
systemTags |
The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {orcl-cloud: {free-tier-retain: true}} |
map[string, map[string, string]] |
No |
- |
- |
timeCertValidityEnd |
The time after which leaf certificate will invalid. |
string |
No |
- |
- |
timePickupExpected |
Expected date when customer wants to pickup the device if they chose customer pickup. |
string |
No |
- |
- |
timeReturnWindowEnds |
End time for the window to pickup the device from customer. |
string |
No |
- |
- |
timeReturnWindowStarts |
Start time for the window to pickup the device from customer. |
string |
No |
- |
- |
unlockPassphrase |
Passphrase to unlock the rover node. |
string |
No |
- |
- |
Spec.customerShippingAddress
Back to RoverNode spec
RoverNodeCustomerShippingAddress defines nested fields for RoverNode.CustomerShippingAddress.
| Field |
Description |
Type |
Required |
Default |
Enum |
address1 |
Address line 1. |
string |
Yes |
- |
- |
address2 |
Address line 2. |
string |
No |
- |
- |
address3 |
Address line 3. |
string |
No |
- |
- |
address4 |
Address line 4. |
string |
No |
- |
- |
addressee |
Addressee in shipping address. |
string |
Yes |
- |
- |
careOf |
CareOf for shipping address. |
string |
No |
- |
- |
cityOrLocality |
city or locality for shipping address. |
string |
Yes |
- |
- |
country |
country for shipping address. |
string |
Yes |
- |
- |
email |
recipient email address. |
string |
No |
- |
- |
phoneNumber |
recipient phone number. |
string |
Yes |
- |
- |
stateOrRegion |
state or region for shipping address. |
string |
Yes |
- |
- |
zipcode |
zipcode for shipping address. |
string |
Yes |
- |
- |
Spec.nodeWorkloads[]
Back to RoverNode spec
RoverNodeNodeWorkload defines nested fields for RoverNode.NodeWorkload.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment containing the workload. |
string |
Yes |
- |
- |
id |
The Unique Oracle ID (OCID) that is immutable on creation. |
string |
Yes |
- |
- |
name |
Name of the Rover Workload |
string |
No |
- |
- |
objectCount |
Number of objects in a workload. |
string |
No |
- |
- |
prefix |
Prefix to filter objects in case it is a bucket. |
string |
No |
- |
- |
rangeEnd |
End of the range in a bucket. |
string |
No |
- |
- |
rangeStart |
Start of the range in a bucket. |
string |
No |
- |
- |
size |
Size of the workload. |
string |
No |
- |
- |
workRequestId |
The compute work request id to track progress of custom image exports. |
string |
No |
- |
- |
workloadType |
The type of workload |
string |
Yes |
- |
- |
Status
RoverNodeStatus defines the observed state of RoverNode.
| Field |
Description |
Type |
Required |
Default |
Enum |
certCompartmentId |
The compartmentId of the leaf certificate. |
string |
No |
- |
- |
certKeyAlgorithm |
key algorithm for issuing leaf certificate. |
string |
No |
- |
- |
certSignatureAlgorithm |
signature algorithm for issuing leaf certificate. |
string |
No |
- |
- |
certificateAuthorityId |
The certificateAuthorityId of subordinate/intermediate certificate authority. |
string |
No |
- |
- |
certificateId |
The id of the leaf certificate. |
string |
No |
- |
- |
certificateVersionNumber |
The version number of the leaf certificate. |
string |
No |
- |
- |
clusterId |
The cluster ID if the node is part of a cluster. |
string |
No |
- |
- |
commonName |
The common name for the leaf certificate. |
string |
No |
- |
- |
compartmentId |
The OCID of the compartment containing the RoverNode. |
string |
No |
- |
- |
customerShippingAddress |
RoverNodeCustomerShippingAddress defines nested fields for RoverNode.CustomerShippingAddress. |
object |
No |
- |
- |
definedTags |
The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
deliveryTrackingInfo |
Tracking information for device shipping. |
string |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
string |
No |
- |
- |
enclosureType |
The type of enclosure rover node is shipped in. |
string |
No |
- |
- |
freeformTags |
The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
id |
The OCID of RoverNode. |
string |
No |
- |
- |
importCompartmentId |
An OCID of a compartment where data will be imported to upon Rover node return. |
string |
No |
- |
- |
importFileBucket |
Name of a bucket where files from NFS share will be imported to upon Rover node return. |
string |
No |
- |
- |
isImportRequested |
The flag indicating that customer requests data to be imported to OCI upon Rover node return. |
boolean |
No |
- |
- |
lifecycleState |
The current state of the RoverNode. |
string |
No |
- |
- |
lifecycleStateDetails |
A property that can contain details on the lifecycle. |
string |
No |
- |
- |
masterKeyId |
Customer provided master key ID to encrypt secret information. If not provided, Rover's master key will be used for encryption. |
string |
No |
- |
- |
nodeType |
The type of node indicating if it belongs to a cluster |
string |
No |
- |
- |
nodeWorkloads |
List of existing workloads that should be provisioned on the node. |
list[object] |
No |
- |
- |
oracleShippingTrackingUrl |
Tracking Url for the shipped RoverNode. |
string |
No |
- |
- |
pointOfContact |
Name of point of contact for this order if customer is picking up. |
string |
No |
- |
- |
pointOfContactPhoneNumber |
Phone number of point of contact for this order if customer is picking up. |
string |
No |
- |
- |
publicKey |
The public key of the resource principal |
string |
No |
- |
- |
serialNumber |
Serial number of the node. |
string |
No |
- |
- |
shape |
The shape of the node. |
string |
No |
- |
- |
shippingPreference |
Preference for device delivery. |
string |
No |
- |
- |
shippingVendor |
Shipping vendor of choice for orace to customer shipping. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
systemTags |
The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {orcl-cloud: {free-tier-retain: true}} |
map[string, map[string, string]] |
No |
- |
- |
tags |
The tags associated with tagSlug. |
string |
No |
- |
- |
timeCertValidityEnd |
The time after which leaf certificate will invalid. |
string |
No |
- |
- |
timeCreated |
The time the the RoverNode was created. An RFC3339 formatted datetime string |
string |
No |
- |
- |
timeCustomerReceieved |
Date and time when customer received tne node. |
string |
No |
- |
- |
timeCustomerReturned |
Date and time when customer returned the node. |
string |
No |
- |
- |
timePickupExpected |
Expected date when customer wants to pickup the device if they chose customer pickup. |
string |
No |
- |
- |
timeReturnWindowEnds |
End time for the window to pickup the device from customer. |
string |
No |
- |
- |
timeReturnWindowStarts |
Start time for the window to pickup the device from customer. |
string |
No |
- |
- |
Status.customerShippingAddress
Back to RoverNode status
RoverNodeCustomerShippingAddress defines nested fields for RoverNode.CustomerShippingAddress.
| Field |
Description |
Type |
Required |
Default |
Enum |
address1 |
Address line 1. |
string |
Yes |
- |
- |
address2 |
Address line 2. |
string |
No |
- |
- |
address3 |
Address line 3. |
string |
No |
- |
- |
address4 |
Address line 4. |
string |
No |
- |
- |
addressee |
Addressee in shipping address. |
string |
Yes |
- |
- |
careOf |
CareOf for shipping address. |
string |
No |
- |
- |
cityOrLocality |
city or locality for shipping address. |
string |
Yes |
- |
- |
country |
country for shipping address. |
string |
Yes |
- |
- |
email |
recipient email address. |
string |
No |
- |
- |
phoneNumber |
recipient phone number. |
string |
Yes |
- |
- |
stateOrRegion |
state or region for shipping address. |
string |
Yes |
- |
- |
zipcode |
zipcode for shipping address. |
string |
Yes |
- |
- |
Status.nodeWorkloads[]
Back to RoverNode status
RoverNodeNodeWorkload defines nested fields for RoverNode.NodeWorkload.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment containing the workload. |
string |
Yes |
- |
- |
id |
The Unique Oracle ID (OCID) that is immutable on creation. |
string |
Yes |
- |
- |
name |
Name of the Rover Workload |
string |
No |
- |
- |
objectCount |
Number of objects in a workload. |
string |
No |
- |
- |
prefix |
Prefix to filter objects in case it is a bucket. |
string |
No |
- |
- |
rangeEnd |
End of the range in a bucket. |
string |
No |
- |
- |
rangeStart |
Start of the range in a bucket. |
string |
No |
- |
- |
size |
Size of the workload. |
string |
No |
- |
- |
workRequestId |
The compute work request id to track progress of custom image exports. |
string |
No |
- |
- |
workloadType |
The type of workload |
string |
Yes |
- |
- |
Status.status
Back to RoverNode status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to RoverNode status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to RoverNode status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to RoverNode status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |