update confdir paths
Signed-off-by: Nico Schottelius <nico@brief.schottelius.org>
This commit is contained in:
		
					parent
					
						
							
								2241576105
							
						
					
				
			
			
				commit
				
					
						dd9083327d
					
				
			
		
					 5 changed files with 17 additions and 17 deletions
				
			
		|  | @ -59,7 +59,7 @@ cat << eof | ||||||
| 
 | 
 | ||||||
| PATHS | PATHS | ||||||
| ----- | ----- | ||||||
| $HOME/.cdist:: | \$HOME/.cdist:: | ||||||
|     The standard cdist configuration directory relative to your home directory |     The standard cdist configuration directory relative to your home directory | ||||||
|     This is usually the place you want to store your site specific configuration |     This is usually the place you want to store your site specific configuration | ||||||
| 
 | 
 | ||||||
|  | @ -72,7 +72,7 @@ confdir:: | ||||||
|     a temporary confdir containing links to the real configuration directories. |     a temporary confdir containing links to the real configuration directories. | ||||||
|     This way it is possible to merge configuration directories. |     This way it is possible to merge configuration directories. | ||||||
| 
 | 
 | ||||||
|     By default it consists of everything in $HOME/.cdist and cdist/conf/. |     By default it consists of everything in \$HOME/.cdist and cdist/conf/. | ||||||
| 
 | 
 | ||||||
|     For more details see cdist(1) |     For more details see cdist(1) | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  | @ -78,7 +78,7 @@ EXAMPLES | ||||||
| # Configure ikq05.ethz.ch with debug enabled | # Configure ikq05.ethz.ch with debug enabled | ||||||
| cdist config -d ikq05.ethz.ch | cdist config -d ikq05.ethz.ch | ||||||
| 
 | 
 | ||||||
| # Configure hosts in parallel and use a different home directory | # Configure hosts in parallel and use a different configuration directory | ||||||
| cdist config -c ~/p/cdist-nutzung \ | cdist config -c ~/p/cdist-nutzung \ | ||||||
|     -p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch |     -p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  | @ -44,7 +44,7 @@ work nor kill the authors brain: | ||||||
| 
 | 
 | ||||||
| - All files should contain the usual header (Author, Copying, etc.) | - All files should contain the usual header (Author, Copying, etc.) | ||||||
| - Code submission must be done via git | - Code submission must be done via git | ||||||
| - Do not add conf/manifest/init - This file should only be touched in your | - Do not add cdist/conf/manifest/init - This file should only be touched in your | ||||||
|   private branch! |   private branch! | ||||||
| - Code to be included should be branched of the upstream "master" branch | - Code to be included should be branched of the upstream "master" branch | ||||||
|    - Exception: Bugfixes to a version branch |    - Exception: Bugfixes to a version branch | ||||||
|  |  | ||||||
|  | @ -16,8 +16,8 @@ An object is represented by the combination of | ||||||
| **type + slash + object name**: **__file/etc/cdist-configured** is an | **type + slash + object name**: **__file/etc/cdist-configured** is an | ||||||
| object of the type ***__file*** with the name ***etc/cdist-configured***. | object of the type ***__file*** with the name ***etc/cdist-configured***. | ||||||
| 
 | 
 | ||||||
| All available types can be found in the **conf/type/** directory, | All available types can be found in the **cdist/conf/type/** directory, | ||||||
| use **ls conf/type** to get the list of available types. If you have | use **ls cdist/conf/type** to get the list of available types. If you have | ||||||
| setup the MANPATH correctly, you can use **man cdist-reference** to access | setup the MANPATH correctly, you can use **man cdist-reference** to access | ||||||
| the reference with pointers to the manpages. | the reference with pointers to the manpages. | ||||||
| 
 | 
 | ||||||
|  | @ -57,7 +57,7 @@ DEFINE STATE IN THE INITIAL MANIFEST | ||||||
| ------------------------------------ | ------------------------------------ | ||||||
| The **initial manifest** is the entry point for cdist to find out, which | The **initial manifest** is the entry point for cdist to find out, which | ||||||
| **objects** to configure on the selected host. | **objects** to configure on the selected host. | ||||||
| Cdist searches for the initial manifest at **conf/manifest/init**. | Cdist searches for the initial manifest at **cdist/conf/manifest/init**. | ||||||
| 
 | 
 | ||||||
| Within this initial manifest, you define, which objects should be | Within this initial manifest, you define, which objects should be | ||||||
| created on which host. To distinguish between hosts, you can use the | created on which host. To distinguish between hosts, you can use the | ||||||
|  | @ -88,7 +88,7 @@ command. | ||||||
| SPLITTING UP THE INITIAL MANIFEST | SPLITTING UP THE INITIAL MANIFEST | ||||||
| --------------------------------- | --------------------------------- | ||||||
| If you want to split up your initial manifest, you can create other shell | If you want to split up your initial manifest, you can create other shell | ||||||
| scripts in **conf/manifest/** and include them in **conf/manifest/init**. | scripts in **cdist/conf/manifest/** and include them in **cdist/conf/manifest/init**. | ||||||
| Cdist provides the environment variable ***__manifest*** to reference to | Cdist provides the environment variable ***__manifest*** to reference to | ||||||
| the directory containing the initial manifest (see cdist-reference(7)). | the directory containing the initial manifest (see cdist-reference(7)). | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  | @ -64,10 +64,10 @@ A type consists of | ||||||
| - explorer  (optional) | - explorer  (optional) | ||||||
| - gencode   (optional) | - gencode   (optional) | ||||||
| 
 | 
 | ||||||
| Types are stored below conf/type/. Their name should always be prefixed with | Types are stored below cdist/conf/type/. Their name should always be prefixed with | ||||||
| two underscores (__) to prevent collisions with other executables in $PATH. | two underscores (__) to prevent collisions with other executables in $PATH. | ||||||
| 
 | 
 | ||||||
| To begin a new type, just create the directory **conf/type/__NAME**. | To begin a new type, just create the directory **cdist/conf/type/__NAME**. | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| DEFINING PARAMETERS | DEFINING PARAMETERS | ||||||
|  | @ -84,10 +84,10 @@ or no parameters at all. | ||||||
| 
 | 
 | ||||||
| Example: | Example: | ||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||||||
| echo servername >> conf/type/__nginx_vhost/parameter/required | echo servername >> cdist/conf/type/__nginx_vhost/parameter/required | ||||||
| echo logdirectory >> conf/type/__nginx_vhost/parameter/optional | echo logdirectory >> cdist/conf/type/__nginx_vhost/parameter/optional | ||||||
| echo server_alias >> conf/type/__nginx_vhost/parameter/optional_multiple | echo server_alias >> cdist/conf/type/__nginx_vhost/parameter/optional_multiple | ||||||
| echo use_ssl >> conf/type/__nginx_vhost/parameter/boolean | echo use_ssl >> cdist/conf/type/__nginx_vhost/parameter/boolean | ||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|  | @ -98,7 +98,7 @@ The parameters given to a type can be accessed and used in all type scripts | ||||||
| represented by file existence. File exists -> True, | represented by file existence. File exists -> True, | ||||||
| file does not exist -> False | file does not exist -> False | ||||||
| 
 | 
 | ||||||
| Example: (e.g. in conf/type/__nginx_vhost/manifest) | Example: (e.g. in cdist/conf/type/__nginx_vhost/manifest) | ||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||||||
| # required parameter | # required parameter | ||||||
| servername="$(cat "$__object/parameter/servername")" | servername="$(cat "$__object/parameter/servername")" | ||||||
|  | @ -129,7 +129,7 @@ INPUT FROM STDIN | ||||||
| Every type can access what has been written on stdin when it has been called. | Every type can access what has been written on stdin when it has been called. | ||||||
| The result is saved into the ***stdin*** file in the object directory. | The result is saved into the ***stdin*** file in the object directory. | ||||||
| 
 | 
 | ||||||
| Example use of a type: (e.g. in conf/type/__archlinux_hostname) | Example use of a type: (e.g. in cdist/conf/type/__archlinux_hostname) | ||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||||||
| __file /etc/rc.conf --source - << eof | __file /etc/rc.conf --source - << eof | ||||||
| ... | ... | ||||||
|  | @ -186,7 +186,7 @@ mark it as a singleton: Just create the (empty) file "singleton" in your type | ||||||
| directory: | directory: | ||||||
| 
 | 
 | ||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||||||
| touch conf/type/__NAME/singleton | touch cdist/conf/type/__NAME/singleton | ||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||||||
| 
 | 
 | ||||||
| This will also change the way your type must be called: | This will also change the way your type must be called: | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue