AliCloud NAS File System

Deploys an Alibaba Cloud Network Attached Storage (NAS) file system with a VPC mount target and optional custom access control. NAS provides fully managed, elastic, shared file storage supporting NFS and SMB protocols, accessible from ECS instances, Kubernetes pods, and serverless functions within a VPC.

What Gets Created

When you deploy an AliCloudNasFileSystem resource, OpenMCF provisions:

• NAS File System -- an alicloud_nas_file_system resource (Pulumi: nas.FileSystem) with the specified protocol type, storage tier, and optional encryption at rest
• Access Group + Access Rules -- (conditional) when accessRules are specified, a custom alicloud_nas_access_group with alicloud_nas_access_rule entries controlling which IP ranges can mount the file system and with what permissions
• Mount Target -- an alicloud_nas_mount_target resource (Pulumi: nas.MountTarget) in the specified VPC/VSwitch, producing the domain name clients use for NFS/SMB mounting
• Tags -- system metadata tags (resource, resource_name, resource_kind, organization, environment) merged with user-defined spec.tags, with user values taking precedence on key conflict

When no accessRules are specified, the mount target uses the built-in DEFAULT_VPC_GROUP_NAME access group, which allows full read-write access from all IP addresses within the VPC.

Prerequisites

• Alibaba Cloud credentials configured via environment variables (ALICLOUD_ACCESS_KEY, ALICLOUD_SECRET_KEY) or OpenMCF provider config
• A VPC and VSwitch in the target region -- the mount target is created in this VSwitch
• OpenMCF CLI installed with either Pulumi or Terraform (OpenTofu) backend

Quick Start

Create a file nas.yaml:

apiVersion: ali-cloud.openmcf.org/v1
kind: AliCloudNasFileSystem
metadata:
  name: shared-data
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: dev.AliCloudNasFileSystem.shared-data
spec:
  region: cn-hangzhou
  protocolType: NFS
  storageType: Performance
  vpcId: vpc-abc123
  vswitchId: vsw-abc123

Deploy:

openmcf apply -f nas.yaml

This creates a standard NFS file system with Performance storage and a mount target accessible from all VPC IPs. Mount the file system:

mount -t nfs -o vers=4,minorversion=0,noresvport <mount_target_domain>:/ /mnt/nas

Configuration Reference

Required Fields

Optional Fields

Examples

Minimal NFS File System

apiVersion: ali-cloud.openmcf.org/v1
kind: AliCloudNasFileSystem
metadata:
  name: dev-share
spec:
  region: cn-hangzhou
  protocolType: NFS
  storageType: Performance
  vpcId: vpc-abc123
  vswitchId: vsw-abc123

Production NFS with Encryption and Access Rules

apiVersion: ali-cloud.openmcf.org/v1
kind: AliCloudNasFileSystem
metadata:
  name: prod-storage
  org: my-org
  env: production
spec:
  region: cn-shanghai
  protocolType: NFS
  storageType: Performance
  encryption:
    encryptType: 1
  vpcId: vpc-prod-001
  vswitchId: vsw-prod-001
  accessRules:
    - sourceCidrIp: "10.0.1.0/24"
      rwAccessType: RDWR
    - sourceCidrIp: "10.0.2.0/24"
      rwAccessType: RDONLY
      userAccessType: root_squash
  tags:
    team: platform

Extreme NAS for High-Throughput Workloads

apiVersion: ali-cloud.openmcf.org/v1
kind: AliCloudNasFileSystem
metadata:
  name: hpc-scratch
spec:
  region: cn-hangzhou
  fileSystemType: extreme
  protocolType: NFS
  storageType: advance
  capacity: 500
  zoneId: cn-hangzhou-a
  encryption:
    encryptType: 2
    kmsKeyId: "cmk-abc123"
  vpcId: vpc-hpc-001
  vswitchId: vsw-hpc-001

Stack Outputs

After deployment, the following outputs are available in status.outputs:

Related Components

• AliCloudVpc -- prerequisite VPC for the mount target
• AliCloudVswitch -- prerequisite VSwitch for the mount target
• AliCloudKmsKey -- for customer-managed encryption keys
• AliCloudStorageBucket -- object storage alternative for unstructured data
• AliCloudAckManagedCluster -- Kubernetes clusters that mount NAS for shared persistent volumes