docs: correct and simplify example (#450)
* docs: correct and simplify example * docs: removing alternatives Co-authored-by: Yusuke Kuoka <ykuoka@gmail.com>
This commit is contained in:
		
							parent
							
								
									2e551c9d0a
								
							
						
					
					
						commit
						325c2cc385
					
				
							
								
								
									
										21
									
								
								README.md
								
								
								
								
							
							
						
						
									
										21
									
								
								README.md
								
								
								
								
							| 
						 | 
					@ -88,7 +88,6 @@ spec:
 | 
				
			||||||
  template:
 | 
					  template:
 | 
				
			||||||
    spec:
 | 
					    spec:
 | 
				
			||||||
      enterprise: your-enterprise-name
 | 
					      enterprise: your-enterprise-name
 | 
				
			||||||
      dockerdWithinRunnerContainer: true
 | 
					 | 
				
			||||||
      resources:
 | 
					      resources:
 | 
				
			||||||
        limits:
 | 
					        limits:
 | 
				
			||||||
          cpu: "4000m"
 | 
					          cpu: "4000m"
 | 
				
			||||||
| 
						 | 
					@ -96,12 +95,6 @@ spec:
 | 
				
			||||||
        requests:
 | 
					        requests:
 | 
				
			||||||
          cpu: "200m"
 | 
					          cpu: "200m"
 | 
				
			||||||
          memory: "200Mi"
 | 
					          memory: "200Mi"
 | 
				
			||||||
      volumeMounts:
 | 
					 | 
				
			||||||
      - mountPath: /runner
 | 
					 | 
				
			||||||
        name: runner
 | 
					 | 
				
			||||||
      volumes:
 | 
					 | 
				
			||||||
      - name: runner
 | 
					 | 
				
			||||||
        emptyDir: {}
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -798,17 +791,3 @@ NAME=$DOCKER_USER/actions-runner-controller \
 | 
				
			||||||
 | 
					
 | 
				
			||||||
**Runner Tests**<br />
 | 
					**Runner Tests**<br />
 | 
				
			||||||
A set of example pipelines (./acceptance/pipelines) are provided in this repository which you can use to validate your runners are working as expected. When raising a PR please run the relevant suites to prove your change hasn't broken anything.
 | 
					A set of example pipelines (./acceptance/pipelines) are provided in this repository which you can use to validate your runners are working as expected. When raising a PR please run the relevant suites to prove your change hasn't broken anything.
 | 
				
			||||||
 | 
					 | 
				
			||||||
# Alternatives
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
The following is a list of alternative solutions that may better fit you depending on your use-case:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- <https://github.com/evryfs/github-actions-runner-operator/>
 | 
					 | 
				
			||||||
- <https://github.com/philips-labs/terraform-aws-github-runner/>
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Although the situation can change over time, as of writing this sentence, the benefits of using `actions-runner-controller` over the alternatives are:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- `actions-runner-controller` has the ability to autoscale runners based on number of pending/progressing jobs (#99)
 | 
					 | 
				
			||||||
- `actions-runner-controller` is able to gracefully stop runners (#103)
 | 
					 | 
				
			||||||
- `actions-runner-controller` has ARM support
 | 
					 | 
				
			||||||
- `actions-runner-controller` has GitHub Enterprise support (see [GitHub Enterprise support](#github-enterprise-support) section for caveats)
 | 
					 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue