forms.yaml

categories:
  - name: Default
    icon: bars
  - name: Dataset
    icon: bath
  - name: Create
    icon: bath  
  - name: Clone
    icon: bath             
roles:
  - name: admin
    groups:
      - local/admins
      - ldap/Domain Admins
  - name: operator
    groups:
      - local/operator
  - name: demo
    groups:
      - local/demo
  - name: public
    groups: []
  - name: DataOps
    groups:
      - local/DataOps Admins  
forms:
  - name: Create new dataset 
    help: |
      This is used to create new dataset in the FZ-DEV. The new dataset will be mounted under /data/{aud,eng,nlp,vis}/datasets  
    roles:
      - DataOps
    description: New dataset creation 
    categories:
      - Dataset
      - Create
    #tileClass: has-background-link
    icon: scroll
    playbook: dataops_create_vol.yaml
    inventory: hosts
    type: ansible
    fields:   
      - type: expression
        hide: true
        label: globals
        name: globals
        expression: "fn.fnReadJsonFile('/app/dist/persistent/global.json','')"           
      #- type: expression
      #  name: existingvols
      #  label: existingvols
      #  expression: fn.fnRestBasic('get','https://$(cluster)/api/storage/volumes?order_by=name&svm.name=$(svm)&fields=name','','ONTAP','.records | map(.name) | "^(?!.*" + join (")(?!.*")+ ").*$"') 
      #set the vol type as flexgroup or flexvol        
      - type: enum
        name: department
        label: Depratment
        default: aud
        values:
        - aud
        - eng
        - nlp
        - vis
        required: true
      - type: text
        name: dataset_name
        label: Dataset Name
        default: ""
        required: true
        minLength: 3
        maxLength: 20
        #regex: $(existingvols)
        #regex: ^(?!.*app1)(?!.*app2)(?!.*svm1_root)(?!.*user_dans)(?!.*user_gracel)(?!.*user_hmarko)(?!.*user_janes)(?!.*user_kateh)(?!.*user_koko)(?!.*user_marium)(?!.*user_oved)(?!.*user_stanw)(?!.*user_stever)(?!.*user_tzafrir)(?!.*user_user)(?!.*user_userkk)(?!.*user_userko)(?!.*user_useruuu)(?!.*vol1).*$
        #regexDescription: Dataset already exists 
        regex: ^[a-zA-Z0-9_]*$
        regexDescription: Invalid dataset name
      #will be used to create the volume name (department_projectname)
      - type: expression
        hide: true
        label: volname
        name: volname
        expression: "'$(department)'+'_'+'$(dataset_name)'"          
      #will be used to create the junction path on the globalname space)
      - type: expression
        hide: true
        label: junction_path
        name: junction_path
        expression: "'/data/'+'$(department)'+'/datasets/'+'$(dataset_name)'"  
      - type: enum
        name: volsize
        label: Dataset Initial Size
        default: 2TB
        required: true
        values:
        - 100GB
        - 200GB
        - 300GB
        - 400GB
        - 500GB
        - 600GB
        - 700GB
        - 800GB
        - 900GB
        - 1TB
        - 2TB
        - 3TB
        - 4TB
        - 5TB
        - 10TB
        - 20TB
        - 50TB
        size: 4
        help: Select the size of the volume. The volume will be created thin provisioned and can be resized in later phase. 

  - name: Clone dataset from FZ-DEV to SZ 
    help: |
      This is used to clone dataset in the FZ-DEV. The new dataset will be mounted under /data/{aud,eng,nlp,vis}/datasets on the SZ 
    roles:
      - DataOps
    description: Clone dataset
    categories:
      - Dataset
      - Clone
    #tileClass: has-background-link
    icon: scroll
    playbook: dataops_clone_vol.yaml
    inventory: hosts
    type: ansible
    fields:   
      #load global parameters 
      - type: expression
        hide: true
        label: globals
        name: globals
        expression: "fn.fnReadJsonFile('/app/dist/persistent/global.json','')"                 
      - type: expression
        runLocal: true
        hide: true
        label: cluster
        name: cluster
        expression: "JSON.parse('$(globals)').cluster"
      - type: expression
        runLocal: true
        hide: true
        label: sourcesvm
        name: sourcesvm
        expression: "JSON.parse('$(globals)').sourcesvm"                
      - type: enum
        name: department
        label: Depratment
        default: aud
        values:
        - aud
        - eng
        - nlp
        - vis
        required: true
      - type: query
        name: dataset
        expression: fn.fnRestBasic('get','https://$(cluster)/api/storage/volumes?svm.name=$(sourcesvm)&state=online&nas.path=/data/$(department)/datasets/*&name=$(department)_*&fields=nas.path&style=flexgroup,flexvol','','ONTAP','[(.records[] | ({Volume:.name} + {uuid} + {Path:.nas.path} + {Dataset:.nas.path | sub("^/data/$(department)/datasets/"; "")}))]','','')
        label: Source Dataset
        default: __auto__
        multiple: false
        outputObject: true
        columns:
        - Dataset
        - Volume
        - Path    
      - type: query
        name: parent_snapshot
        expression: fn.fnRestBasic('get','https://$(cluster)/api/storage/volumes/$(dataset.uuid)/snapshots?fields=name,create_time','','ONTAP','[(.records[] | ({Snapshot:.name} + {"Create Time":.create_time} ) ) ]','','')
        label: Parent Snapshot
        default: __auto__
        multiple: false
        outputObject: true
        columns:
        - Snapshot
        - "Create Time"
      - type: text
        name: clone_dataset
        label: Optional Clone Dataset Name
        placeholder: optional dataset name, if not provided source name will be used
        required: false
        minLength: 1
        maxLength: 20
        regex: ^[a-zA-Z0-9_]*$
        regexDescription: Invalid dataset name 
        default: ""
      - type: expression
        hide: true
        label: targetvolume
        name: targetvolume
        expression: "'$(clone_dataset)'=='' ? '$(dataset.Volume)' : '$(department)'+'_'+'$(clone_dataset)'"       
        runLocal: true
      - type: expression
        hide: true
        label: new_dataset
        name: new_dataset
        expression: "'$(clone_dataset)'=='' ? '$(dataset.Volume)' : '$(clone_dataset)'"            
        runLocal: true
      - type: expression
        hide: true
        label: junction_path
        name: junction_path
        expression: "'/data/'+'$(department)'+'/datasets/'+'$(new_dataset)'"  
        runLocal: true
  - name: Create snapshot
    help: |
      This is used to create snapshot for dataset  
    roles:
      - DataOps
    description: create snapshot on existing dataset
    categories:
      - Snapshot
      - Create
    #tileClass: has-background-link
    icon: scroll
    playbook: dataops_create_snapshot.yaml
    inventory: hosts
    type: ansible
    fields:   
      #load global parameters 
      - type: expression
        hide: true
        label: globals
        name: globals
        expression: fn.fnReadJsonFile('/app/dist/persistent/global.json','')                
      - type: expression
        runLocal: true
        hide: true
        label: cluster
        name: cluster
        expression: "JSON.parse('$(globals)').cluster"     
      - type: enum
        name: department
        label: Depratment
        default: aud
        values:
        - aud
        - eng
        - nlp
        - vis
        required: true
      - type: query
        name: svm
        expression: fn.fnRestBasic('get','https://$(cluster)/api/svm/svms?name=svm*&fields=name','','ONTAP','[.records[]]','','')
        label: SVM
        default: __auto__
        multiple: false
        outputObject: true
        columns:
        - name          
      - type: query
        name: dataset
        expression: fn.fnRestBasic('get','https://$(cluster)/api/storage/volumes?svm.name=$(svm.name)&state=online&nas.path=/data/$(department)/datasets/*&name=$(department)_*&fields=nas.path&style=flexgroup,flexvol','','ONTAP','[(.records[] | ({Volume:.name} + {uuid} + {Path:.nas.path} + {Dataset:.nas.path | sub("^/data/$(department)/datasets/"; "")}))]','','')
        label: Dataset
        default: __auto__
        multiple: false
        outputObject: true
        columns:
        - Dataset
        - Volume
        - Path    
      - type: text
        name: snapshot
        label: Snapshot Name
        placeholder: manual snapshot name 
        required: true
        minLength: 1
        maxLength: 20
        regex: ^[a-zA-Z0-9_]*$
        regexDescription: Invalid snapshot name 
      - type: enum
        name: retention
        label: Retention Count
        default: "0"
        values:
        - "0"
        - "1"
        - "2"
        - "3"
        - "4"
        - "5"
        - "10"
        multiple: false
        size: 4
        required: true
        icon: flag
        help: when retention is bigger than 0, retention count of snapshots will be kept and snapshots will be suffixed by timestamp

  - name: Delete dataset clone 
    help: |
      This is used to permanently delete dataset and all its data.
      This can only be done if this dataset have no clones  
    roles:
      - DataOps
    description: Delete dataset
    categories:
      - Dataset
      - Delete
    tileClass: has-background-danger	
    icon: scroll
    playbook: dataops_delete_vol.yaml
    inventory: hosts
    type: ansible
    fields:   
      #load global parameters 
      - type: expression
        hide: true
        label: globals
        name: globals
        expression: "fn.fnReadJsonFile('/app/dist/persistent/global.json','')"                 
      - type: expression
        runLocal: true
        hide: true
        label: cluster
        name: cluster
        expression: "JSON.parse('$(globals)').cluster"            
      - type: enum
        name: department
        label: Depratment
        default: aud
        values:
        - aud
        - eng
        - nlp
        - vis
        required: true
      - type: query
        name: svm
        expression: fn.fnRestBasic('get','https://$(cluster)/api/svm/svms?name=svm*&fields=name','','ONTAP','[.records[]]','','')
        label: SVM
        default: __auto__
        multiple: false
        outputObject: true
        columns:
        - name              
      - type: query
        name: dataset
        expression: fn.fnRestBasic('get','https://$(cluster)/api/storage/volumes?svm.name=$(svm.name)&state=online&nas.path=/data/$(department)/datasets/*&name=$(department)_*&fields=nas.path,clone.is_flexclone,clone.parent_svm.name,clone.parent_volume.name','','ONTAP','[(.records[] | ({Volume:.name} + {uuid} + {Path:.nas.path} + {FlexClone:.clone.is_flexclone} + {Dataset:.nas.path | sub("^/data/$(department)/datasets/"; "")}))]','','')
        label: Source Dataset
        default: __auto__
        multiple: false
        outputObject: true
        columns:
        - Dataset
        - Volume
        - Path    
        - FlexClone
      - type: checkbox
        name: areyousure
        label: Confirmation
        default: false
        placeholder: Are you sure you want to delete the dataset (important data can be lost) ?
      - type: text
        name: confirmation
        label: Please type YES to confirm you want to delete
        placeholder: "YES" 
        required: true
        minLength: 1
        maxLength: 3
        regex: ^YES$
        regexDescription: Type YES to confirm
        dependencies:         # add a list of dependencies
        - name: areyousure # reference field it depends on
          values:             # values of the reference field that are valid
          - true