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. Dive into real world cdist
  • 9.1. Introduction
  • 9.2. Creating type layout
  • 9.3. Creating __sample_bottle_hosting type parameters
  • 9.4. Creating __sample_bottle_hosting type manifest
  • 9.5. Creating __sample_bottle_hosting type gencode-remote
  • 9.6. Creating __sample_nginx_http_letsencrypt_and_ssl_redirect type
  • 9.7. Creating init manifest
  • 9.8. Configuring host
  • 9.9. Creating python bottle application
  • 9.10. What's next?
• 10. cdist(1)
  • 10.1. NAME
  • 10.2. SYNOPSIS
  • 10.3. DESCRIPTION
  • 10.4. GENERAL
  • 10.5. BANNER
  • 10.6. CONFIG/INSTALL
  • 10.7. INVENTORY
  • 10.8. INVENTORY ADD-HOST
  • 10.9. INVENTORY ADD-TAG
  • 10.10. INVENTORY DEL-HOST
  • 10.11. INVENTORY DEL-TAG
  • 10.12. INVENTORY LIST
  • 10.13. PREOS
  • 10.14. PREOS DEBIAN/DEVUAN
  • 10.15. PREOS UBUNTU
  • 10.16. SHELL
  • 10.17. TRIGGER
  • 10.18. CONFIGURATION
  • 10.19. FILES
  • 10.20. NOTES
  • 10.21. EXAMPLES
  • 10.22. ENVIRONMENT
  • 10.23. EXIT STATUS
  • 10.24. AUTHORS
  • 10.25. CAVEATS
  • 10.26. COPYING
• 11. cdist-dump(1)
  • 11.1. NAME
  • 11.2. SYNOPSIS
  • 11.3. DESCRIPTION
  • 11.4. OPTIONS
  • 11.5. EXAMPLES
  • 11.6. SEE ALSO
  • 11.7. AUTHORS
  • 11.8. COPYING
• 12. Bootstrap
  • 12.1. Location
  • 12.2. Setup working directory and branch
  • 12.3. Publishing the configuration
  • 12.4. Updating from origin
• 13. Configuration
  • 13.1. Description
  • 13.2. Config file format
• 14. Manifest
  • 14.1. Description
  • 14.2. Initial and type manifests
  • 14.3. Define state in the initial manifest
  • 14.4. Splitting up the initial manifest
  • 14.5. Dependencies
  • 14.6. Create dependencies from execution order
  • 14.7. Overrides
  • 14.8. Examples
• 15. cdist type
  • 15.1. Description
  • 15.2. Synopsis
  • 15.3. How to use a type
  • 15.4. Singleton types
  • 15.5. Config types
  • 15.6. Install types
  • 15.7. Nonparallel types
  • 15.8. How to write a new type
  • 15.9. Defining parameters
  • 15.10. Using parameters
  • 15.11. Input from stdin
  • 15.12. Writing the manifest
  • 15.13. Singleton - one instance only
  • 15.14. Install - type with install command
  • 15.15. Nonparallel - only one instance can be run at a time
  • 15.16. The type explorers
  • 15.17. Writing the gencode script
  • 15.18. Variable access from the generated scripts
  • 15.19. Environment variable usage idiom
  • 15.20. Log level in types
  • 15.21. Hints for typewriters
  • 15.22. How to include a type into upstream cdist
• 16. cdist types
  • 16.1. cdist-type__acl(7)
  • 16.2. cdist-type__apt_default_release(7)
  • 16.3. cdist-type__apt_key(7)
  • 16.4. cdist-type__apt_key_uri(7)
  • 16.5. cdist-type__apt_mark(7)
  • 16.6. cdist-type__apt_norecommends(7)
  • 16.7. cdist-type__apt_ppa(7)
  • 16.8. cdist-type__apt_source(7)
  • 16.9. cdist-type__apt_update_index(7)
  • 16.10. cdist-type__block(7)
  • 16.11. cdist-type__ccollect_source(7)
  • 16.12. cdist-type__cdist(7)
  • 16.13. cdist-type__cdist_preos_trigger(7)
  • 16.14. cdist-type__cdistmarker(7)
  • 16.15. cdist-type__check_messages(7)
  • 16.16. cdist-type__chroot_mount(7)
  • 16.17. cdist-type__chroot_umount(7)
  • 16.18. cdist-type__clean_path(7)
  • 16.19. cdist-type__config_file(7)
  • 16.20. cdist-type__consul(7)
  • 16.21. cdist-type__consul_agent(7)
  • 16.22. cdist-type__consul_check(7)
  • 16.23. cdist-type__consul_reload(7)
  • 16.24. cdist-type__consul_service(7)
  • 16.25. cdist-type__consul_template(7)
  • 16.26. cdist-type__consul_template_template(7)
  • 16.27. cdist-type__consul_watch_checks(7)
  • 16.28. cdist-type__consul_watch_event(7)
  • 16.29. cdist-type__consul_watch_key(7)
  • 16.30. cdist-type__consul_watch_keyprefix(7)
  • 16.31. cdist-type__consul_watch_nodes(7)
  • 16.32. cdist-type__consul_watch_service(7)
  • 16.33. cdist-type__consul_watch_services(7)
  • 16.34. cdist-type__cron(7)
  • 16.35. cdist-type__daemontools(7)
  • 16.36. cdist-type__daemontools_service(7)
  • 16.37. cdist-type__debconf_set_selections(7)
  • 16.38. cdist-type__directory(7)
  • 16.39. cdist-type__docker(7)
  • 16.40. cdist-type__docker_compose(7)
  • 16.41. cdist-type__docker_config(7)
  • 16.42. cdist-type__docker_secret(7)
  • 16.43. cdist-type__docker_stack(7)
  • 16.44. cdist-type__docker_swarm(7)
  • 16.45. cdist-type__dog_vdi(7)
  • 16.46. cdist-type__dot_file(7)
  • 16.47. cdist-type__file(7)
  • 16.48. cdist-type__filesystem(7)
  • 16.49. cdist-type__firewalld_rule(7)
  • 16.50. cdist-type__firewalld_start(7)
  • 16.51. cdist-type__git(7)
  • 16.52. cdist-type__go_get(7)
  • 16.53. cdist-type__golang_from_vendor(7)
  • 16.54. cdist-type__grafana_dashboard(7)
  • 16.55. cdist-type__group(7)
  • 16.56. cdist-type__hostname(7)
  • 16.57. cdist-type__hosts(7)
  • 16.58. cdist-type__install_bootloader_grub(7)
  • 16.59. cdist-type__install_chroot_mount(7)
  • 16.60. cdist-type__install_chroot_umount(7)
  • 16.61. cdist-type__install_config(7)
  • 16.62. cdist-type__install_coreos(7)
  • 16.63. cdist-type__directory(7)
  • 16.64. cdist-type__install_file(7)
  • 16.65. cdist-type__install_fstab(7)
  • 16.66. cdist-type__install_generate_fstab(7)
  • 16.67. cdist-type__install_mkfs(7)
  • 16.68. cdist-type__install_mount(7)
  • 16.69. cdist-type__install_partition_msdos(7)
  • 16.70. cdist-type__install_partition_msdos_apply(7)
  • 16.71. cdist-type__install_reboot(7)
  • 16.72. cdist-type__install_reset_disk(7)
  • 16.73. cdist-type__install_stage(7)
  • 16.74. cdist-type__install_umount(7)
  • 16.75. cdist-type__iptables_apply(7)
  • 16.76. cdist-type__iptables_rule(7)
  • 16.77. cdist-type__issue(7)
  • 16.78. cdist-type__jail(7)
  • 16.79. cdist-type__jail_freebsd10(7)
  • 16.80. cdist-type__jail_freebsd9(7)
  • 16.81. cdist-type__key_value(7)
  • 16.82. cdist-type__keyboard(7)
  • 16.83. cdist-type__letsencrypt_cert(7)
  • 16.84. cdist-type__line(7)
  • 16.85. cdist-type__link(7)
  • 16.86. cdist-type__locale(7)
  • 16.87. cdist-type__locale_system(7)
  • 16.88. cdist-type__motd(7)
  • 16.89. cdist-type__mount(7)
  • 16.90. cdist-type__mysql_database(7)
  • 16.91. cdist-type__package(7)
  • 16.92. cdist-type__package_apt(7)
  • 16.93. cdist-type__package_dpkg(7)
  • 16.94. cdist-type__package_emerge(7)
  • 16.95. cdist-type__package_emerge_dependencies(7)
  • 16.96. cdist-type__package_luarocks(7)
  • 16.97. cdist-type__package_opkg(7)
  • 16.98. cdist-type__package_pacman(7)
  • 16.99. cdist-type__package_pip(7)
  • 16.100. cdist-type__package_pkg_freebsd(7)
  • 16.101. cdist-type__package_pkg(7)
  • 16.102. cdist-type__package_pkgng_freebsd(7)
  • 16.103. cdist-type__package_rubygem(7)
  • 16.104. cdist-type__package_update_index(7)
  • 16.105. cdist-type__package_upgrade_all(7)
  • 16.106. cdist-type__package_yum(7)
  • 16.107. cdist-type__package_zypper(7)
  • 16.108. cdist-type__pacman_conf(7)
  • 16.109. cdist-type__pacman_conf_integrate(7)
  • 16.110. cdist-type__pf_apply(7)
  • 16.111. cdist-type__pf_ruleset(7)
  • 16.112. cdist-type__ping(7)
  • 16.113. cdist-type__postfix(7)
  • 16.114. cdist-type__postfix_master(7)
  • 16.115. cdist-type__postfix_postconf(7)
  • 16.116. cdist-type__postfix_postmap(7)
  • 16.117. cdist-type__postfix_reload(7)
  • 16.118. cdist-type__postgres_database(7)
  • 16.119. cdist-type__postgres_extension(7)
  • 16.120. cdist-type__postgres_role(7)
  • 16.121. cdist-type__process(7)
  • 16.122. cdist-type__prometheus_alertmanager(7)
  • 16.123. cdist-type__prometheus_exporter(7)
  • 16.124. cdist-type__prometheus_server(7)
  • 16.125. cdist-type__pyvenv(7)
  • 16.126. cdist-type__qemu_img(7)
  • 16.127. cdist-type__rbenv(7)
  • 16.128. cdist-type__rsync(7)
  • 16.129. cdist-type__rvm(7)
  • 16.130. cdist-type__rvm_gemset(7)
  • 16.131. cdist-type__rvm_gemset(7)
  • 16.132. cdist-type__rvm_ruby(7)
  • 16.133. cdist-type__ssh_authorized_key(7)
  • 16.134. cdist-type__ssh_authorized_keys(7)
  • 16.135. cdist-type__ssh_dot_ssh(7)
  • 16.136. cdist-type__staged_file(7)
  • 16.137. cdist-type__start_on_boot(7)
  • 16.138. cdist-type__sysctl(7)
  • 16.139. cdist-type__systemd_unit(7)
  • 16.140. cdist-type__timezone(7)
  • 16.141. cdist-type__ufw(7)
  • 16.142. cdist-type__ufw_rule(7)
  • 16.143. cdist-type__update_alternatives(7)
  • 16.144. cdist-type__user(7)
  • 16.145. cdist-type__user_groups(7)
  • 16.146. cdist-type__yum_repo(7)
  • 16.147. cdist-type__zypper_repo(7)
  • 16.148. cdist-type__zypper_service(7)
• 17. Explorer
  • 17.1. Description
  • 17.2. Examples
• 18. Messaging
  • 18.1. Description
  • 18.2. Availability
  • 18.3. Examples
• 19. Parallelization
  • 19.1. Description
  • 19.2. Examples
  • 19.3. Caveats
• 20. Inventory
  • 20.1. Introduction
  • 20.2. Description
  • 20.3. cdist inventory interface
  • 20.4. Configuring hosts using inventory
  • 20.5. Examples
  • 20.6. Example of manipulating database
  • 20.7. Using external inventory
• 21. Trigger
  • 21.1. Description
• 22. PreOS
  • 22.1. Description
  • 22.2. PreOS creation
  • 22.3. Implementing new PreOS sub-command
  • 22.4. Simple tipical use case for using PreOS and trigger
• 23. cdist integration / using cdist as library
  • 23.1. Description
  • 23.2. Examples
• 24. Reference
  • 24.1. Explorers
  • 24.2. Paths
  • 24.3. Types
  • 24.4. Objects
  • 24.5. Environment variables (for reading)
  • 24.6. Environment variables (for writing)
• 25. Best practice
  • 25.1. Passwordless connections
  • 25.2. Speeding up ssh connections
  • 25.3. Speeding up shell execution
  • 25.4. Multi master or environment setups
  • 25.5. Separating work by groups
  • 25.6. Maintaining multiple configurations
  • 25.7. Multiple developers with different trust
  • 25.8. Templating
  • 25.9. Testing a new type
  • 25.10. Other content in cdist repository
• 26. Execution stages
  • 26.1. Description
  • 26.2. Stage 1: target information retrieval
  • 26.3. Stage 2: run the initial manifest
  • 26.4. Stage 3: object information retrieval
  • 26.5. Stage 4: run the object manifest
  • 26.6. Stage 5: code generation
  • 26.7. Stage 6: code execution
  • 26.8. Stage 7: cache
  • 26.9. Summary
• 27. Local cache overview
  • 27.1. Description
  • 27.2. Cache overview
• 28. Saving output streams
  • 28.1. Description
• 29. Remote exec and copy commands
• 30. Hacking
  • 30.1. Welcome
  • 30.2. Reporting bugs
  • 30.3. Coding conventions (everywhere)
  • 30.4. How to submit stuff for inclusion into upstream cdist
  • 30.5. How to submit a new type
  • 30.6. Example git workflow
• 31. Troubleshooting
  • 31.1. Error in manifest is not considered an error by cdist
  • 31.2. Using debug dump helper script