Skip to content

lustrefilestorage.oracle.com/v1beta1

Back to API Reference

APIVersion: lustrefilestorage.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 lustrefilestorage.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
LustreFileSystem Namespaced Sample -
ObjectStorageLink Namespaced Sample -

LustreFileSystem

Manage OCI Lustre File Storage file systems.

  • Plural: lustrefilesystems
  • Scope: Namespaced
  • APIVersion: lustrefilestorage.oracle.com/v1beta1
  • Sample: Sample (config/samples/lustrefilestorage_v1beta1_lustrefilesystem.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

LustreFileSystemSpec defines the desired state of LustreFileSystem.

Field Description Type Required Default Enum
availabilityDomain The availability domain the file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1 string Yes - -
capacityInGBs Capacity of the Lustre file system in GB. You can increase capacity only in multiples of 5 TB. integer Yes - -
clusterPlacementGroupId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group in which the Lustre file system exists. string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the Lustre file system. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. 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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My Lustre file system string No - -
fileSystemDescription Short description of the Lustre file system. Avoid entering confidential information. string No - -
fileSystemName The Lustre file system name. This is used in mount commands and other aspects of the client command line interface. The file system name is limited to 8 characters. Allowed characters are lower and upper case English letters, numbers, and '_'. If you have multiple Lustre file systems mounted on the same clients, this name can help distinguish them. string Yes - -
freeformTags Free-form tags for this resource. 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 - -
kmsKeyId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KMS key used to encrypt the encryption keys associated with this file system. string No - -
maintenanceWindow LustreFileSystemMaintenanceWindow defines nested fields for LustreFileSystem.MaintenanceWindow. object No - -
nsgIds A list of Network Security Group OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this lustre file system. A maximum of 5 is allowed. Setting this to an empty array after the list is created removes the lustre file system from all NSGs. For more information about NSGs, see Security Rules (https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). list[string] No - -
performanceTier The Lustre file system performance tier. A value of MBPS_PER_TB_125 represents 125 megabytes per second per terabyte. string Yes - -
rootSquashConfiguration LustreFileSystemRootSquashConfiguration defines nested fields for LustreFileSystem.RootSquashConfiguration. object Yes - -
subnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the Lustre file system is in. string Yes - -

Spec.maintenanceWindow

Back to LustreFileSystem spec

LustreFileSystemMaintenanceWindow defines nested fields for LustreFileSystem.MaintenanceWindow.

Field Description Type Required Default Enum
dayOfWeek Day of the week when the maintainence window starts. string No - -
timeStart The time to start the maintenance window. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: 22:00 string No - -

Spec.rootSquashConfiguration

Back to LustreFileSystem spec

LustreFileSystemRootSquashConfiguration defines nested fields for LustreFileSystem.RootSquashConfiguration.

Field Description Type Required Default Enum
clientExceptions A list of NIDs allowed with this lustre file system not to be squashed. A maximum of 10 is allowed. list[string] No - -
identitySquash Used when clients accessing the Lustre file system have their UID and GID remapped to squashUid and squashGid. If ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to NONE. string No - -
squashGid The GID value to remap to when squashing a client GID. See identitySquash for more details. If unspecified, defaults to 65534. integer (int64) No - -
squashUid The UID value to remap to when squashing a client UID. See identitySquash for more details. If unspecified, defaults to 65534. integer (int64) No - -

Status

LustreFileSystemStatus defines the observed state of LustreFileSystem.

Field Description Type Required Default Enum
availabilityDomain The availability domain the file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1 string No - -
capacityInGBs Capacity of the Lustre file system in GB. integer No - -
clusterPlacementGroupId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group in which the Lustre file system exists. string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the Lustre file system. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. 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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My Lustre file system string No - -
fileSystemDescription Short description of the Lustre file system. Avoid entering confidential information. string No - -
fileSystemName The Lustre file system name. This is used in mount commands and other aspects of the client command line interface. The default file system name is 'lustre'. The file system name is limited to 8 characters. Allowed characters are lower and upper case English letters, numbers, and '_'. string No - -
freeformTags Free-form tags for this resource. 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 (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Lustre file system. string No - -
kmsKeyId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KMS key used to encrypt the encryption keys associated with this file system. string No - -
lifecycleDetails A message that describes the current state of the Lustre file system in more detail. For example, can be used to provide actionable information for a resource in the Failed state. string No - -
lifecycleState The current state of the Lustre file system. string No - -
lnet Type of network used by clients to mount the file system. Example: tcp string No - -
maintenanceWindow LustreFileSystemMaintenanceWindow defines nested fields for LustreFileSystem.MaintenanceWindow. object No - -
maintenanceWindowMetadata LustreFileSystemMaintenanceWindowMetadata defines nested fields for LustreFileSystem.MaintenanceWindowMetadata. object No - -
majorVersion Major version of Lustre running in the Lustre file system. Example: 2.15 string No - -
managementServiceAddress The IPv4 address of MGS (Lustre Management Service) used by clients to mount the file system. For example '10.0.0.4'. string No - -
nsgIds A list of Network Security Group OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this lustre file system. A maximum of 5 is allowed. Setting this to an empty array after the list is created removes the lustre file system from all NSGs. For more information about NSGs, see Security Rules (https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). list[string] No - -
performanceTier The Lustre file system performance tier. A value of MBPS_PER_TB_125 represents 125 megabytes per second per terabyte. string No - -
rootSquashConfiguration LustreFileSystemRootSquashConfiguration defines nested fields for LustreFileSystem.RootSquashConfiguration. object No - -
status - object Yes - -
subnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the Lustre file system is in. string No - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeBillingCycleEnd The date and time that the current billing cycle for the file system will end, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. After the current cycle ends, this date is updated automatically to the next timestamp, which is 30 days later. File systems deleted earlier than this time will still incur charges until the billing cycle ends. Example: 2016-08-25T21:10:29.600Z string No - -
timeCreated The date and time the Lustre file system was created, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2024-04-25T21:10:29.600Z string No - -
timeUpdated The date and time the Lustre file system was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2024-04-25T21:10:29.600Z string No - -

Status.maintenanceWindow

Back to LustreFileSystem status

LustreFileSystemMaintenanceWindow defines nested fields for LustreFileSystem.MaintenanceWindow.

Field Description Type Required Default Enum
dayOfWeek Day of the week when the maintainence window starts. string No - -
timeStart The time to start the maintenance window. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: 22:00 string No - -

Status.maintenanceWindowMetadata

Back to LustreFileSystem status

LustreFileSystemMaintenanceWindowMetadata defines nested fields for LustreFileSystem.MaintenanceWindowMetadata.

Field Description Type Required Default Enum
activeOrNextPlannedMaintenance LustreFileSystemMaintenanceWindowMetadataActiveOrNextPlannedMaintenance defines nested fields for LustreFileSystem.MaintenanceWindowMetadata.ActiveOrNextPlannedMaintenance. object No - -
finishedMaintenance LustreFileSystemMaintenanceWindowMetadataFinishedMaintenance defines nested fields for LustreFileSystem.MaintenanceWindowMetadata.FinishedMaintenance. object No - -
isMaintenanceInProgress whether or not an active maintenance is going on for the LustreFileSystem boolean No - -

Status.maintenanceWindowMetadata.activeOrNextPlannedMaintenance

Back to LustreFileSystem status

LustreFileSystemMaintenanceWindowMetadataActiveOrNextPlannedMaintenance defines nested fields for LustreFileSystem.MaintenanceWindowMetadata.ActiveOrNextPlannedMaintenance.

Field Description Type Required Default Enum
date A user-friendly date. Example: 2025-04-25 string No - -
time A user-friendly time. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: 22:00 string No - -

Status.maintenanceWindowMetadata.finishedMaintenance

Back to LustreFileSystem status

LustreFileSystemMaintenanceWindowMetadataFinishedMaintenance defines nested fields for LustreFileSystem.MaintenanceWindowMetadata.FinishedMaintenance.

Field Description Type Required Default Enum
date A user-friendly date. Example: 2025-04-25 string No - -
time A user-friendly time. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: 22:00 string No - -

Status.rootSquashConfiguration

Back to LustreFileSystem status

LustreFileSystemRootSquashConfiguration defines nested fields for LustreFileSystem.RootSquashConfiguration.

Field Description Type Required Default Enum
clientExceptions A list of NIDs allowed with this lustre file system not to be squashed. A maximum of 10 is allowed. list[string] No - -
identitySquash Used when clients accessing the Lustre file system have their UID and GID remapped to squashUid and squashGid. If ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to NONE. string No - -
squashGid The GID value to remap to when squashing a client GID. See identitySquash for more details. If unspecified, defaults to 65534. integer (int64) No - -
squashUid The UID value to remap to when squashing a client UID. See identitySquash for more details. If unspecified, defaults to 65534. integer (int64) No - -

Status.status

Back to LustreFileSystem 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 LustreFileSystem 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 LustreFileSystem 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 LustreFileSystem status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Manage OCI Lustre File Storage object storage links.

  • Plural: objectstoragelinks
  • Scope: Namespaced
  • APIVersion: lustrefilestorage.oracle.com/v1beta1
  • Sample: Sample (config/samples/lustrefilestorage_v1beta1_objectstoragelink.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ObjectStorageLinkSpec defines the desired state of ObjectStorageLink.

Field Description Type Required Default Enum
availabilityDomain The availability domain that the Lustre file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1 string Yes - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the Object Storage link. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. 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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My Object Storage Link string No - -
fileSystemPath The path in the Lustre file system used for this Object Storage link. Example: myFileSystem/mount/myDirectory string Yes - -
freeformTags Free-form tags for this resource. 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 - -
isOverwrite The flag is an identifier to tell whether the job run has overwrite enabled. If isOverwrite is false, the file to be imported or exported will be skipped if it already exists. If isOverwrite is true, the file to be imported or exported will be overwritten if it already exists. boolean Yes - -
lustreFileSystemId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated Lustre file system. string Yes - -
objectStoragePrefix The Object Storage namespace and bucket name, including optional object prefix string, to use as the source for imports or destination for exports. Example: objectStorageNamespace:/bucketName/optionalFolder/optionalPrefix string Yes - -

Status

ObjectStorageLinkStatus defines the observed state of ObjectStorageLink.

Field Description Type Required Default Enum
availabilityDomain The availability domain the file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1 string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the Lustre file system. string No - -
currentJobId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of currently running sync job. If no sync job is running, then this will be empty. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. 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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My Object Storage Link string No - -
fileSystemPath The path in the Lustre file system used for this Object Storage link. Example: myFileSystem/mount/myDirectory string No - -
freeformTags Free-form tags for this resource. 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 (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ObjectStorageLink. string No - -
isOverwrite The flag is an identifier to tell whether the job run has overwrite enabled. If isOverwrite is false, the file to be imported or exported will be skipped if it already exists. If isOverwrite is true, the file to be imported or exported will be overwritten if it already exists. boolean No - -
lastJobId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of last succeeded sync job. If no sync job has previously run, then this will be empty. string No - -
lifecycleDetails A message that describes the current state of the Object Storage link in more detail. For example, can be used to provide actionable information for a resource in the Failed state. string No - -
lifecycleState The current state of the Object Storage link. string No - -
lustreFileSystemId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated Lustre file system. string No - -
objectStoragePrefix The Object Storage namespace and bucket name, including optional object prefix string, to use as the source for imports or destination for exports. Example: objectStorageNamespace:/bucketName/optionalFolder/optionalPrefix string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The date and time the Lustre file system was created, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2024-04-25T21:10:29.600Z string No - -
timeUpdated The date and time the Object Storage link was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2024-04-25T21:10:29.600Z string No - -

Status.status

Back to ObjectStorageLink 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 ObjectStorageLink 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 ObjectStorageLink 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 ObjectStorageLink status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -