forked from ungleich-public/cdist
		
	cleanup todo lists
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
		
					parent
					
						
							
								0792e5aae3
							
						
					
				
			
			
				commit
				
					
						250dedc1c8
					
				
			
		
					 2 changed files with 27 additions and 43 deletions
				
			
		
							
								
								
									
										37
									
								
								TODO-1.0
									
										
									
									
									
								
							
							
						
						
									
										37
									
								
								TODO-1.0
									
										
									
									
									
								
							| 
						 | 
					@ -42,46 +42,27 @@ x generate code to be executed on clients (stage 4)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
x execute code on client (stage 5)
 | 
					x execute code on client (stage 5)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- Other stuff pre 1.0:
 | 
					- Last doc stuff for 1.0.0:
 | 
				
			||||||
   - doc cleanup for 1.0:
 | 
					 | 
				
			||||||
   - ensure every file in bin/ has a correspondent manpage
 | 
					   - ensure every file in bin/ has a correspondent manpage
 | 
				
			||||||
      - cdist manpage (main manpage)
 | 
					 | 
				
			||||||
         - cleanup following man + their tree:
 | 
					 | 
				
			||||||
            - cdist-push-pull       [WRITE]
 | 
					 | 
				
			||||||
   - cdist-quickstart      [WRITE]
 | 
					   - cdist-quickstart      [WRITE]
 | 
				
			||||||
      - how to write a minimal host manifest
 | 
					      - how to write a minimal host manifest
 | 
				
			||||||
            - cdist-types           [IMPORTANT]
 | 
					   - cdist-type           [IMPORTANT]
 | 
				
			||||||
      - only do necessary work [TYPE IMPLEMENTATION HINTS]
 | 
					      - only do necessary work [TYPE IMPLEMENTATION HINTS]
 | 
				
			||||||
         - install packages only if not existent
 | 
					         - install packages only if not existent
 | 
				
			||||||
         - copy file only if different
 | 
					         - copy file only if different
 | 
				
			||||||
 | 
					   - cdist-type-integration
 | 
				
			||||||
   - cdist                 [IMPORTANT]
 | 
					   - cdist                 [IMPORTANT]
 | 
				
			||||||
      - explain the general approach
 | 
					      - explain the general approach
 | 
				
			||||||
      - give right pointers
 | 
					      - give right pointers
 | 
				
			||||||
            - cdist-explorers
 | 
					   - cdist-explorer
 | 
				
			||||||
         - add terminology
 | 
					
 | 
				
			||||||
         - define steps within configuration apply
 | 
					 | 
				
			||||||
            - detect impossible/unsafe things:
 | 
					 | 
				
			||||||
            - creating a file twice
 | 
					 | 
				
			||||||
            - installing and removing a package
 | 
					 | 
				
			||||||
            - and report location of occurence
 | 
					 | 
				
			||||||
            - parse afterwards?
 | 
					 | 
				
			||||||
         - multi master setups
 | 
					 | 
				
			||||||
         - templating
 | 
					 | 
				
			||||||
            - how to define templates
 | 
					 | 
				
			||||||
               - variable substitution from shell may be problematic
 | 
					 | 
				
			||||||
            - SHELL SCRIPTS! (executables? do not support?)
 | 
					 | 
				
			||||||
               - stdout == output of template == what will be used
 | 
					 | 
				
			||||||
      - cleanup website
 | 
					 | 
				
			||||||
      - remove HACKERS_README
 | 
					 | 
				
			||||||
      - create doc/dev/HACKERS_README
 | 
					 | 
				
			||||||
   - Add install target to Makefile
 | 
					 | 
				
			||||||
   - create cdist-config-init to create basic tree
 | 
					 | 
				
			||||||
   - cdist-type integration!
 | 
					 | 
				
			||||||
   - DOC document "cd $__object_dir, before running manifest" in doc/man/cdist-types.text
 | 
					   - DOC document "cd $__object_dir, before running manifest" in doc/man/cdist-types.text
 | 
				
			||||||
   - DOC document that $type/manifest is executed for every object/instance
 | 
					   - DOC document that $type/manifest is executed for every object/instance
 | 
				
			||||||
   - DOC: exported variables: __type, __explorer, __type_explorer, __object, __object_id
 | 
					   - DOC: exported variables: __type, __explorer, __type_explorer, __object, __object_id
 | 
				
			||||||
 | 
					
 | 
				
			||||||
   - cleanup READMEs
 | 
					   - Cleanup READMEs
 | 
				
			||||||
   - Check all references in manpages, ensure all manpages exist
 | 
					   - Check all references in manpages, ensure all manpages exist
 | 
				
			||||||
 | 
					
 | 
				
			||||||
   - include generation in makefile
 | 
					- Makefile:
 | 
				
			||||||
 | 
					   - Add install target
 | 
				
			||||||
 | 
					   - Include manpage generation
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -18,20 +18,23 @@ Stage 5 (code execution):
 | 
				
			||||||
   - dependencies
 | 
					   - dependencies
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Types to be written:
 | 
					Types to be written/extended:
 | 
				
			||||||
   - ssh-keys (host/user)
 | 
					   - __ssh-keys (host/user)
 | 
				
			||||||
   - services
 | 
					   - __service
 | 
				
			||||||
   - user management
 | 
					   - __user
 | 
				
			||||||
   - file editing 
 | 
					   - __file_edit
 | 
				
			||||||
      - add_line_to_file_if_not_existing
 | 
					      - add_line_to_file_if_not_existing
 | 
				
			||||||
      - delete_line_from_file
 | 
					      - delete_line_from_file
 | 
				
			||||||
      - regexp replace (can probably cover all?)
 | 
					      - regexp replace (can probably cover all?)
 | 
				
			||||||
 | 
					   - __file:
 | 
				
			||||||
 | 
					      - template == [shell script] stdout
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Documentation:
 | 
					Documentation:
 | 
				
			||||||
   - Multi master setups
 | 
					   - Describe Multi master setups
 | 
				
			||||||
   - use ssh with master socket?
 | 
					   - use ssh with master socket?
 | 
				
			||||||
      - saves connection delay for new connections: -M
 | 
					      - saves connection delay for new connections: -M
 | 
				
			||||||
      - hint: http://protempore.net/~calvins/howto/ssh-connection-sharing/
 | 
					      - hint: http://protempore.net/~calvins/howto/ssh-connection-sharing/
 | 
				
			||||||
   - Describe pull architecture and requirements
 | 
					   - Describe pull architecture and requirements
 | 
				
			||||||
      - cdist-trigger after first run from /var/lib/cdist/out/bin?
 | 
					      - cdist-trigger after first run from /var/lib/cdist/out/bin?
 | 
				
			||||||
   - Different environments (production, integration, development)
 | 
					   - Different environments (production, integration, development)
 | 
				
			||||||
 | 
					      - via version control
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue