Create Simplified README.md with only 'Getting Started' steps and with links to additional detailed documentation. (#1864)
* Update with recent changes from README.md * Update README.md This is the final phase of simplifying README.md - include only Getting started` steps ( These steps were earlier reviewed as part of /docs/QuickStartGuide.md) - links to a detailed documentation ( the detailed documentation is a copy of the current README.md) Once this is merged, any new detailed docs should be captured in /docs/detailed-docs.md * Update detailed-docs.md Redo the change made in #1873 Co-authored-by: Yusuke Kuoka <ykuoka@gmail.com>
This commit is contained in:
		
							parent
							
								
									863760828a
								
							
						
					
					
						commit
						0c003f20d4
					
				|  | @ -2,6 +2,7 @@ | ||||||
| 
 | 
 | ||||||
| [](https://bestpractices.coreinfrastructure.org/projects/6061) | [](https://bestpractices.coreinfrastructure.org/projects/6061) | ||||||
| [](https://github.com/jonico/awesome-runners) | [](https://github.com/jonico/awesome-runners) | ||||||
|  | [](https://artifacthub.io/packages/search?repo=actions-runner-controller) | ||||||
| 
 | 
 | ||||||
| This controller operates self-hosted runners for GitHub Actions on your Kubernetes cluster. | This controller operates self-hosted runners for GitHub Actions on your Kubernetes cluster. | ||||||
| 
 | 
 | ||||||
|  | @ -50,7 +51,7 @@ ToC: | ||||||
| 
 | 
 | ||||||
| ## People | ## People | ||||||
| 
 | 
 | ||||||
| `actions-runner-controller`(ARC) is an open-source project currently developed and maintained in collaboration with maintainers @mumoshu and @toast-gear, various [contributors](https://github.com/actions-runner-controller/actions-runner-controller/graphs/contributors), and the [awesome community](https://github.com/actions-runner-controller/actions-runner-controller/discussions), mostly in their spare time. | `actions-runner-controller` is an open-source project currently developed and maintained in collaboration with maintainers @mumoshu and @toast-gear, various [contributors](https://github.com/actions-runner-controller/actions-runner-controller/graphs/contributors), and the [awesome community](https://github.com/actions-runner-controller/actions-runner-controller/discussions), mostly in their spare time. | ||||||
| 
 | 
 | ||||||
| If you think the project is awesome and it's becoming a basis for your important business, consider [sponsoring us](https://github.com/sponsors/actions-runner-controller)! | If you think the project is awesome and it's becoming a basis for your important business, consider [sponsoring us](https://github.com/sponsors/actions-runner-controller)! | ||||||
| 
 | 
 | ||||||
|  | @ -76,14 +77,14 @@ The documentation is kept inline with master@HEAD, we do our best to highlight a | ||||||
| 
 | 
 | ||||||
| **actions-runner-controller** makes that possible. Just create a *Runner* resource on your Kubernetes, and it will run and operate the self-hosted runner for the specified repository. Combined with Kubernetes RBAC, you can also build simple Self-hosted runners as a Service. | **actions-runner-controller** makes that possible. Just create a *Runner* resource on your Kubernetes, and it will run and operate the self-hosted runner for the specified repository. Combined with Kubernetes RBAC, you can also build simple Self-hosted runners as a Service. | ||||||
| 
 | 
 | ||||||
| 
 |  | ||||||
| 
 |  | ||||||
| ## Getting Started | ## Getting Started | ||||||
| To give ARC a try with just a handful of commands, Please refer to [Quick start guide](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/docs/QuickStartGuide.md).  | To give ARC a try with just a handful of commands, Please refer to [Quick start guide](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/docs/QuickStartGuide.md).  | ||||||
| 
 | 
 | ||||||
| For an overview of ARC, please refer to [ARC Overview](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/docs/Actions-Runner-Controller-Overview.md) | For an overview of ARC, please refer to [ARC Overview](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/docs/Actions-Runner-Controller-Overview.md) | ||||||
| 
 | 
 | ||||||
| For more information, please refer to detailed documentation below | For more information, please refer to detailed documentation below! | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
| ## Installation | ## Installation | ||||||
| 
 | 
 | ||||||
| By default, actions-runner-controller uses [cert-manager](https://cert-manager.io/docs/installation/kubernetes/) for certificate management of Admission Webhook. Make sure you have already installed cert-manager before you install. The installation instructions for the cert-manager can be found below. | By default, actions-runner-controller uses [cert-manager](https://cert-manager.io/docs/installation/kubernetes/) for certificate management of Admission Webhook. Make sure you have already installed cert-manager before you install. The installation instructions for the cert-manager can be found below. | ||||||
|  | @ -626,7 +627,8 @@ spec: | ||||||
|   metrics: |   metrics: | ||||||
|   - type: TotalNumberOfQueuedAndInProgressWorkflowRuns |   - type: TotalNumberOfQueuedAndInProgressWorkflowRuns | ||||||
|     repositoryNames: |     repositoryNames: | ||||||
|     - example/myrepo |     # A repository name is the REPO part of `github.com/OWNER/REPO` | ||||||
|  |     - myrepo | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| **PercentageRunnersBusy** | **PercentageRunnersBusy** | ||||||
|  | @ -1583,6 +1585,10 @@ spec: | ||||||
| 
 | 
 | ||||||
| ### Using without cert-manager | ### Using without cert-manager | ||||||
| 
 | 
 | ||||||
|  | There are two methods of deploying without cert-manager, you can generate your own certificates or rely on helm to generate a CA and certificate each time you update the chart. | ||||||
|  | 
 | ||||||
|  | #### Using custom certificates | ||||||
|  | 
 | ||||||
| Assuming you are installing in the default namespace, ensure your certificate has SANs: | Assuming you are installing in the default namespace, ensure your certificate has SANs: | ||||||
| 
 | 
 | ||||||
| * `webhook-service.actions-runner-system.svc` | * `webhook-service.actions-runner-system.svc` | ||||||
|  | @ -1610,6 +1616,18 @@ $ helm --upgrade install actions-runner-controller/actions-runner-controller \ | ||||||
|   admissionWebHooks.caBundle=${CA_BUNDLE} |   admissionWebHooks.caBundle=${CA_BUNDLE} | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
|  | #### Using helm to generate CA and certificates | ||||||
|  | 
 | ||||||
|  | Set the Helm chart values as follows: | ||||||
|  | 
 | ||||||
|  | ```shell | ||||||
|  | $ CA_BUNDLE=$(cat path/to/ca.pem | base64) | ||||||
|  | $ helm --upgrade install actions-runner-controller/actions-runner-controller \ | ||||||
|  |   certManagerEnabled=false | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | This generates a temporary CA using the helm `genCA` function and issues a certificate for the webhook. Note that this approach rotates the CA and certificate each time `helm install` or `helm upgrade` are run. In effect, this will cause short interruptions to the mutating webhook while the ARC pods stabilize and use the new certificate each time `helm upgrade` is called for the chart. The outage can affect kube-api activity due to the way mutating webhooks are called. | ||||||
|  | 
 | ||||||
| ### Setting up Windows Runners | ### Setting up Windows Runners | ||||||
| 
 | 
 | ||||||
| The main two steps in enabling Windows self-hosted runners are: | The main two steps in enabling Windows self-hosted runners are: | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue