cleanup todo for 1.0
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
		
					parent
					
						
							
								8c27d00c23
							
						
					
				
			
			
				commit
				
					
						84497e176e
					
				
			
		
					 1 changed files with 60 additions and 61 deletions
				
			
		
							
								
								
									
										121
									
								
								TODO-1.0
									
										
									
									
									
								
							
							
						
						
									
										121
									
								
								TODO-1.0
									
										
									
									
									
								
							| 
						 | 
					@ -1,71 +1,70 @@
 | 
				
			||||||
This document defines how to continue work on cdist:
 | 
					This document defines how to continue work on cdist:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
x Define how to get information from clients
 | 
					x general stuff
 | 
				
			||||||
   x Create shell script that creates code to run on client (cdist-build-explorer)
 | 
					   x Define configuration paths (doc/internal/config-layout)
 | 
				
			||||||
x Create configuration tree from manifest
 | 
					 | 
				
			||||||
   x write binaries, which create the tree when called from manifest (cdist_tree_wrapper)
 | 
					 | 
				
			||||||
x Define configuration paths (doc/internal/config-layout)
 | 
					 | 
				
			||||||
x Redo explorers (see manpage)
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
x Parse configuration tree/objects recursively
 | 
					x get information from target (stage 1)
 | 
				
			||||||
   x can/may types modify tree?
 | 
					   x Define how to get information from targets
 | 
				
			||||||
      -> yes, of everything a type created itself!
 | 
					      x Create shell script that creates code to run on client (cdist-build-explorer)
 | 
				
			||||||
      x may open door for getting information from manifest / other stuff
 | 
					   x Redo explorers (see manpage)
 | 
				
			||||||
 | 
					x run initial manifest (stage 2)
 | 
				
			||||||
 | 
					   x Create configuration tree from manifest
 | 
				
			||||||
 | 
					      x write binaries, which create the tree when called from manifest (cdist_tree_wrapper)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
x Cleanly define paths for object creation, especially recursive calls
 | 
					- be able to run manifest of types (stage 3)
 | 
				
			||||||
   x doc/man/cdist-config-layout.text
 | 
					   x Parse configuration tree/objects recursively
 | 
				
			||||||
 | 
					      x can/may types modify tree?
 | 
				
			||||||
 | 
					         -> yes, of everything a type created itself!
 | 
				
			||||||
 | 
					         x may open door for getting information from manifest / other stuff
 | 
				
			||||||
 | 
					   x Cleanly define paths for object creation, especially recursive calls
 | 
				
			||||||
 | 
					      x doc/man/cdist-config-layout.text
 | 
				
			||||||
 | 
					   x cd $__object_dir, before running manifest
 | 
				
			||||||
 | 
					   x rename $__object_dir to $__object_base_dir
 | 
				
			||||||
 | 
					   - document "cd $__object_dir, before running manifest" in doc/man/cdist-types.text
 | 
				
			||||||
 | 
					   - use $type/manifest instead of $type/init
 | 
				
			||||||
 | 
					   - document that $type/manifest is executed for every object/instance
 | 
				
			||||||
 | 
					   - find $object_id in recursive runner (before merge)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- generate code to be executed on client
 | 
					- generate code to be executed on clients (stage 4)
 | 
				
			||||||
 | 
					   x for one type (cdist-code-gen)
 | 
				
			||||||
   - check return codes
 | 
					   - check return codes
 | 
				
			||||||
   - abort on first error?
 | 
					   - abort on first error?
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- execute code on client
 | 
					- execute code on client (stage 5)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/ Write at least one type (completly!)
 | 
					- Other stuff pre 1.0:
 | 
				
			||||||
 | 
					   - Write some basic types
 | 
				
			||||||
- doc 1.0:
 | 
					      - file (with directory)
 | 
				
			||||||
   - cdist manpage (main manpage)
 | 
					      - package
 | 
				
			||||||
      - cleanup following man + their tree:
 | 
					   - doc cleanup for 1.0:
 | 
				
			||||||
         - cdist-language        [CLEANUP AND REMOVE]
 | 
					      - cdist manpage (main manpage)
 | 
				
			||||||
         - cdist-design.text     [CLEANUP AND REMOVE]
 | 
					         - cleanup following man + their tree:
 | 
				
			||||||
         - cdist-push-pull       [WRITE]
 | 
					            - cdist-language        [CLEANUP AND REMOVE]
 | 
				
			||||||
         - cdist-quickstart      [WRITE]
 | 
					            - cdist-design.text     [CLEANUP AND REMOVE]
 | 
				
			||||||
            - how to write a minimal host manifest
 | 
					            - cdist-push-pull       [WRITE]
 | 
				
			||||||
         - cdist-types           [IMPORTANT]
 | 
					            - cdist-quickstart      [WRITE]
 | 
				
			||||||
            - only do necessary work [TYPE IMPLEMENTATION HINTS]
 | 
					               - how to write a minimal host manifest
 | 
				
			||||||
               - install packages only if not existent
 | 
					            - cdist-types           [IMPORTANT]
 | 
				
			||||||
               - copy file only if different
 | 
					               - only do necessary work [TYPE IMPLEMENTATION HINTS]
 | 
				
			||||||
         - cdist                 [IMPORTANT]
 | 
					                  - install packages only if not existent
 | 
				
			||||||
         - cdist-explorers
 | 
					                  - copy file only if different
 | 
				
			||||||
      - add terminology
 | 
					            - cdist                 [IMPORTANT]
 | 
				
			||||||
      - define steps within configuration apply
 | 
					            - cdist-explorers
 | 
				
			||||||
         - detect impossible/unsafe things:
 | 
					         - add terminology
 | 
				
			||||||
         - creating a file twice
 | 
					         - define steps within configuration apply
 | 
				
			||||||
         - installing and removing a package
 | 
					            - detect impossible/unsafe things:
 | 
				
			||||||
         - and report location of occurence
 | 
					            - creating a file twice
 | 
				
			||||||
         - parse afterwards?
 | 
					            - installing and removing a package
 | 
				
			||||||
      - multi master setups
 | 
					            - and report location of occurence
 | 
				
			||||||
      - templating
 | 
					            - parse afterwards?
 | 
				
			||||||
         - how to define templates
 | 
					         - multi master setups
 | 
				
			||||||
            - variable substitution from shell may be problematic
 | 
					         - templating
 | 
				
			||||||
         - SHELL SCRIPTS! (executables? do not support?)
 | 
					            - how to define templates
 | 
				
			||||||
            - stdout == output of template == what will be used
 | 
					               - variable substitution from shell may be problematic
 | 
				
			||||||
   - cleanup website
 | 
					            - SHELL SCRIPTS! (executables? do not support?)
 | 
				
			||||||
   - remove HACKERS_README
 | 
					               - stdout == output of template == what will be used
 | 
				
			||||||
   - create doc/dev/HACKERS_README
 | 
					      - cleanup website
 | 
				
			||||||
- Add install target to Makefile
 | 
					      - remove HACKERS_README
 | 
				
			||||||
 | 
					      - create doc/dev/HACKERS_README
 | 
				
			||||||
 | 
					   - Add install target to Makefile
 | 
				
			||||||
   - create cdist-config-init to create basic tree
 | 
					   - create cdist-config-init to create basic tree
 | 
				
			||||||
 | 
					 | 
				
			||||||
- types needed
 | 
					 | 
				
			||||||
   - file (with directory)
 | 
					 | 
				
			||||||
   - package
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- Cleanup directories, cleanly document, what's possible
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- rename $__object_dir to $__object_base_dir
 | 
					 | 
				
			||||||
- cd $__object_dir, before running manifest
 | 
					 | 
				
			||||||
   && document it in doc/man/cdist-types.text
 | 
					 | 
				
			||||||
- use $type/manifest instead of $type/init
 | 
					 | 
				
			||||||
- document that $type/manifest is executed for every object/instance
 | 
					 | 
				
			||||||
- find $object_id in recursive runner
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue