Oracle Cloud Infrastructure Documentation

Creating a File System

Create a File Storage with Lustre file system.

Prerequisites

Before you create a Lustre file system, ensure that the following prerequisites are met:

  • To create a file system, follow these steps:

    1. On the Lustre file systems list page, select Create. If you need help finding the list page, see Listing File Systems.
    2. Under General information, enter the following details:
      • File system name: Accept the default name or enter a friendly name for the file system. Avoid entering confidential information.
      • Mount name: Accept the default or enter a friendly name for use when mounting the file system. Lustre clients will use this name to reference the file system when mounting. Avoid entering confidential information.
      • File system description: Enter a description for the file system. Avoid entering confidential information.
      • Compartment: Accept the default compartment or select the list to change compartments.
    3. Under Tags: (Optional) Add one or more tags. If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.
    4. Under Placement, enter the following details:
      • Availability domain: Accept the default AD or select the list to change availability domains.
      • Cluster placement group: We recommend selecting a cluster placement group to physically place file systems and other resources together in an availability domain to ensure low latency. The cluster placement group can't be changed after the file system is created. For more information, see Cluster Placement Groups
    5. Under Performance and Capacity, enter the following details:
      • Performance tier: Select the performance tier for the file system. The performance tier controls the throughput of the file system. Throughput is specified per tebibyte (TiB) of provisioned storage. The performance tier can't be changed after the file system is created.
      • Capacity: Select the storage capacity of the file system. If you select a capacity larger than the service limit, you might be prompted to request an increase. For more information, see Increasing File System Capacity.

        The Aggregate throughput of the file system is calculated from the performance tier and capacity.

    6. Under Networking, enter the following details:
      • Virtual cloud network compartment: The compartment containing the cloud network (VCN) in which to create the mount target.
      • Virtual cloud network: Select the cloud network (VCN) where you want to create the new mount target.
      • Subnet compartment: Specify the compartment containing a subnet within the VCN to attach the mount target to.
      • Subnet: Select a subnet to attach the mount target to. Subnets can be either AD-specific or regional (regional ones have "regional" after the name).
      • Use network security groups to control traffic: Turn on this option to add this mount target to an existing NSG. Select an NSG from the list. For more information, see Network Security Groups.
      Note

      We recommend mounting the file system in the VCN and subnet where your workloads are running. By default, the Console shows a list of VCNs and subnets in the compartment you're working in.
    7. Under Root squash, define settings that control whether clients accessing the file system have their User ID (UID) and Group ID (GID) remapped to Squash UID and Squash GID. If you're squashing the root user, you can provide root squash exceptions to exclude specific clients from the squash configuration. Enter the Client address that you want to exclude as a valid IP address or range. For example, 10.0.2.4 or 10.0.[2-10].[1-255]. You can add up to 10 exceptions.
        • Squash: Select None or Root. The default value is None, so no remapping is done by default.
        • Squash UID: If Squash is set to Root, the root user (UID 0) is remapped to this value. The default value is 65534.
        • Squash GID: If Squash is set to Root, the root group user (GID 0) is remapped to this value. The default value is 65534.
    8. Under Encryption key, select one of these options:
      • Encrypt using Oracle-managed keys: By default, file systems use Oracle-managed keys, which leaves all encryption-related matters to Oracle.
      • Encrypt using customer-managed keys: Optionally, you can encrypt the data in this file system using your own Vault encryption key.
    9. Optionally, turn on Add maintenance schedule to specify the day of the week and start time when Oracle might conduct maintenance on this file system.
      Select a day and time that works best for your business operations, because maintenance can potentially impact performance and, in rare cases, system availability.
      If you don't specify a maintenance schedule, the system assigns it for you. See Finding a File System's Maintenance Schedule.
    10. Optionally, you can sync the file system with Object Storage. To do this, turn on Add Object Storage link and then create a link between Lustre and Object Storage.
    11. Select Create or Save as stack.

  • Use the oci lfs lustre-file-system create command and required parameters to create a file system:

    oci lfs lustre-file-system create [OPTIONS]
    Note

    If you plan to specify a maintenance schedule when creating the file system, you must first use the command oci lfs available-maintenance-schedule-start-time-collection list-available-maintenance-schedule-start-times [OPTIONS] to get the list of the available maintenance days of the week and start times. You then pass the selected value in the --maintenance-window option when you run the command oci lfs lustre-file-system create [OPTIONS].

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Run the CreateLustreFileSystem operation with required attributes to create a file system.

    Note

    If you plan to specify a maintenance schedule when creating the file system, you must first call ListAvailableMaintenanceScheduleStartTimes to get the list of the available maintenance days of the week and start times. You then pass the selected value in the maintenanceWindow attribute when you run the CreateLustreFileSystem operation.

    For information about using the API and signing requests, see REST API documentation and Security Credentials. For information about SDKs, see SDKs and the CLI.