Skip to content

Commit

Permalink
Docs for GitHub-hosted runners management experience
Browse files Browse the repository at this point in the history
  • Loading branch information
nebuk89 authored Feb 23, 2022
1 parent 1e9b424 commit 4d4f7c5
Show file tree
Hide file tree
Showing 10 changed files with 66 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,14 @@ miniTocMaxHeadingLevel: 3
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}

## Monitoring your workflows
## Monitoring your workflows

{% if github-runner-dashboard %}
### Monitoring your current jobs in your organization or enterprise

{% data reusables.github-actions.github-hosted-runners-check-concurrency %}

{% endif %}

{% ifversion fpt or ghae or ghes > 3.0 or ghec %}

Expand Down
1 change: 1 addition & 0 deletions content/actions/using-github-hosted-runners/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ versions:
ghes: '*'
children:
- /about-github-hosted-runners
- /monitoring-your-current-jobs
- /customizing-github-hosted-runners
shortTitle: Use GitHub-hosted runners
---
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Monitoring your current jobs
intro: 'Monitor how {% data variables.product.prodname_dotcom %}-hosted runners are processing jobs in your organization or enterprise, and identify any related constraints.'
versions:
feature: 'github-runner-dashboard'
shortTitle: Monitoring your current jobs
---

{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}

## Viewing active jobs in your organization or enterprise

You can get a list of all jobs currently running on {% data variables.product.prodname_dotcom %}-hosted runners in your organization or enterprise.

{% data reusables.github-actions.github-hosted-runners-navigate-to-repo-org-enterprise %}
{% data reusables.github-actions.github-hosted-runners-table-entry %}
1. Review the "Active jobs" section, which contains a list of all jobs currently running on {% data variables.product.prodname_dotcom %}-hosted runners.

![Screenshot of the list of active jobs](/assets/images/help/settings/actions-runner-active-jobs.png)

## Viewing queued jobs in your organization or enterprise

{% data variables.product.prodname_dotcom %}-hosted runners allow you to run jobs concurrently, and the maximum number of concurrent jobs will vary depending on your plan. If you reach the maximum number of concurrent jobs, any new jobs will start to enter a queue. To find out more about the number of concurrent jobs available to your plan, see "[Usage limits, billing, and administration](/actions/learn-github-actions/usage-limits-billing-and-administration)."

The following procedure demonstrates how to check the maximum number of concurrent jobs you can run.

{% data reusables.github-actions.github-hosted-runners-navigate-to-repo-org-enterprise %}
{% data reusables.github-actions.github-hosted-runners-table-entry %}
1. Review the "All jobs usage" section, which lists the number of active jobs and the maximum number of jobs you can run. In this example, `9` jobs are currently running out of a maximum of `180`.
![Screenshot of the maximum jobs for an account](/assets/images/help/settings/github-hosted-runners-max-jobs.png)
5 changes: 5 additions & 0 deletions content/actions/using-jobs/using-concurrency.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,8 @@ miniTocMaxHeadingLevel: 4

{% data reusables.actions.jobs.section-using-concurrency-jobs %}

{% if github-runner-dashboard %}
## Monitoring your current jobs in your organization or enterprise

{% data reusables.github-actions.github-hosted-runners-check-concurrency %}
{% endif %}
3 changes: 3 additions & 0 deletions data/features/github-runner-dashboard.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
versions:
fpt: '*'
ghec: '*'
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
To identify any constraints with concurrency or queuing, you can check how many jobs are currently being processed on the {% data variables.product.prodname_dotcom %}-hosted runners in your organization or enterprise.

![Screenshot of a list of active jobs](/assets/images/help/settings/actions-runner-active-jobs.png)

For more information, see "[Monitoring your current jobs](/actions/using-github-hosted-runners/monitoring-your-current-jobs)."
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{% ifversion fpt %}
1. Navigate to the main page of the organization or repository.
1. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**.
1. In the left sidebar, click **Actions**, then click **Runners**.
{% elsif ghec %}
1. Navigate to your runner settings:
* **In an organization or repository**: Navigate to the main page, then click {% octicon "gear" aria-label="The Settings gear" %} **Settings**.
* **If using an enterprise account**: Navigate to your enterprise account by clicking your profile photo in the top-right corner of {% data variables.product.prodname_dotcom_the_website %}, then clicking **Your enterprises**, then clicking the enterprise.
1. Navigate to the {% data variables.product.prodname_actions %} settings:
* **In an organization or repository**: Click **Actions** in the left sidebar, then click **Runners**.
* **If using an enterprise account**: In the left sidebar, click **"{% octicon "law" aria-label="The law icon" %} Policies"**, then click **Actions**, then click the **Runners** tab.
{% endif %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1. In the "Runners" table, click the entry for **GitHub-hosted runners**. This entry will only be present if you're using {% data variables.product.prodname_dotcom %}-hosted runners.

0 comments on commit 4d4f7c5

Please sign in to comment.