Read the Docs Template Documentation Release 3.2.0
Total Page:16
File Type:pdf, Size:1020Kb
Read the Docs Template Documentation Release 3.2.0 Read the Docs Sep 30, 2021 Contents 1 Downloads 3 1.1 MS Windows...............................................3 1.2 Linux...................................................3 1.3 Mac OS X................................................4 1.4 Sources..................................................4 2 Installation 5 2.1 Linux Packages..............................................5 2.2 MS Windows Archives..........................................6 2.3 Mac OS X................................................6 2.4 Manual Project Build...........................................6 2.4.1 Linux..............................................6 2.4.2 MS Windows..........................................6 2.4.3 Mac OS X............................................7 3 Configuration 9 3.1 Config files................................................9 3.2 Environment Variables.......................................... 10 3.2.1 Manual Environment Setup................................... 10 3.2.1.1 Required Variables................................... 10 3.2.1.2 Optional Variables................................... 10 3.3 Config Overrides............................................. 10 3.4 Config Path Override........................................... 11 4 Afanasy 13 4.1 Server................................................... 13 4.1.1 Launch Methods........................................ 13 4.1.2 System Job........................................... 13 4.1.2.1 Configuration..................................... 15 4.1.3 Post Commands......................................... 15 4.1.4 Wake-On-LAN......................................... 15 4.1.5 Events.............................................. 16 4.1.5.1 JOB_DONE...................................... 16 4.1.5.2 JOB_ERROR..................................... 16 4.1.5.3 JOB_DELETED.................................... 16 4.1.5.4 RENDER_ZOMBIE.................................. 16 4.1.5.5 RENDER_SICK.................................... 16 i 4.1.5.6 RENDER_NO_TASK................................. 16 4.1.5.7 RENDER_OVERLOAD............................... 17 4.1.6 Statistics............................................. 17 4.1.6.1 Database Setup.................................... 17 4.1.6.2 Create Tables..................................... 18 4.1.6.3 Server setup...................................... 18 4.1.6.4 Web Page....................................... 18 4.1.7 TIME-WAIT.......................................... 18 4.2 Render.................................................. 18 4.2.1 Launch Methods........................................ 20 4.2.2 Attributes............................................ 20 4.2.2.1 name.......................................... 20 4.2.2.2 address.family..................................... 20 4.2.2.3 address.ip....................................... 20 4.2.2.4 netifs[]......................................... 20 4.2.2.5 time_launch...................................... 20 4.2.2.6 time_register...................................... 20 4.2.2.7 time_update...................................... 20 4.2.2.8 wol_operation_time.................................. 21 4.2.2.9 tasks[]......................................... 21 4.2.2.10 capacity_used..................................... 21 4.2.3 Editable Parameters....................................... 21 4.2.3.1 user_name....................................... 21 4.2.3.2 priority......................................... 21 4.2.3.3 capacity........................................ 21 4.2.3.4 max_tasks....................................... 21 4.2.3.5 services........................................ 21 4.2.3.6 services_disabled................................... 21 4.2.3.7 annotation....................................... 21 4.2.4 State............................................... 22 4.2.5 Resources............................................ 22 4.2.5.1 cpu_num........................................ 22 4.2.5.2 cpu_mhz........................................ 22 4.2.5.3 cpu_loadavg[3].................................... 22 4.2.5.4 cpu_user........................................ 22 4.2.5.5 cpu_nice........................................ 22 4.2.5.6 cpu_system...................................... 22 4.2.5.7 cpu_idle........................................ 22 4.2.5.8 cpu_iowait....................................... 22 4.2.5.9 cpu_irq......................................... 23 4.2.5.10 cpu_softirq....................................... 23 4.2.5.11 mem_total_mb..................................... 23 4.2.5.12 mem_free_mb..................................... 23 4.2.5.13 mem_cached_mb................................... 23 4.2.5.14 mem_buffers_mb................................... 23 4.2.5.15 swap_total_mb..................................... 23 4.2.5.16 swap_used_mb.................................... 23 4.2.5.17 hdd_total_gb...................................... 23 4.2.5.18 hdd_free_gb...................................... 23 4.2.5.19 hdd_rd_kbsec..................................... 23 4.2.5.20 hdd_wr_kbsec..................................... 23 4.2.5.21 hdd_busy........................................ 24 4.2.5.22 net_recv_kbsec.................................... 24 4.2.5.23 net_send_kbsec.................................... 24 ii 4.2.6 Paths Map............................................ 24 4.2.6.1 MS Windows platform issues............................. 24 4.2.7 Services............................................. 25 4.2.8 Parsers.............................................. 25 4.2.8.1 do........................................... 26 4.2.8.2 self.percent(int).................................... 26 4.2.8.3 self.frame(int)..................................... 26 4.2.8.4 self.percentframe(int)................................. 26 4.2.8.5 self.warning(False/True)................................ 26 4.2.8.6 self.error(False/True)................................. 27 4.2.8.7 self.badresult(False/True)............................... 27 4.2.8.8 self.finishedsuccess(False/True)............................ 27 4.2.8.9 self.activity(str).................................... 27 4.2.8.10 self.resources(str)................................... 27 4.2.8.11 self.log(str)....................................... 27 4.2.8.12 self.report(str)..................................... 27 4.2.9 Thumbnails........................................... 27 4.2.9.1 appendFile(i_file, i_onthefly)............................. 28 4.2.9.2 Configuration..................................... 28 4.2.10 Custom Resources....................................... 28 4.2.10.1 example........................................ 28 4.2.10.2 iostat.......................................... 28 4.2.10.3 nvidia-smi....................................... 28 4.2.10.4 Properties....................................... 29 4.2.11 Windows Must Die....................................... 30 4.3 Pools................................................... 31 4.3.1 Creation............................................. 31 4.3.2 Attributes............................................ 32 4.3.2.1 name.......................................... 32 4.3.2.2 parent......................................... 32 4.3.2.3 time_creation..................................... 32 4.3.2.4 pools_num....................................... 32 4.3.2.5 pools_total....................................... 32 4.3.2.6 renders_num...................................... 32 4.3.2.7 renders_total...................................... 32 4.3.2.8 run_tasks........................................ 32 4.3.2.9 run_capacity...................................... 32 4.3.2.10 task_start_finish_time................................. 32 4.3.3 Editable Parameters....................................... 32 4.3.3.1 annotation....................................... 32 4.3.3.2 capacity_host..................................... 33 4.3.3.3 exit_no_task_time................................... 33 4.3.3.4 heartbeat_sec..................................... 33 4.3.3.5 max_tasks_host.................................... 33 4.3.3.6 new_nimby...................................... 33 4.3.3.7 new_paused...................................... 33 4.3.3.8 no_task_event_time.................................. 33 4.3.3.9 overload_event_time.................................. 33 4.3.3.10 power_host....................................... 33 4.3.3.11 properties_host.................................... 33 4.3.3.12 resources_update_period............................... 34 4.3.3.13 sick_errors_count................................... 34 4.3.3.14 services........................................ 34 4.3.3.15 services_disabled................................... 34 iii 4.3.3.16 tickets_pool...................................... 34 4.3.3.17 tickets_host...................................... 34 4.3.3.18 zombie_time...................................... 34 4.3.3.19 idle_wolsleep_time.................................. 34 4.3.3.20 idle_free_time..................................... 34 4.3.3.21 busy_nimby_time................................... 35 4.3.3.22 idle_cpu........................................ 35 4.3.3.23 busy_cpu........................................ 35 4.3.3.24 idle_mem....................................... 35 4.3.3.25 busy_mem....................................... 35 4.3.3.26 idle_swp........................................ 35 4.3.3.27 busy_swp....................................... 35 4.3.3.28 idle_hddgb......................................