github.com/nathanielks/terraform@v0.6.1-0.20170509030759-13e1a62319dc/website/source/docs/providers/ignition/d/filesystem.html.md (about)

     1  ---
     2  layout: "ignition"
     3  page_title: "Ignition: ignition_filesystem"
     4  sidebar_current: "docs-ignition-datasource-filesystem"
     5  description: |-
     6    Describes the desired state of a system’s filesystem.
     7  ---
     8  
     9  # ignition\_filesystem
    10  
    11  Describes the desired state of a the system’s filesystems to be configured and/or used with the _ignition\_file_ resource.
    12  
    13  ## Example Usage
    14  
    15  ```hcl
    16  data "ignition_filesystem" "foo" {
    17  	name = "root"
    18  	mount {
    19  		device = "/dev/disk/by-label/ROOT"
    20  		format = "xfs"
    21  		create = true
    22  		options = ["-L", "ROOT"]
    23  	}
    24  }
    25  ```
    26  
    27  ## Argument Reference
    28  
    29  The following arguments are supported:
    30  
    31  * `name` - (Optional) The identifier for the filesystem, internal to Ignition. This is only required if the filesystem needs to be referenced in the a _ignition\_files_ resource.
    32  
    33  * `mount` - (Optional) Contains the set of mount and formatting options for the filesystem. A non-null entry indicates that the filesystem should be mounted before it is used by Ignition.
    34  
    35  * `path` - (Optional) The mount-point of the filesystem. A non-null entry indicates that the filesystem has already been mounted by the system at the specified path. This is really only useful for _/sysroot_.
    36  
    37  
    38  The `mount` block supports:
    39  
    40  * `device` - (Required) The absolute path to the device. Devices are typically referenced by the _/dev/disk/by-*_ symlinks.
    41  
    42  * `format` - (Required) The filesystem format (ext4, btrfs, or xfs).
    43  
    44  * `create` - (Optional) Indicates if the filesystem shall be created.
    45  
    46  * `force` - (Optional) Whether or not the create operation shall overwrite an existing filesystem. Only allowed if the filesystem is being created.
    47  
    48  * `options` - (Optional) Any additional options to be passed to the format-specific mkfs utility. Only allowed if the filesystem is being created
    49  
    50  ## Attributes Reference
    51  
    52  The following attributes are exported:
    53  
    54  * `id` - ID used to reference this resource in _ignition_config_.