Uploaded image for project: 'Lustre Documentation'
  1. Lustre Documentation
  2. LUDOC-558

Write man pages for all Lustre Tunables

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Medium
    • None
    • None
    • 3
    • 9223372036854775807

    Description

      Lustre has a ton of tunables, most of which do not have man pages and/or references in the Lustre manual.  To start, it would be good to at least give them all a man page so admins on-box can lookup relevant tunables before playing with them.

      I've dissected the list of tunables into the following batches with each of the associated files:

      Batch 1: File Layout & Striping Parameters
      stripecount.4 stripesize.4 stripeoffset.4 stripetype.4 max_stripecount.4 max_stripes_per_mdt.4 append_stripe_count.4 append_pool.4 comp_count.4 dom_lock.4 dom_min_repsize.4 dom_stripesize.4 dom_stripesize_cur_kb.4 dom_stripesize_max_kb.4 dom_threshold_free_mb.4 extents_dense.4 extent_bytes_allocation.4 pool_add.4 pool_del.4 pool_new.4 pool_rem.4

      Batch 2: MDT & Directory Parameters
      mdt_activeobd.4 mdt_hash.4 mdt_numobd.4 mdt_qos_maxage.4 mdt_qos_prio_free.4 mdt_qos_threshold_rr.4 mdt_stripecount.4 mdt_stripetype.4 max_mdt_stripecount.4 dir_split_count.4 dir_split_delta.4 dir_read_on_open.4 delayed_unlink_mb.4 default_easize.4 default_cookiesize.4 max_easize.4 max_cookiesize.4

      Batch 3: Read-Ahead & I/O Optimization
      max_read_ahead_mb.4 max_read_ahead_per_file_mb.4 max_read_ahead_whole_mb.4 max_read_ahead_async_active.4 read_ahead_async_file_threshold_mb.4 read_ahead_range_kb.4 readcache_max_filesize.4 short_io_bytes.4 tiny_write.4 fast_read.4 parallel_dio.4 unaligned_dio.4 brw_size.4 max_pages_per_rpc.4 max_nolock_bytes.4 hybrid_io.4 hybrid_io_read_threshold_bytes.4 hybrid_io_write_threshold_bytes.4 file_heat.4

      Batch 4: Statahead & Directory Performance
      statahead_max.4 statahead_min.4 statahead_running_max.4 statahead_agl.4 statahead_batch_max.4 statahead_timeout.4 statahead_fname_match_hit.4 statahead_fname_predict_hit.4 enable_statahead_fname.4 lazystatfs.4 statfs_max_age.4 statfs_project.4 statfs_state.4

      Batch 5: Lock Management
      lock_count.4 lock_granted_count.4 lock_unused_count.4 lock_timeouts.4 lock_limit_mb.4 lock_reclaim_threshold_mb.4 lock_volume_factor.4 client_lock_volume.4 server_lock_volume.4 lru_size.4 lru_max_age.4 lru_cancel_batch.4 early_lock_cancel.4 cancel_unused_locks_before_replay.4 contended_locks.4 contention_seconds.4 ldlm_enqueue_min.4 sync_lock_cancel.4

      Batch 6: Cache & Memory Management
      max_dirty_mb.4 dirty_age_limit.4 cur_dirty_bytes.4 cur_dirty_grant_bytes.4 cur_grant_bytes.4 cur_lost_grant_bytes.4 grant_check_threshold.4 grant_compat_disable.4 grant_plan.4 grant_precreate.4 grant_rate.4 grant_shrink.4 grant_shrink_interval.4 grant_speed.4 granted.4 tot_granted.4 tot_dirty.4 tot_pending.4 dump_granted_max.4 osc_unevict_cached_mb.4 inode_cache.4 enable_page_cache_shrink.4

      Batch 7: RPC & Network Parameters
      max_rpcs_in_flight.4 max_rpcs_in_progress.4 max_mod_rpcs_in_flight.4 ping.4 pinger.4 pinger_recov.4 timeout.4 timeouts.4 active_request_timeout.4 idle_timeout.4 resend_count.4 req_buffer_history_len.4 req_buffer_history_max.4 req_buffers_max.4 threads_max.4 threads_min.4 threads_started.4 cancel_rate.4 idle_connect.4 dynamic_nids.4

      Batch 8: Recovery & Adaptive Timeouts
      at_max.4 at_min.4 at_history.4 recovery_time_hard.4 recovery_time_soft.4 evict_client.4 eviction_count.4 barrier_status.4 barrier_timeout.4 ir_factor.4

      Batch 9: QoS & Resource Allocation
      qos_maxage.4 qos_prio_free.4 qos_threshold_rr.4 qos_rr_index.4 activeobd.4 numobd.4 high_priority_ratio.4 reserved_mb_high.4 reserved_mb_low.4 reserved_ino_high.4 reserved_ino_low.4

      Batch 10: Changelog Parameters
      changelog_size.4 changelog_gc.4 changelog_deniednext.4 changelog_free_space_gc.4 changelog_max_idle_indexes.4 changelog_max_idle_time.4 changelog_min_free_cat_entries.4 changelog_min_gc_interval.4 access_log_mask.4 access_log_size.4

      Batch 11: HSM (Hierarchical Storage Management)
      hsm_control.4 archive_count.4 restore_count.4 remove_count.4 default_archive_id.4 remove_archive_on_last_unlink.4 lsom.4 lsom_enabled.4 lsom_sync_count.4

      Batch 12: Nodemap & Security
      nodemap_active.4 nodemap_admin.4 nodemap_audit_mode.4 nodemap_deny_unknown.4 nodemap_forbid_encryption.4 nodemap_idmap.4 nodemap_map_mode.4 nodemap_range.4 nodemap_rbac.4 nodemap_readonly_mount.4 nodemap_squash_gid.4 nodemap_squash_uid.4 nodemap_trusted.4 root_squash.4 nosquash_nids.4

      Batch 13: Security & Authentication
      krb5_allow_old_client_csum.4 rsi_acquire_expire.4 rsi_entry_expire.4 rsi_upcall.4 gss_check_upcall_ns.4 checksum_type.4 checksums.4 checksum_dump.4 checksum_t10pi_enforce.4 enable_filename_encryption.4 enable_fname_encoding.4 filename_enc_use_old_base64.4

      Batch 14: Identity & Job Tracking
      identity_acquire_expire.4 identity_downcall.4 identity_expire.4 identity_flush.4 identity_upcall.4 jobid_name.4 jobid_this_session.4 jobid_var.4 job_xattr.4 job_cleanup_interval.4 stats_track_uid.4 stats_track_gid.4 stats_track_pid.4 stats_track_ppid.4

      Batch 15: Sync & Commit Parameters
      sync_changes.4 sync_count.4 sync_in_flight.4 sync_in_progress.4 sync_journal.4 sync_on_lseek.4 sync_permission.4 async_commit_count.4 commit_on_sharing.4 force_sync.4 soft_sync_limit.4 max_sync_changes.4 old_sync_processed.4

      Batch 16: LFSCK & Maintenance
      lfsck_async_windows.4 lfsck_max_rpcs_in_flight.4 lfsck_speed_limit.4 auto_scrub.4 full_scrub_ratio.4 full_scrub_threshold_rate.4 enable_resource_id_check.4 enable_resource_id_repair.4 resource_id_repair_queue_count.4

      Batch 17: Precreation & Object Management
      precreate_batch.4 no_create.4 no_precreate.4 prealloc_status.4 prealloc_reserved.4 prealloc_force_new_seq.4 prealloc_last_id.4 prealloc_last_seq.4 prealloc_next_id.4 prealloc_next_seq.4 seqs_allocated.4 create_count.4 destroys_in_flight.4

      Batch 18: Filesystem Status & Monitoring
      uuid.4 server_uuid.4 desc_uuid.4 conn_uuid.4 num_exports.4 client_type.4 kbytestotal.4 kbytesfree.4 kbytesavail.4 filestotal.4 filesfree.4 maxbytes.4 blocksize.4 fstype.4 mntdev.4 instance.4 active.4 degraded.4 readonly.4 unstable_stats.4

      Batch 19: Power Management & Hardware
      pmqos_default_duration_usec.4 pmqos_latency_max_usec.4 pmqos_use_stats_for_duration.4 enable_pmqos.4 nonrotational.4 enable_health_write.4

      Batch 20: Mirror & FLR
      mirror_count.4 mirror_state.4

      Batch 21: Special Features & Capabilities
      enable_audit.4 enable_cap_mask.4 enable_chprojid_gid.4 enable_pin_gid.4 enable_projid_xattr.4 enable_remote_dir_gid.4 enable_remote_subdir_mount.4 enable_setstripe_gid.4 enable_shard_pfid.4 foreign_symlink_enable.4 foreign_symlink_prefix.4 foreign_symlink_upcall.4 foreign_symlink_upcall_info.4 fallocate_zero_blocks.4 atime_diff.4 ctime_age_limit.4 debug_level.4 debug_log_upcall.4 debug_raw_pointers.4 dump_stack_on_error.4 heat_decay_percentage.4 heat_period_second.4 dist_txn_check_space.4 flush_descriptors_cnt.4 index_backup.4 init_channel.4

      Batch 22: Connect & Configuration
      connect_flags.4 maxage.4

      Attachments

        Activity

          People

            elliswilson Ellis Wilson
            elliswilson Ellis Wilson
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated: