Articles in this section

view create

Sara Levy
  • Updated
Follow

This command creates a view, which is a resource location exposed to data clients. A view can be exposed to NFSv3, NFSv4.1 or SMB clients or to both NFSv3 and SMB clients or to both NFSv3 and NFSv4 clients. Also, a tabular data view can be exposed to third-party database query engines.

Usage

view create --path PATH
            --protocols PROTOCOLS
            --policy-id ID
            [--alias ALIAS]
            [--bucket BUCKET]
            [--bucket-owner BUCKET_OWNER]
            [--bucket-creators BUCKET_CREATORS]
            [--bucket-creators-groups BUCKET_CREATORS_GROUPS]
            [--create-dir]
            [--enable-live-monitoring]
            [--enable-s3-unverified-lookup]
            [--qos-policy-id QOS_POLICY_ID]
            [--share SHARE]
            [--s3-versioning]
            [--s3-locks]
            [--s3-locks-retention-period S3_LOCKS_RETENTION_PERIOD]
            [--s3-locks-retention-mode NONE|GOVERNANCE|COMPLIANCE]
            [--tenant-id TENANT_ID]
            [--allow-s3-anonymous-access]|[--block-s3-anonymous-access]
            [--s3-bucket-ownership-rule BucketOwnerEnforced|BucketOwnerPreferred|ObjectWriter|None]
 

Required Parameters

--path PATH

Specifies a path to a file system directory to be exposed to clients. It can be a directory that was already created by a client inside an exposed parent directory, or it can be a new directory, in which case you must specify the --create_dir option to create the directory.

Example:

--path /a/b/c

--policy-id ID

Specifies which view policy to apply. Specify ID as an integer value. To display view policy configurations with their IDs, use viewpolicy list.

--protocols PROTOCOLS

Specifies which protocol(s) the view will be exposed to.

Specify PROTOCOLS as a string value for a single protocol or a comma separated list of strings to enable multiple protocols. Valid string values are:

  • NFS. To expose the view as an NFS export to clients using NFS version 3.

  • NFS4. To expose the view as an NFS export to clients using NFS version 4.1.

  • SMB (Not in combination with ENDPOINT). To expose the view as an SMB share to SMB clients.

    Note

    If you want to configure share-level ACL for an SMB-enabled view, see Managing Share-level ACLs via VAST CLI for the relevant commands to run after the view is created.

  • S3 (Not in combination with ENDPOINT). To expose the view as an S3 bucket.

  • ENDPOINT (Not in combination with SMB or S3). To create an S3 Endpoint, which is a template for creating buckets via S3 APIs. Whenever a bucket is created using this endpoint, a new view is created under the specified path. See Managing S3 Request-Initiated Bucket Creation for more information about S3 Endpoint buckets.

  • DATABASE. To expose the view as a VAST database. This option is used for each view that VAST Cluster creates when a user chooses to create a database on the cluster. For more information, see Creating a Database and a Schema.

Examples:

--protocols NFS,SMB

--protocols NFS,NFS4,ENDPOINT

--protocols NFS,S3

--protocols SMB

--protocols DATABASE
 

Options

--alias ALIAS

For NFSv3 exports, specifies an alternative shorter name for the path that can be used alternatively when mounting. Optional and relevant only if the view is exposed to NFS. An alias must begin with a forward slash ("/") and must consist of only ASCII characters.

--bucket BUCKETNAME

Specifies the name of an S3 bucket. Required if S3 is specified in --protocols.

--bucket-owner BUCKET_OWNER

Specifies a user to be the bucket owner. Required if S3 is specified in --protocols.

--bucket-creators BUCKET_CREATORS

Relevant if ENDPOINT is specified in --protocols. Specifies users such that any request to create an S3 bucket that is sent by S3 API by a specified user will use this S3 Endpoint view.

Specify BUCKET_CREATORS as a comma separated list of user names.

Note

Users should not be specified as bucket creators in more than one S3 Endpoint view.

bucket-creators-groups BUCKET_CREATORS_GROUPS

Relevant if ENDPOINT is specified in --protocols. Specifies groups such that any request to create an S3 bucket that is sent by S3 API by a user who belongs to a specified group will use this S3 Endpoint view.

Specify BUCKET_CREATORS_GROUPS as a comma separated list of group names.

Caution

Take extra care not to duplicate bucket creators through groups: If you specify a group as a bucket creator group in one view and you also specify a user who belongs to that group as a bucket creator user in another view, view creation will not fail. Yet, there is a conflict between the two configurations and the selection of a view for configuring the user's buckets is not predictable.

--create-dir

Creates a directory at the specified path. Include this option of the directory does not already exist.

--enable-live-monitoring

Enables live monitoring on the view. Live monitoring can be enabled for up to ten views at one time and can also be enabled any time after view creation using view modify.

Analytics data for views is polled every 5 minutes by default and every 10 seconds with live monitoring.

--qos-policy-id QOS_POLICY_ID

Associates a QoS policy with the view. Specify the QoS policy by its ID. To list QoS policy definitions, use qospolicy list.

QoS policies are supported for NFSv3, NFSv4.1 and SMB.

--share SHARE

Specifies the SMB share name. Required if the view is exposed to SMB. The name cannot include the following characters: /\:|<>*?"

--s3-versioning

Enables object versioning on the bucket if S3 is specified in --protocols.

--s3-locks

Enables S3 object locking on the view bucket, if S3 is specified in --protocols. This setting can't be disabled after the view is created.

--s3-locks-retention-mode NONE|GOVERNANCE|COMPLIANCE

Sets a default retention mode for objects in the bucket.

Possible values:

  • NONE (default). Object versions that are placed in the bucket have no automatic protection but can be configured with a retention period or legal hold.

  • GOVERNANCE. Object versions that are placed in the bucket are automatically protected with a retention lock with retention mode set to governance.

  • COMPLIANCE. Object versions that are placed in the bucket are automatically protected with a retention lock with retention mode set to compliance.

--s3-locks-retention-period S3_LOCKS_RETENTION_PERIOD

Sets a default retention period for objects in the bucket, if S3 object locking is enabled.

If set, object versions that are placed in the bucket are automatically protected with a retention lock with the specified retention period, unless --s3-locks-retention-mode is set to NONE. Otherwise, by default, each object version has no automatic protection but can be configured with a retention period or legal hold. For more information, see S3 Object Locking Overview.

Specify S3_LOCKS_RETENTION_PERIOD as an integer followed by a symbol. For example: 1y for one year.

--tenant-id TENANT_ID

Specifies a non-default tenant to associate with the view.

--allow-anonymous-access

If the view has S3 Bucket or S3 Endpoint enabled, include this option to allow anonymous S3 access to the view's S3 bucket.

If allowed, anonymous requests are granted provided that the object ACL grants access to the All Users group (in S3 Native security flavor) or the permission mode bits on the requested file and directory path grant access permission to "others" (in NFS security flavor).

--block-anonymous-access

Blocks anonymous S3 access to the view's S3 bucket, if applicable. This is the default setting.

--s3-object-ownership-rule BucketOwnerEnforced|BucketOwnerPreferred| ObjectWriter|None

Sets one of the following S3 Object Ownership rules:

  • BucketOwnerEnforced. The bucket owner has full control over any object in the bucket. Access to objects is controlled based on policies configured for the bucket. ACLs are not used.

  • BucketOwnerPreferred. The bucket owner has full control over new objects uploaded to the bucket by other users. ACLs can be used to control access to the objects.

  • ObjectWriter. The user that uploads an object has full control over this object. ACLs can be used to let other users access the object.

  • None. Disables S3 Object Ownership for the bucket.
 

Example

This example creates a view of the pre-existing /dev directory, with an NFS export, using the default view policy.

vcli: admin> view create --path /dev --protocols NFS

This example creates a multiprotocol view of a directory at the /home/users/devteam path using a non default view policy.

vcli: admin> view create --path  /home/users/devteam --protocols NFS,SMB --alias /devteam --share devteamusers  --policy-id 2 --create-dir
 

Related Commands

viewpolicy list

Lists view policy IDs

viewpolicy create

Creates view policy
 
 

Related articles

Comments

0 comments

Article is closed for comments.