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
- 9.7. SHELL
- 9.8. FILES
- 9.9. EXAMPLES
- 9.10. ENVIRONMENT
- 9.11. EXIT STATUS
- 9.12. AUTHORS
- 9.13. 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. How to write a new type
- 12.6. Defining parameters
- 12.7. Using parameters
- 12.8. Input from stdin
- 12.9. Writing the manifest
- 12.10. Singleton - one instance only
- 12.11. The type explorers
- 12.12. Writing the gencode script
- 12.13. Variable access from the generated scripts
- 12.14. Hints for typewriters
- 12.15. 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_norecommends(7)
- 13.4. cdist-type__apt_ppa(7)
- 13.5. cdist-type__apt_source(7)
- 13.6. cdist-type__apt_update_index(7)
- 13.7. cdist-type__block(7)
- 13.8. cdist-type__ccollect_source(7)
- 13.9. cdist-type__cdist(7)
- 13.10. cdist-type__cdistmarker(7)
- 13.11. cdist-type__config_file(7)
- 13.12. cdist-type__consul(7)
- 13.13. cdist-type__consul_agent(7)
- 13.14. cdist-type__consul_check(7)
- 13.15. cdist-type__consul_reload(7)
- 13.16. cdist-type__consul_service(7)
- 13.17. cdist-type__consul_template(7)
- 13.18. cdist-type__consul_template_template(7)
- 13.19. cdist-type__consul_watch_checks(7)
- 13.20. cdist-type__consul_watch_event(7)
- 13.21. cdist-type__consul_watch_key(7)
- 13.22. cdist-type__consul_watch_keyprefix(7)
- 13.23. cdist-type__consul_watch_nodes(7)
- 13.24. cdist-type__consul_watch_service(7)
- 13.25. cdist-type__consul_watch_services(7)
- 13.26. cdist-type__cron(7)
- 13.27. cdist-type__debconf_set_selections(7)
- 13.28. cdist-type__directory(7)
- 13.29. cdist-type__dog_vdi(7)
- 13.30. cdist-type__file(7)
- 13.31. cdist-type__firewalld_rule(7)
- 13.32. cdist-type__git(7)
- 13.33. cdist-type__group(7)
- 13.34. cdist-type__hostname(7)
- 13.35. cdist-type__iptables_apply(7)
- 13.36. cdist-type__iptables_rule(7)
- 13.37. cdist-type__issue(7)
- 13.38. cdist-type__jail(7)
- 13.39. cdist-type__jail_freebsd10(7)
- 13.40. cdist-type__jail_freebsd9(7)
- 13.41. cdist-type__key_value(7)
- 13.42. cdist-type__line(7)
- 13.43. cdist-type__link(7)
- 13.44. cdist-type__locale(7)
- 13.45. cdist-type__motd(7)
- 13.46. cdist-type__mount(7)
- 13.47. cdist-type__mysql_database(7)
- 13.48. cdist-type__package(7)
- 13.49. cdist-type__package_apt(7)
- 13.50. cdist-type__package_emerge(7)
- 13.51. cdist-type__package_emerge_dependencies(7)
- 13.52. cdist-type__package_luarocks(7)
- 13.53. cdist-type__package_opkg(7)
- 13.54. cdist-type__package_pacman(7)
- 13.55. cdist-type__package_pip(7)
- 13.56. cdist-type__package_pkg_freebsd(7)
- 13.57. cdist-type__package_pkg(7)
- 13.58. cdist-type__package_pkgng_freebsd(7)
- 13.59. cdist-type__package_rubygem(7)
- 13.60. cdist-type__package_update_index(7)
- 13.61. cdist-type__package_upgrade_all(7)
- 13.62. cdist-type__package_yum(7)
- 13.63. cdist-type__package_zypper(7)
- 13.64. cdist-type__pacman_conf(7)
- 13.65. cdist-type__pacman_conf_integrate(7)
- 13.66. cdist-type__pf_apply(7)
- 13.67. cdist-type__pf_ruleset(7)
- 13.68. cdist-type__postfix(7)
- 13.69. cdist-type__postfix_master(7)
- 13.70. cdist-type__postfix_postconf(7)
- 13.71. cdist-type__postfix_postmap(7)
- 13.72. cdist-type__postfix_reload(7)
- 13.73. cdist-type__postgres_database(7)
- 13.74. cdist-type__postgres_role(7)
- 13.75. cdist-type__process(7)
- 13.76. cdist-type__pyvenv(7)
- 13.77. cdist-type__qemu_img(7)
- 13.78. cdist-type__rbenv(7)
- 13.79. cdist-type__rsync(7)
- 13.80. cdist-type__rvm(7)
- 13.81. cdist-type__rvm_gemset(7)
- 13.82. cdist-type__rvm_gemset(7)
- 13.83. cdist-type__rvm_ruby(7)
- 13.84. cdist-type__ssh_authorized_key(7)
- 13.85. cdist-type__ssh_authorized_keys(7)
- 13.86. cdist-type__ssh_dot_ssh(7)
- 13.87. cdist-type__staged_file(7)
- 13.88. cdist-type__start_on_boot(7)
- 13.89. cdist-type__timezone(7)
- 13.90. cdist-type__update_alternatives(7)
- 13.91. cdist-type__user(7)
- 13.92. cdist-type__user_groups(7)
- 13.93. cdist-type__yum_repo(7)
- 13.94. cdist-type__zypper_repo(7)
- 13.95. 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. Reference
- 16.1. Explorers
- 16.2. Paths
- 16.3. Types
- 16.4. Objects
- 16.5. Environment variables (for reading)
- 16.6. Environment variables (for writing)
17. Best practice
- 17.1. Passwordless connections
- 17.2. Speeding up ssh connections
- 17.3. Speeding up shell execution
- 17.4. Multi master or environment setups
- 17.5. Seperating work by groups
- 17.6. Maintaining multiple configurations
- 17.7. Multiple developers with different trust
- 17.8. Templating
- 17.9. Testing a new type
- 17.10. Other content in cdist repository
18. Execution stages
- 18.1. Description
- 18.2. Stage 1: target information retrieval
- 18.3. Stage 2: run the initial manifest
- 18.4. Stage 3: object information retrieval
- 18.5. Stage 4: run the object manifest
- 18.6. Stage 5: code generation
- 18.7. Stage 6: code execution
- 18.8. Stage 7: cache
- 18.9. Summary
19. Remote exec and copy commands
20. Hacking
- 20.1. Welcome
- 20.2. Reporting bugs
- 20.3. Coding conventions (everywhere)
- 20.4. How to submit stuff for inclusion into upstream cdist
- 20.5. How to submit a new type
- 20.6. Example git workflow
21. Troubleshooting
- 21.1. Error in manifest is not considered an error by cdist