Improve readme #659
Merged
Improve readme #659
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marcofranssen
force-pushed
the
improve-readme
branch
from
4c9a818 to
2533dc1
Compare
marcofranssen
force-pushed
the
improve-readme
branch
7 times, most recently
from
3ab53ae to
e806ed0
Compare
npalm
requested changes
Mar 10, 2021
marcofranssen
force-pushed
the
improve-readme
branch
from
e806ed0 to
012ae4f
Compare
This enables more opensource setup actions like azure/setup-helm and workflows requiring 'make' and gcc.
marcofranssen
force-pushed
the
improve-readme
branch
from
012ae4f to
d27b8ff
Compare
npalm
approved these changes
Apr 7, 2021
ryanbrainard
reviewed
Apr 8, 2021
| The module supports two main scenarios for creating runners. On repository level a runner will be dedicated to only one repository, no other repository can use the runner. On organization level you can use the runner(s) for all the repositories within the organization. See https://help.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners for more information. Before starting the deployment you have to choose one option. | ||
| The module supports two main scenarios for creating runners. On repository level a runner will be dedicated to only one repository, no other repository can use the runner. On organization level you can use the runner(s) for all the repositories within the organization. See [GitHub instructions](https://help.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) for more information. Before starting the deployment you have to choose one option. | ||
|
|
||
| GitHub workflows fail immediately if there is no action runner available for your builds. Since this module supports scaling down to zero, builds will fail in case there is no active runner available. We recommend to create an offline runner with matching labels to the configuration. Create this runner manually by following the [GitHub instructions](https://help.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) for adding a new runner on your local machine. If you stop the process after the step of running the `config.sh` script the runner will remain offline. This offline runner ensures that builds will not fail immediately and stay queued until there is an EC2 runner to pick it up. |
There was a problem hiding this comment.
What do you think about adding to link to this in Debugging section below? I ran into this because I missed it in the setup. It could help to have to called out.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When testing the Ubuntu example I ran into a few small issues. To resolve these I have slightly updated the docs and as well added some core dependencies in this example that allows others to use the ubuntu example without having issues running workflows that utilize commonly used actions.