schema.yaml

## Copyright © 2021, Oracle and/or its affiliates. 
## All rights reserved. The Universal Permissive License (UPL), Version 1.0 as shown at http://oss.oracle.com/licenses/upl

title: "Deploy a scalable, distributed file system using Lustre"
stackDescription: "Deploy a scalable, distributed file system using Lustre on Oracle Cloud Infrastructure Compute instances."
schemaVersion: 1.1.0
version: "20190404"
locale: "en"

groupings:
  - title: "Predefined General Configuration"
    visible: false
    variables:
    - tenancy_ocid
    - compartment_ocid
    - region
    - fingerprint
    - user_ocid
    - private_key_path
    - scripts_directory
    - ssh_user
    - volume_attach_device_mapping
    - volume_type_vpus_per_gb_mapping
    - ad_number
    - images
    - mp_listing_id
    - mp_listing_resource_id
    - mp_listing_resource_version
    - use_marketplace_image
    - marketplace_source_images
    - release
    - instance_os
    - linux_os_version

  - title: "Required Configuration"
    visible: true
    variables:
    - ad_name
    - show_advanced

  - title: "Networking Optional Configuration"
    visible: 
        and:
          - show_advanced
    variables:
    - use_existing_vcn
    - vpc_cidr
    - vcn_id
    - bastion_subnet_id
    - storage_subnet_id
    - fs_subnet_id

  - title: "Bastion Optional Configuration"
    visible: 
        and:
          - show_advanced
    variables:
    - bastion_shape
    - bastion_flex_shape_ocpus
    - bastion_flex_shape_mem
    - bastion_node_count
    - bastion_hostname_prefix

  - title: "Lustre Filesystem Optional Configuration"
    visible: 
        and:
          - show_advanced
    variables:
    - fs_name
    - fs_type
    - fs_workload_type

  - title: "Lustre Management Service Optional Configuration"
    visible: 
        and:
          - show_advanced
    variables:
    - management_server_shape
    - management_server_flex_shape_ocpus
    - management_server_flex_shape_mem
    - management_server_node_count
    - management_server_hostname_prefix
    - management_server_disk_count
    - management_server_disk_size
    - management_server_disk_perf_tier
    - instance_os
    - linux_os_version

  - title: "Lustre Metadata Service Optional Configuration"
    visible:
      and:
        - show_advanced
        - not:
          - eq:
            - ${fs_workload_type}
            - "Large Files"
    variables:
    - scratch_metadata_server_shape
    - persistent_metadata_server_shape
    - persistent_metadata_server_flex_shape_ocpus
    - persistent_metadata_server_flex_shape_mem
    - metadata_server_node_count
    - metadata_server_hostname_prefix
    - metadata_server_disk_count
    - metadata_server_disk_size
    - metadata_server_disk_perf_tier

  - title: "Lustre Storage Service Optional Configuration"
    visible: 
        and:
          - show_advanced
    variables:
    - scratch_storage_server_shape
    - persistent_storage_server_shape
    - persistent_storage_server_flex_shape_ocpus
    - persistent_storage_server_flex_shape_mem
    - storage_server_node_count
    - storage_server_hostname_prefix

  - title: "Lustre Storage Optional Configuration"
    variables:
    - storage_tier_1_disk_perf_tier
    - storage_tier_1_disk_count
    - storage_tier_1_disk_size
    visible:
      and:
        - show_advanced
        - not:
          - eq:
            - ${fs_type}
            - "Scratch"
  
  - title: "Lustre Client Instance Optional Configuration"
    visible: 
        and:
          - show_advanced
    variables:
    - create_compute_nodes
    - client_node_shape
    - client_node_flex_shape_ocpus
    - client_node_flex_shape_mem
    - client_node_count
    - client_node_hostname_prefix
    - stripe_size
    - mount_point

variables:

  show_advanced:
    type: boolean
    title: "Show advanced options?"
    description: "Shows advanced options."
    visible: true
    default: false

  ad_name:
    title: "Availability Domain"
    description: "Availability Domain where filesystem is deployed."
    type: oci:identity:availabilitydomain:name
    dependsOn:
      compartmentId: ${compartment_ocid}
    required: true

  bastion_shape:
    title: "Bastion Compute Shape"
    description: "Shape for bastion instances."
    type: oci:core:instanceshape:name
    default: "VM.Standard2.2"
    required: true
    dependsOn:
      compartmentId: ${compartment_ocid}
      imageId: ${mp_listing_resource_id}

  bastion_flex_shape_ocpus:
    type: number
    required: false
    minimum: 1
    maximum: 128
    multipleOf: 1
    default: 1
    title: "Bastion Flex Shape OCPUs"
    description: "Choose number of OCPUs for Flex Shape."
    visible:
      and:
        - or:
          - eq:
            - bastion_shape 
            - "VM.Standard.E3.Flex"
          - eq:
            - bastion_shape 
            - "VM.Standard.E4.Flex"
          - eq:
            - bastion_shape 
            - "VM.Optimized3.Flex"

  bastion_flex_shape_mem:
    type: number
    required: false
    minimum: 1
    maximum: 1024
    multipleOf: 1
    default: 1
    title: "Bastion Flex Shape Memory (GB)"
    description: "Choose number GB for Flex Shape Memory."
    visible:
      and:
        - or:
          - eq:
            - bastion_shape 
            - "VM.Standard.E3.Flex"
          - eq:
            - bastion_shape
            - "VM.Standard.E4.Flex"
          - eq:
            - bastion_shape 
            - "VM.Optimized3.Flex"

  bastion_node_count:
    title: "Number of bastion"
    description: "Number of bastion instances."
    type: integer
    default: 1
    minimum: 1
    required: true
    visible: false

  bastion_hostname_prefix:
    type: string
    required: true
    default: "bastion-"
    description: "Bastion hostname prefix "

  management_server_shape:
    title: "Management Server Compute Shape"
    description: "Shape for management server instances."
    type: oci:core:instanceshape:name
    default: "VM.Standard2.2"
    required: true
    dependsOn:
      compartmentId: ${compartment_ocid}
      imageId: ${mp_listing_resource_id}

  management_server_flex_shape_ocpus:
    type: number
    required: false
    minimum: 1
    maximum: 128
    multipleOf: 1
    default: 2
    title: "Management Server Flex Shape OCPUs"
    description: "Choose number of OCPUs for Flex Shape."
    visible:
      and:
        - or:
          - eq:
            - management_server_shape 
            - "VM.Standard.E3.Flex"
          - eq:
            - management_server_shape 
            - "VM.Standard.E4.Flex"
          - eq:
            - management_server_shape 
            - "VM.Optimized3.Flex"

  management_server_flex_shape_mem:
    type: number
    required: false
    minimum: 1
    maximum: 1024
    multipleOf: 1
    default: 15
    title: "Management Server Flex Shape Memory (GB)"
    description: "Choose number GB for Flex Shape Memory."
    visible:
      and:
        - or:
          - eq:
            - management_server_shape 
            - "VM.Standard.E3.Flex"
          - eq:
            - management_server_shape
            - "VM.Standard.E4.Flex"
          - eq:
            - management_server_shape 
            - "VM.Optimized3.Flex"

  management_server_node_count:
    title: "Number of management server"
    description: "Number of management server instances."
    type: integer
    default: 1
    minimum: 1
    maximum: 1
    required: true

  management_server_hostname_prefix:
    type: string
    required: true
    default: "mgs-server-"
    description: "Management server hostname prefix "

  management_server_disk_count:
    title: "Number of block volumes (MGT)"
    description: "Number of block volumes for each management server. Durable and Highly Available  will always be used for management server."
    type: integer
    default: 1
    minimum: 1
    maximum: 1
    required: true

  management_server_disk_size:
    title: "Block volume size"
    description: "Size in GB for block volumes attached to management server, min 50."
    type: integer
    default: 50
    minimum: 50
    maximum: 50
    required: true

  management_server_disk_perf_tier:
    title: "Management Server Target Block volume performance"
    description: "Block volume elastic performance tier.  See https://docs.cloud.oracle.com/en-us/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm for more information."
    type: enum
    enum:
    - "Higher Performance"
    - "Balanced"
    - "Lower Cost"
    required: true
    default: "Balanced"

  scratch_metadata_server_shape:
    title: "Metadata Server Compute Shape"
    description: "Shape for storage server instances."
    default: "VM.DenseIO2.8"
    required: true
    type: enum
    enum:
    - "VM.DenseIO2.8"
    - "VM.DenseIO2.16"
    - "VM.DenseIO2.24"
    - "BM.DenseIO2.52"
    - "BM.HPC2.36"
    visible:
      and:
        - eq:
          - ${fs_type}
          - "Scratch"

  persistent_metadata_server_shape:
    title: "Metadata Server Compute Shape"
    description: "Shape for storage server instances."
    default: "VM.Standard2.8"
    required: true
    type: enum
    enum:
    - "VM.Standard2.1"
    - "VM.Standard2.2"
    - "VM.Standard2.4"
    - "VM.Standard2.8"
    - "VM.Standard2.16"
    - "VM.Standard2.24"
    - "BM.Standard2.52"
    - "VM.Standard.E2.4"
    - "VM.Standard.E2.8"
    - "BM.Standard.E2.64"
    - "VM.Standard.E3.Flex"
    - "VM.Standard.E4.Flex"
    - "VM.Optimized3.Flex"
    visible:
      and:
        - eq:
          - ${fs_type}
          - "Persistent"

  persistent_metadata_server_flex_shape_ocpus:
    type: number
    required: false
    minimum: 1
    maximum: 128
    multipleOf: 1
    default: 8
    title: "Metadata Server Compute Flex Shape OCPUs"
    description: "Choose number of OCPUs for Flex Shape."
    visible:
      and:
        - eq:
          - ${fs_type}
          - "Persistent"
        - or:
          - eq:
            - persistent_metadata_server_shape 
            - "VM.Standard.E3.Flex"
          - eq:
            - persistent_metadata_server_shape 
            - "VM.Standard.E4.Flex"
          - eq:
            - persistent_metadata_server_shape 
            - "VM.Optimized3.Flex"

  persistent_metadata_server_flex_shape_mem:
    type: number
    required: false
    minimum: 1
    maximum: 1024
    multipleOf: 1
    default: 120
    title: "Metadata Server Compute Flex Shape Memory (GB)"
    description: "Choose number GB for Flex Shape Memory."
    visible:
      and:
        - eq:
          - ${fs_type}
          - "Persistent"
        - or:
          - eq:
            - persistent_metadata_server_shape 
            - "VM.Standard.E3.Flex"
          - eq:
            - persistent_metadata_server_shape
            - "VM.Standard.E4.Flex"
          - eq:
            - persistent_metadata_server_shape 
            - "VM.Optimized3.Flex"

  metadata_server_node_count:
    title: "Number of metadata servers"
    description: "Number of metadata server instances."
    type: integer
    minimum: 1
    default: 1
    required: true

  metadata_server_hostname_prefix:
    type: string
    required: true
    default: "metadata-server-"
    description: "Metadata server hostname prefix "
    visible: false

  metadata_server_disk_count:
    title: "Number of block volumes (MDT)"
    description: "Number of block volumes disks per metadata server. Block Volume are Durable and Highly Available."
    type: integer
    default: 1
    minimum: 1
    maximum: 32
    required: true
    visible:
      and:
        - eq:
          - ${fs_type}
          - "Persistent"

  metadata_server_disk_size:
    title: "Block volume size"
    description: "Size in GB for each block volume attached to Metadata server, min 50."
    type: integer
    default: 400
    minimum: 50
    maximum: 32768
    required: true
    visible:
      and:
        - eq:
          - ${fs_type}
          - "Persistent"

  metadata_server_disk_perf_tier:
    title: "Metadata Server Target Block volume performance"
    description: "Block volume elastic performance tier.  See https://docs.cloud.oracle.com/en-us/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm for more information."
    type: enum
    enum:
    - "Higher Performance"
    - "Balanced"
    - "Lower Cost"
    required: true
    default: "Higher Performance"
    visible: false

  scratch_storage_server_shape:
    title: "Storage Server Compute Shape"
    description: "Shape for storage server instances."
    default: "BM.DenseIO2.52"
    required: true
    type: enum
    enum:
    - "VM.DenseIO2.8"
    - "VM.DenseIO2.16"
    - "VM.DenseIO2.24"
    - "BM.DenseIO2.52"
    - "BM.HPC2.36"
    visible:
      and:
        - eq:
          - ${fs_type}
          - "Scratch"

  persistent_storage_server_shape:
    title: "Storage Server Compute Shape"
    description: "Shape for storage server instances."
    default: "BM.Standard2.52"
    required: true
    type: enum
    enum:
    - "VM.Standard2.1"
    - "VM.Standard2.2"
    - "VM.Standard2.4"
    - "VM.Standard2.8"
    - "VM.Standard2.16"
    - "VM.Standard2.24"
    - "BM.Standard2.52"
    - "VM.Standard.E2.4"
    - "VM.Standard.E2.8"
    - "BM.Standard.E2.64"
    - "VM.Standard.E3.Flex"
    - "VM.Standard.E4.Flex"
    - "VM.Optimized3.Flex"
    visible:
      and:
        - eq:
          - ${fs_type}
          - "Persistent"

  persistent_storage_server_flex_shape_ocpus:
    type: number
    required: false
    minimum: 1
    maximum: 128
    multipleOf: 1
    default: 24
    title: "Storage Server Compute Flex Shape OCPUs"
    description: "Choose number of OCPUs for Flex Shape."
    visible:
      and:
        - eq:
          - ${fs_type}
          - "Persistent"
        - or:
          - eq:
            - persistent_storage_server_shape 
            - "VM.Standard.E3.Flex"
          - eq:
            - persistent_storage_server_shape 
            - "VM.Standard.E4.Flex"
          - eq:
            - persistent_storage_server_shape 
            - "VM.Optimized3.Flex"

  persistent_storage_server_flex_shape_mem:
    type: number
    required: false
    minimum: 1
    maximum: 1024
    multipleOf: 1
    default: 320
    title: "Storage Server Compute Flex Shape Memory (GB)"
    description: "Choose number GB for Flex Shape Memory."
    visible:
      and:
        - eq:
          - ${fs_type}
          - "Persistent"
        - or:
          - eq:
            - persistent_storage_server_shape 
            - "VM.Standard.E3.Flex"
          - eq:
            - persistent_storage_server_shape
            - "VM.Standard.E4.Flex"
          - eq:
            - persistent_storage_server_shape 
            - "VM.Optimized3.Flex"

  storage_server_node_count:
    title: "Number of storage servers"
    description: "Number of storage server instances."
    type: integer
    default: 2
    minimum: 1
    required: true
    visible: true

  storage_server_hostname_prefix:
    type: string
    required: true
    default: "storage-server-"
    description: "Storage server hostname prefix "
    visible: false

  storage_tier_1_disk_perf_tier:
    title: "Block Volume Storage Performance tier"
    description: "Select block volume storage performance tier based on your performance needs. See https://docs.cloud.oracle.com/en-us/iaas/Content/Block/Concepts/blockvolumeelasticperformance.htm for more information."
    type: enum
    enum:
    - "Higher Performance"
    - "Balanced"
    - "Lower Cost"
    required: true
    default: "Higher Performance"
    visible:
      - eq:
        - ${fs_type}
        - "Persistent"

  storage_tier_1_disk_count:
    title: "Number of block volumes"
    description: "Number of block volume disks per file server. Each attached as JBOD. Block Volumes are durable and highly available(HA)."
    type: integer
    default: 1
    minimum: 1
    maximum: 32
    required: true
    visible:
      - eq:
        - ${fs_type}
        - "Persistent"

  storage_tier_1_disk_size:
    title: "Block volume size"
    description: "Select size in GB for each block volume/disk, min 50."
    type: integer
    default: 1000
    minimum: 50
    maximum: 32768
    required: true
    visible:
      - eq:
        - ${fs_type}
        - "Persistent"

  create_compute_nodes:
    type: boolean
    title: "Create Compute Nodes - Optional"
    description: "Select checkbox, if you want to create compute nodes to mount the filesystem"
    required: false
    default: false

  client_node_shape:
    title: "Client Compute Shape"
    description: "Shape for client instances."
    type: oci:core:instanceshape:name
    default: "VM.Standard2.24"
    required: true
    visible: ${create_compute_nodes}
    dependsOn:
      compartmentId: ${compartment_ocid}
      imageId: ${mp_listing_resource_id}

  client_node_flex_shape_ocpus:
    type: number
    required: false
    minimum: 1
    maximum: 128
    multipleOf: 1
    default: 4
    title: "Client Compute Flex Shape OCPUs"
    description: "Choose number of OCPUs for Flex Shape."
    visible:
      and:
        - create_compute_nodes
        - or:
          - eq:
            - client_node_shape 
            - "VM.Standard.E3.Flex"
          - eq:
            - client_node_shape 
            - "VM.Standard.E4.Flex"
          - eq:
            - client_node_shape 
            - "VM.Optimized3.Flex"

  client_node_flex_shape_mem:
    type: number
    required: false
    minimum: 1
    maximum: 1024
    multipleOf: 1
    default: 60
    title: "Client Compute Flex Shape Memory (GB)"
    description: "Choose number GB for Flex Shape Memory."
    visible:
      and:
        - create_compute_nodes
        - or:
          - eq:
            - client_node_shape 
            - "VM.Standard.E3.Flex"
          - eq:
            - client_node_shape
            - "VM.Standard.E4.Flex"
          - eq:
            - client_node_shape 
            - "VM.Optimized3.Flex"

  client_node_count:
    title: "Number of clients"
    description: "Number of client instances."
    type: integer
    default: 1
    visible: ${create_compute_nodes}
    required: true

  client_node_hostname_prefix:
    title: "Client Node Hostname Prefix"
    type: string
    required: true
    default: "client-"
    description: "Client hostname prefix "
    visible: false

  fs_name:
    title: "Filesystem Name"
    type: enum
    enum:
    - "Lustre"
    required: true
    default: "Lustre"
    description: "Select filesystem to deploy."
    visible: false

  fs_type:
    title: "Filesystem Type"
    type: enum
    enum:
    - "Scratch"
    - "Persistent"
    required: true
    default: "Persistent"
    description: "Select filesystem type to deploy. Scratch filesystem will use Compute shapes with local NVMe SSD disks. Persistent filesystem will use Standard Compute shapes with network attached Block Volume Storage.  Block volumes are highly durable, redundant and highly available."

  fs_workload_type:
    title: "Workload Type"
    type: enum
    enum:
    - "Large Files"
    - "Small Files"
    - "Mixed"
    required: true
    default: "Large Files"
    description: "Select Mixed, if your workload generates both small files and large files (> 10MiB) and you want to optimize filesystem for both.  Small Files (Random IO),  Large Files (Sequential IO). For large files, this template provisions by default one meta server using VM.DenseIO2.8 for scratch and VM.Standard2.8 + 1 x 400 High Performance Tier Block Volumes for persistent file system.  If you would like to customize the meta server configuration, then select Mixed. "
    visible: true

  stripe_size:
    title: "Filesystem Stripe Size"
    type: string
    required: true
    default: "1m"
    description: "Default file stripe size (aka chunk_size) used by clients to stripe file data and send to desired number of storage targets (OSTs). Example: 1m, 512k, 2m, etc"
    visible: false

  mount_point:
    title: "Filesystem Mount Point"
    type: string
    required: true
    default: "/mnt/fs"
    description: "Mount point on client instances for selected filesystem. "
    visible: false

  ad_number:
    description: "Shadowed TF value to ignore"
    type: integer
    required: true
    default: -1

  scripts_directory:
    type: string
    required: true
    default: "script"
    description: "Folder which has all the scripts."

  ssh_user:
    type: string
    required: true
    default: "opc"
    description: "opc for OracleLinux & CentOS, ubuntu for Ubuntu OS."

  mp_listing_id:
    type: string
    required: true
    description: "Marketplace Listing ID"

  mp_listing_resource_id:
    type: oci:core:image:id
    required: true
    description: "Marketplace Image OCID"
    dependsOn:
      compartmentId: ${compartment_ocid}
  mp_listing_resource_version:
    type: string
    required: true
    description: "Marketplace Listing package version"

  use_existing_vcn:
    type: boolean
    title: "Use Existing VCN"
    description: "Select checkbox, to use existing VCN, otherwise new VCN, subnets and related resources will be created"
    required: true
    default: false

  vpc_cidr:
    title: "VPC CIDR"
    description: "Network CIDR to use for VPC/VCN."
    type: string
    default: "10.0.0.0/16"
    required: true
    visible:
      not:
        - ${use_existing_vcn}

  vcn_id:
    type: oci:core:vcn:id
    title: "Existing VCN"
    description: "Select Existing VCN"
    dependsOn:
      compartmentId: ${compartment_ocid}
    visible: ${use_existing_vcn}
    required: true

  bastion_subnet_id:
    type: oci:core:subnet:id
    title: "Bastion Subnet"
    description: "Select public subnet. Ensure the subnet is in the same Availability Domain selected above"
    dependsOn:
      compartmentId: ${compartment_ocid}
      vcnId: ${vcn_id}
      hidePrivateSubnet: ${hide_private_subnet}
    visible: ${use_existing_vcn}
    required: true

  storage_subnet_id:
    type: oci:core:subnet:id
    title: "Storage Subnet"
    description: "Select private subnet to provision file servers (Storage/Metadata/Management servers).  This subnet to used to access Block Volmes storage. Ensure the subnet is in the same Availability Domain selected above"
    dependsOn:
      compartmentId: ${compartment_ocid}
      vcnId: ${vcn_id}
      hidePublicSubnet: ${hide_public_subnet}
    visible: ${use_existing_vcn}
    required: true

  fs_subnet_id:
    type: oci:core:subnet:id
    title: "Filesystem Subnet"
    description: "Select private subnet to provision client nodes to mount filesystem. This subnet is used for file servers and client nodes to send and receive data. File servers (Storage/Metadata/Management servers) will use a secondary VNIC to connect with client nodes. Ensure the subnet is in the same Availability Domain selected above"
    dependsOn:
      compartmentId: ${compartment_ocid}
      vcnId: ${vcn_id}
      hidePublicSubnet: ${hide_public_subnet}
    visible: ${use_existing_vcn}
    required: true
  
  release:
    type: string
    required: false
    visible: false
    title: "Reference Architecture Release (OCI Architecture Center)"

  instance_os:
    type: enum
    title: "Instance OS for Lustre Server"
    description: "Choose OS/image installed for Lustre Server."
    required: false
    enum:
      - "Oracle Linux"
    default: "Oracle Linux"

  linux_os_version:
    type: enum
    title: "OS Version for Lustre Server"
    description: "Choose Operating System version for Lustre Server."
    required: false
    enum:
      - "7.9"
    default: "7.9"