Welcome to cdist documentation

Contents:

• 1. cdist - usable configuration management
• 2. Why should I use cdist?
  • 2.1. Known language
  • 2.2. Powerful language
  • 2.3. More than shell scripting
  • 2.4. Zero dependency configuration management
  • 2.5. Push based distribution
  • 2.6. Highly scalable
• 3. Supported Operating Systems
• 4. How to install cdist
  • 4.1. Requirements
  • 4.2. Install cdist
• 5. How to update cdist
  • 5.1. Update the git installation
  • 5.2. Update the python package
  • 5.3. General update instructions
• 6. Support
  • 6.1. IRC
  • 6.2. Mailing list
  • 6.3. Linkedin
  • 6.4. Commercial support
• 7. Features
• 8. Quickstart
• 9. cdist(1)
  • 9.1. NAME
  • 9.2. SYNOPSIS
  • 9.3. DESCRIPTION
  • 9.4. GENERAL
  • 9.5. BANNER
  • 9.6. CONFIG/INSTALL
  • 9.7. INVENTORY
  • 9.8. INVENTORY ADD-HOST
  • 9.9. INVENTORY ADD-TAG
  • 9.10. INVENTORY DEL-HOST
  • 9.11. INVENTORY DEL-TAG
  • 9.12. INVENTORY LIST
  • 9.13. PREOS
  • 9.14. PREOS DEBIAN
  • 9.15. PREOS UBUNTU
  • 9.16. SHELL
  • 9.17. TRIGGER
  • 9.18. FILES
  • 9.19. NOTES
  • 9.20. EXAMPLES
  • 9.21. ENVIRONMENT
  • 9.22. EXIT STATUS
  • 9.23. AUTHORS
  • 9.24. CAVEATS
  • 9.25. COPYING
• 10. Bootstrap
  • 10.1. Location
  • 10.2. Setup working directory and branch
  • 10.3. Publishing the configuration
  • 10.4. Updating from origin
• 11. Manifest
  • 11.1. Description
  • 11.2. Initial and type manifests
  • 11.3. Define state in the initial manifest
  • 11.4. Splitting up the initial manifest
  • 11.5. Dependencies
  • 11.6. Create dependencies from execution order
  • 11.7. Overrides
  • 11.8. Examples
• 12. cdist type
  • 12.1. Description
  • 12.2. Synopsis
  • 12.3. How to use a type
  • 12.4. Singleton types
  • 12.5. Config types
  • 12.6. Install types
  • 12.7. How to write a new type
  • 12.8. Defining parameters
  • 12.9. Using parameters
  • 12.10. Input from stdin
  • 12.11. Writing the manifest
  • 12.12. Singleton - one instance only
  • 12.13. Install - type with install command
  • 12.14. The type explorers
  • 12.15. Writing the gencode script
  • 12.16. Variable access from the generated scripts
  • 12.17. Hints for typewriters
  • 12.18. How to include a type into upstream cdist
• 13. cdist types
  • 13.1. cdist-type__apt_key(7)
  • 13.2. cdist-type__apt_key_uri(7)
  • 13.3. cdist-type__apt_mark(7)
  • 13.4. cdist-type__apt_norecommends(7)
  • 13.5. cdist-type__apt_ppa(7)
  • 13.6. cdist-type__apt_source(7)
  • 13.7. cdist-type__apt_update_index(7)
  • 13.8. cdist-type__block(7)
  • 13.9. cdist-type__ccollect_source(7)
  • 13.10. cdist-type__cdist(7)
  • 13.11. cdist-type__cdist_preos_trigger(7)
  • 13.12. cdist-type__cdistmarker(7)
  • 13.13. cdist-type__chroot_mount(7)
  • 13.14. cdist-type__chroot_umount(7)
  • 13.15. cdist-type__config_file(7)
  • 13.16. cdist-type__consul(7)
  • 13.17. cdist-type__consul_agent(7)
  • 13.18. cdist-type__consul_check(7)
  • 13.19. cdist-type__consul_reload(7)
  • 13.20. cdist-type__consul_service(7)
  • 13.21. cdist-type__consul_template(7)
  • 13.22. cdist-type__consul_template_template(7)
  • 13.23. cdist-type__consul_watch_checks(7)
  • 13.24. cdist-type__consul_watch_event(7)
  • 13.25. cdist-type__consul_watch_key(7)
  • 13.26. cdist-type__consul_watch_keyprefix(7)
  • 13.27. cdist-type__consul_watch_nodes(7)
  • 13.28. cdist-type__consul_watch_service(7)
  • 13.29. cdist-type__consul_watch_services(7)
  • 13.30. cdist-type__cron(7)
  • 13.31. cdist-type__daemontools(7)
  • 13.32. cdist-type__daemontools_service(7)
  • 13.33. cdist-type__debconf_set_selections(7)
  • 13.34. cdist-type__directory(7)
  • 13.35. cdist-type__docker(7)
  • 13.36. cdist-type__docker_compose(7)
  • 13.37. cdist-type__dog_vdi(7)
  • 13.38. cdist-type__dot_file(7)
  • 13.39. cdist-type__file(7)
  • 13.40. cdist-type__filesystem(7)
  • 13.41. cdist-type__firewalld_rule(7)
  • 13.42. cdist-type__firewalld_start(7)
  • 13.43. cdist-type__git(7)
  • 13.44. cdist-type__go_get(7)
  • 13.45. cdist-type__golang_from_vendor(7)
  • 13.46. cdist-type__grafana_dashboard(7)
  • 13.47. cdist-type__group(7)
  • 13.48. cdist-type__hostname(7)
  • 13.49. cdist-type__hosts(7)
  • 13.50. cdist-type__install_bootloader_grub(7)
  • 13.51. cdist-type__install_chroot_mount(7)
  • 13.52. cdist-type__install_chroot_umount(7)
  • 13.53. cdist-type__install_config(7)
  • 13.54. cdist-type__install_file(7)
  • 13.55. cdist-type__install_fstab(7)
  • 13.56. cdist-type__install_generate_fstab(7)
  • 13.57. cdist-type__install_mkfs(7)
  • 13.58. cdist-type__install_mount(7)
  • 13.59. cdist-type__install_partition_msdos(7)
  • 13.60. cdist-type__install_partition_msdos_apply(7)
  • 13.61. cdist-type__install_reboot(7)
  • 13.62. cdist-type__install_reset_disk(7)
  • 13.63. cdist-type__install_stage(7)
  • 13.64. cdist-type__install_umount(7)
  • 13.65. cdist-type__iptables_apply(7)
  • 13.66. cdist-type__iptables_rule(7)
  • 13.67. cdist-type__issue(7)
  • 13.68. cdist-type__jail(7)
  • 13.69. cdist-type__jail_freebsd10(7)
  • 13.70. cdist-type__jail_freebsd9(7)
  • 13.71. cdist-type__key_value(7)
  • 13.72. cdist-type__keyboard(7)
  • 13.73. cdist-type__line(7)
  • 13.74. cdist-type__link(7)
  • 13.75. cdist-type__locale(7)
  • 13.76. cdist-type__locale_system(7)
  • 13.77. cdist-type__motd(7)
  • 13.78. cdist-type__mount(7)
  • 13.79. cdist-type__mysql_database(7)
  • 13.80. cdist-type__package(7)
  • 13.81. cdist-type__package_apt(7)
  • 13.82. cdist-type__package_dpkg(7)
  • 13.83. cdist-type__package_emerge(7)
  • 13.84. cdist-type__package_emerge_dependencies(7)
  • 13.85. cdist-type__package_luarocks(7)
  • 13.86. cdist-type__package_opkg(7)
  • 13.87. cdist-type__package_pacman(7)
  • 13.88. cdist-type__package_pip(7)
  • 13.89. cdist-type__package_pkg_freebsd(7)
  • 13.90. cdist-type__package_pkg(7)
  • 13.91. cdist-type__package_pkgng_freebsd(7)
  • 13.92. cdist-type__package_rubygem(7)
  • 13.93. cdist-type__package_update_index(7)
  • 13.94. cdist-type__package_upgrade_all(7)
  • 13.95. cdist-type__package_yum(7)
  • 13.96. cdist-type__package_zypper(7)
  • 13.97. cdist-type__pacman_conf(7)
  • 13.98. cdist-type__pacman_conf_integrate(7)
  • 13.99. cdist-type__pf_apply(7)
  • 13.100. cdist-type__pf_ruleset(7)
  • 13.101. cdist-type__postfix(7)
  • 13.102. cdist-type__postfix_master(7)
  • 13.103. cdist-type__postfix_postconf(7)
  • 13.104. cdist-type__postfix_postmap(7)
  • 13.105. cdist-type__postfix_reload(7)
  • 13.106. cdist-type__postgres_database(7)
  • 13.107. cdist-type__postgres_extension(7)
  • 13.108. cdist-type__postgres_role(7)
  • 13.109. cdist-type__process(7)
  • 13.110. cdist-type__prometheus_alertmanager(7)
  • 13.111. cdist-type__prometheus_server(7)
  • 13.112. cdist-type__pyvenv(7)
  • 13.113. cdist-type__qemu_img(7)
  • 13.114. cdist-type__rbenv(7)
  • 13.115. cdist-type__rsync(7)
  • 13.116. cdist-type__rvm(7)
  • 13.117. cdist-type__rvm_gemset(7)
  • 13.118. cdist-type__rvm_gemset(7)
  • 13.119. cdist-type__rvm_ruby(7)
  • 13.120. cdist-type__ssh_authorized_key(7)
  • 13.121. cdist-type__ssh_authorized_keys(7)
  • 13.122. cdist-type__ssh_dot_ssh(7)
  • 13.123. cdist-type__staged_file(7)
  • 13.124. cdist-type__start_on_boot(7)
  • 13.125. cdist-type__sysctl(7)
  • 13.126. cdist-type__timezone(7)
  • 13.127. cdist-type__update_alternatives(7)
  • 13.128. cdist-type__user(7)
  • 13.129. cdist-type__user_groups(7)
  • 13.130. cdist-type__yum_repo(7)
  • 13.131. cdist-type__zypper_repo(7)
  • 13.132. cdist-type__zypper_service(7)
• 14. Explorer
  • 14.1. Description
  • 14.2. Examples
• 15. Messaging
  • 15.1. Description
  • 15.2. Availability
  • 15.3. Examples
• 16. Parallelization
  • 16.1. Description
  • 16.2. Examples
  • 16.3. Caveats
• 17. Inventory
  • 17.1. Introduction
  • 17.2. Description
  • 17.3. cdist inventory interface
  • 17.4. Configuring hosts using inventory
  • 17.5. Examples
  • 17.6. Example of manipulating database
  • 17.7. Using external inventory
• 18. Trigger
  • 18.1. Description
• 19. PreOS
  • 19.1. Description
  • 19.2. PreOS creation
  • 19.3. Implementing new PreOS sub-command
  • 19.4. Simple tipical use case for using PreOS and trigger
• 20. Reference
  • 20.1. Explorers
  • 20.2. Paths
  • 20.3. Types
  • 20.4. Objects
  • 20.5. Environment variables (for reading)
  • 20.6. Environment variables (for writing)
• 21. Best practice
  • 21.1. Passwordless connections
  • 21.2. Speeding up ssh connections
  • 21.3. Speeding up shell execution
  • 21.4. Multi master or environment setups
  • 21.5. Separating work by groups
  • 21.6. Maintaining multiple configurations
  • 21.7. Multiple developers with different trust
  • 21.8. Templating
  • 21.9. Testing a new type
  • 21.10. Other content in cdist repository
• 22. Execution stages
  • 22.1. Description
  • 22.2. Stage 1: target information retrieval
  • 22.3. Stage 2: run the initial manifest
  • 22.4. Stage 3: object information retrieval
  • 22.5. Stage 4: run the object manifest
  • 22.6. Stage 5: code generation
  • 22.7. Stage 6: code execution
  • 22.8. Stage 7: cache
  • 22.9. Summary
• 23. Remote exec and copy commands
• 24. Hacking
  • 24.1. Welcome
  • 24.2. Reporting bugs
  • 24.3. Coding conventions (everywhere)
  • 24.4. How to submit stuff for inclusion into upstream cdist
  • 24.5. How to submit a new type
  • 24.6. Example git workflow
• 25. Troubleshooting
  • 25.1. Error in manifest is not considered an error by cdist