forked from ungleich-public/cdist
		
	describe how to submit a new cdist type for inclusion
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
		
					parent
					
						
							
								cc28d4ddbb
							
						
					
				
			
			
				commit
				
					
						bc436c6c5c
					
				
			
		
					 1 changed files with 31 additions and 22 deletions
				
			
		| 
						 | 
					@ -103,37 +103,46 @@ echo logdirectory >> conf/type/__nginx_vhost/parameter/optional
 | 
				
			||||||
 | 
					
 | 
				
			||||||
WRITING THE MANIFEST
 | 
					WRITING THE MANIFEST
 | 
				
			||||||
--------------------
 | 
					--------------------
 | 
				
			||||||
 | 
					In the manifest of a type you can use other types, so your type extends
 | 
				
			||||||
 | 
					their functionality. A good example is the __package type, which in
 | 
				
			||||||
 | 
					a shortened version looks like this:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
HOW TO WRITE A NEW TYPE (TODO)
 | 
					--------------------------------------------------------------------------------
 | 
				
			||||||
------------------------------
 | 
					os="$(cat "$__global/explorer/os")"
 | 
				
			||||||
Assume you want to create the new type named "coffee", which creates
 | 
					case "$os" in
 | 
				
			||||||
files which contain the word "c0ffee".
 | 
					      archlinux) type="pacman" ;;
 | 
				
			||||||
 | 
					      debian|ubuntu) type="apt" ;;
 | 
				
			||||||
 | 
					      gentoo) type="emerge" ;;
 | 
				
			||||||
 | 
					      *)
 | 
				
			||||||
 | 
					         echo "Don't know how to manage packages on: $os" >&2
 | 
				
			||||||
 | 
					         exit 1
 | 
				
			||||||
 | 
					      ;;
 | 
				
			||||||
 | 
					esac
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Create the directory conf/type/coffee/.
 | 
					__package_$type "$@"
 | 
				
			||||||
Create the file /etc/cdist/types/coffee/README containing a description of the 
 | 
					--------------------------------------------------------------------------------
 | 
				
			||||||
type.
 | 
					 | 
				
			||||||
If your type supports attributes, create the directory /etc/cdist/types/coffee/
 | 
					 | 
				
			||||||
attributes.
 | 
					 | 
				
			||||||
For each attribute, create the file
 | 
					 | 
				
			||||||
   /etc/cdist/types/coffee/attributes/$attribute_name which contains
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
   a short description on the first line
 | 
					As you can see, the type can reference different environment variables,
 | 
				
			||||||
   then a blank line
 | 
					which are documented in cdist-environment-variables(7).
 | 
				
			||||||
   then a long description (probably over several lines)
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
If you think your type may be useful for others, submit it for inclusion
 | 
					Always ensure the manifest is executable, otherwise cdist will not be able
 | 
				
			||||||
into cdist at cdist -- at -- l.schottelius.org.
 | 
					to execute it.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Create /etc/cdist/types/coffee/init which reads $configinput
 | 
					WRITING THE GENCODE SCRIPT
 | 
				
			||||||
(either via cconfig or via environment) and outputs a block of
 | 
					--------------------------
 | 
				
			||||||
shell code suitable for running on the client.
 | 
					
 | 
				
			||||||
 | 
					HOW TO INCLUDE A TYPE INTO UPSTREAM CDIST
 | 
				
			||||||
 | 
					-----------------------------------------
 | 
				
			||||||
 | 
					If you think your type may be useful for others, ensure it works with the
 | 
				
			||||||
 | 
					current master branch of cdist and submit the git url containing the type for
 | 
				
			||||||
 | 
					inclusion to the mailinglist **cdist at cdist -- at -- l.schottelius.org**.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Ensure there is a corresponding manpage named cdist-type-NAME (without
 | 
				
			||||||
 | 
					underscores) included.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
SEE ALSO
 | 
					SEE ALSO
 | 
				
			||||||
--------
 | 
					--------
 | 
				
			||||||
cdist-config-layout(7), cdist-type-manifest(7), cdist-type-explorer(7),
 | 
					 | 
				
			||||||
cdist-type-gencode(7)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- cdist-manifest-run(1)
 | 
					- cdist-manifest-run(1)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue