Update README.md
This commit is contained in:
		
							parent
							
								
									70aef4838b
								
							
						
					
					
						commit
						4cb075bf43
					
				
							
								
								
									
										76
									
								
								README.md
								
								
								
								
							
							
						
						
									
										76
									
								
								README.md
								
								
								
								
							|  | @ -6,7 +6,45 @@ Kubernetes native Jenkins operator. | ||||||
| 
 | 
 | ||||||
| Can be found [here][developer_guide]. | Can be found [here][developer_guide]. | ||||||
| 
 | 
 | ||||||
| ## Configuration | ## TODO | ||||||
|  | 
 | ||||||
|  | Common: | ||||||
|  | * VirtusLab docker registry (in-progress) | ||||||
|  | * simple library for sending Kubernetes events using one common format | ||||||
|  | * decorate Jenkins API client and add more functions for handling jobs and builds e.g. Ensure, ~~CreateOrUpdate~~ | ||||||
|  | * documentation [github pages with Hugo](https://gohugo.io/): | ||||||
|  |     * Installation | ||||||
|  |     * Getting Started | ||||||
|  |         * Authorization | ||||||
|  |         * Plugins | ||||||
|  |         * Seed jobs | ||||||
|  |         * Backup and Restore | ||||||
|  |     * How it works | ||||||
|  |         * architecture | ||||||
|  |         * CR definition | ||||||
|  |         * K8s events | ||||||
|  |         * Debugging | ||||||
|  |         * Base and User configuration | ||||||
|  |     * Contributing  | ||||||
|  | * VirtusLab flavored Jenkins [theme](http://afonsof.com/jenkins-material-theme/) | ||||||
|  | 
 | ||||||
|  | Base configuration: | ||||||
|  | * install configuration as a code Jenkins plugin | ||||||
|  | * handle Jenkins restart when base configuration has changed | ||||||
|  | * install and configure Kubernetes plugin (in-progress) | ||||||
|  | * e2e pipelines using Kubernetes plugin | ||||||
|  | * Jenkins hardening, disable insecure options | ||||||
|  | 
 | ||||||
|  | User configuration: | ||||||
|  | * ~~user reconciliation loop with CR validation~~ | ||||||
|  | * ~~configure seed jobs and deploy keys~~ | ||||||
|  | * ~~e2e tests for seed jobs~~ | ||||||
|  | * configure Jenkins authorization (via configuration as a code plugin or groovy scripts) | ||||||
|  | * backup and restore for Jenkins jobs running as standalone job (AWS, GCP, Azure) | ||||||
|  | * trigger backup job before pod deletion using preStop k8s hooks | ||||||
|  | * verify Jenkins configuration events | ||||||
|  | 
 | ||||||
|  | ## Configuration (this section has to be moved to external docs) | ||||||
| 
 | 
 | ||||||
| This section describes Jenkins configuration. | This section describes Jenkins configuration. | ||||||
| 
 | 
 | ||||||
|  | @ -73,42 +111,6 @@ spec: | ||||||
| 
 | 
 | ||||||
| Jenkins operator will automatically configure and trigger Seed Job Pipeline for all entries from `Jenkins.spec.seedJobs`. | Jenkins operator will automatically configure and trigger Seed Job Pipeline for all entries from `Jenkins.spec.seedJobs`. | ||||||
| 
 | 
 | ||||||
| ## TODO |  | ||||||
| 
 |  | ||||||
| Common: |  | ||||||
| * VirtusLab docker registry (in-progress) |  | ||||||
| * simple library for sending Kubernetes events using one common format |  | ||||||
| * decorate Jenkins API client and add more function for handling jobs e.g. Ensure, CreateOrUpdate |  | ||||||
| * documentation [github pages with Hugo](https://gohugo.io/): |  | ||||||
|     * Installation |  | ||||||
|     * Getting Started |  | ||||||
|         * Plugins |  | ||||||
|         * Seed jobs |  | ||||||
|         * Backup and Restore |  | ||||||
|     * How it works |  | ||||||
|         * architecture |  | ||||||
|         * CR definition |  | ||||||
|         * K8s events |  | ||||||
|         * Debugging |  | ||||||
|         * Base and User configuration |  | ||||||
|     * Contributing  |  | ||||||
| * VirtusLab flavored Jenkins [theme](http://afonsof.com/jenkins-material-theme/) |  | ||||||
| 
 |  | ||||||
| Base configuration: |  | ||||||
| * install configuration as a code Jenkins plugin |  | ||||||
| * handle Jenkins restart when base configuration has changed |  | ||||||
| * install and configure Kubernetes plugin (in-progress) |  | ||||||
| * e2e pipelines using Kubernetes plugin |  | ||||||
| * Jenkins hardening, disable insecure options |  | ||||||
| 
 |  | ||||||
| User configuration: |  | ||||||
| * ~~user reconciliation loop with CR validation~~ |  | ||||||
| * ~~configure seed jobs and deploy keys~~ |  | ||||||
| * ~~e2e tests for seed jobs~~ |  | ||||||
| * configure Jenkins authorization (via configuration as a code plugin or groovy scripts) |  | ||||||
| * backup and restore for Jenkins jobs running as standalone job |  | ||||||
| * trigger backup job before pod deletion using preStop k8s hooks |  | ||||||
| * verify Jenkins configuration events |  | ||||||
| 
 | 
 | ||||||
| [developer_guide]:doc/developer-guide.md | [developer_guide]:doc/developer-guide.md | ||||||
| [job-dsl]:https://github.com/jenkinsci/job-dsl-plugin | [job-dsl]:https://github.com/jenkinsci/job-dsl-plugin | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue