1
0
mirror of synced 2025-12-22 03:16:52 -05:00
Files
docs/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server.md
Lucas Costi cde40f4847 [DO NOT MERGE] GitHub Enterprise Server 3.2 release candidate (#20666)
* Issue template stuff for creating megabranch

* Fix placeholder YAML

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* Add release candidate banner

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* [GHES 3.2]: Remove final notes about machine man preview (GA) (#20939)

* update search indexes

* update search indexes

* Add GHES versioning to "Managing your theme settings" (#20950)

* update search indexes

* [GHES 3.2]: Fix versioning for security alerts (#20761)

* made a start

* rework

* move image to an enterprise 3.1 folder

* forgot to commit

* simplify reusable

* update search indexes

* update search indexes

* update search indexes

* Updated basic 3.2 REST fiels after package change

These will be overwritten before release by the new description files when the 3.2 description is properly published

* update search indexes

* GHAE feature flag for `security alerts` custom notification option (#20979)

* made a start

* rework

* move image to an enterprise 3.1 folder

* forgot to commit

* simplify reusable

* add GHAE feature flag

* remove spurious spaces I had added

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* Update versioning (#21121)

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>

* update search indexes

* Add the new service (#21060)

* update search indexes

* update search indexes

* update search indexes

* Fix parent category index versioning for security overview

* update search indexes

* [GHES 3.2] Add documentation for GHES Referrer Policy Admin setting (#20910)

Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com>
Co-authored-by: Jules Parker <19994093+jules-p@users.noreply.github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>

* update search indexes

* update search indexes

* Update "Review hardware considerations" table (#21208)

Performance improvements resulted in higher maximum job throughput and the new benchmarks need to be shared with current and potential customers.

* update search indexes

* Version new GHES 3.2 Actions tested performance (#21212)

* update search indexes

* Update "Review hardware considerations" table v2

Feedback from additional reviewers requires an update to the benchmarks previously merged.

* update search indexes

* update search indexes

* [GHES 3.2] - Dependency Graph: Simplified enablement in GHES (GA) (#21078)

* document UI button for dependency graph GHES 3.2

* update search indexes

* Update getting-started-with-github-actions-for-github-enterprise-server.md

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* [GHES 3.2] Release candidate 1 release notes (#20799)

Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
Co-authored-by: bwestover <bwestover@github.com>
Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Grey Baker <greysteil@github.com>
Co-authored-by: Bas van Schaik <5082246+sj@users.noreply.github.com>
Co-authored-by: William Bartholomew <iamwillbar@github.com>

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* update search indexes

* Update OpenAPI Descriptions for GHES 3.2 (#21377)

Also contains a rollup of other unmerged OpenAPI changes

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>

* update search indexes

Co-authored-by: Rachael Sewell <rachmari@github.com>
Co-authored-by: GitHub Actions <action@github.com>
Co-authored-by: Docubot <67483024+docubot@users.noreply.github.com>
Co-authored-by: Laura Coursen <lecoursen@github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Matthias Wenz <matthiaswenz@github.com>
Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com>
Co-authored-by: Jules Parker <19994093+jules-p@users.noreply.github.com>
Co-authored-by: Steve-Glass <84886334+Steve-Glass@users.noreply.github.com>
Co-authored-by: Meg Bird <megbird@github.com>
Co-authored-by: bwestover <bwestover@github.com>
Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: Grey Baker <greysteil@github.com>
Co-authored-by: Bas van Schaik <5082246+sj@users.noreply.github.com>
Co-authored-by: William Bartholomew <iamwillbar@github.com>
Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com>
Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
2021-09-09 08:56:20 -07:00

9.1 KiB

title, shortTitle, intro, permissions, redirect_from, versions, type, topics
title shortTitle intro permissions redirect_from versions type topics
Getting started with GitHub Actions for GitHub Enterprise Server Getting started with GitHub Actions Learn about enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} for the first time. Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.
/enterprise/admin/github-actions/enabling-github-actions-and-configuring-storage
/admin/github-actions/enabling-github-actions-and-configuring-storage
/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server
ghes
*
how_to
Actions
Enterprise

{% data reusables.actions.enterprise-beta %}

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

{% ifversion ghes > 2.22 %}

This article explains how site administrators can configure {% data variables.product.prodname_ghe_server %} to use {% data variables.product.prodname_actions %}. It covers the hardware and software requirements, presents the storage options, and describes the security management policies.

{% endif %}

Review hardware considerations

{% ifversion ghes = 2.22 or ghes = 3.0 %}

{% note %}

Note: {% ifversion ghes = 2.22 %}{% data variables.product.prodname_actions %} was available for {% data variables.product.prodname_ghe_server %} 2.22 as a limited beta. {% endif %}If you're upgrading an existing {% data variables.product.prodname_ghe_server %} instance to 3.0 or later and want to configure {% data variables.product.prodname_actions %}, note that the minimum hardware requirements have increased. For more information, see "Upgrading {% data variables.product.prodname_ghe_server %}."

{% endnote %}

{% endif %}

The CPU and memory resources available to {% data variables.product.product_location %} determine the maximum job throughput for {% data variables.product.prodname_actions %}.

Internal testing at {% data variables.product.company_short %} demonstrated the following maximum throughput for {% data variables.product.prodname_ghe_server %} instances with a range of CPU and memory configurations. You may see different throughput depending on the overall levels of activity on your instance.

vCPUs Memory Maximum job throughput
{%- ifversion ghes > 3.1 %}
4 32 GB Demo or light testing
8 64 GB 30 jobs
16 128 GB 60 jobs
32 256 GB 120 jobs
64 512 GB 160 jobs
{%- else ifversion ghes < 3.2 %}
4 32 GB Demo or light testing
8 64 GB 25 jobs
16 160 GB 35 jobs
32 256 GB 100 jobs
{%- endif %}

If you {% ifversion ghes = 2.22 %}enabled the beta of{% else %}plan to enable{% endif %} {% data variables.product.prodname_actions %} for the users of an existing instance, review the levels of activity for users and automations on the instance and ensure that you have provisioned adequate CPU and memory for your users. For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "Monitoring your appliance."

For more information about minimum hardware requirements for {% data variables.product.product_location %}, see the hardware considerations for your instance's platform.

{% data reusables.enterprise_installation.about-adjusting-resources %}

External storage requirements

To enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, you must have access to external blob storage.

{% data variables.product.prodname_actions %} uses blob storage to store artifacts generated by workflow runs, such as workflow logs and user-uploaded build artifacts. The amount of storage required depends on your usage of {% data variables.product.prodname_actions %}. Only a single external storage configuration is supported, and you can't use multiple storage providers at the same time.

{% data variables.product.prodname_actions %} supports these storage providers:

  • Azure Blob storage
  • Amazon S3
  • S3-compatible MinIO Gateway for NAS

{% note %}

Note: These are the only storage providers that {% data variables.product.company_short %} supports and can provide assistance with. Other S3 API-compatible storage providers are unlikely to work due to differences from the S3 API. Contact us to request support for additional storage providers.

{% endnote %}

{% ifversion ghes = 2.22 %}

Amazon S3 permissions

{% data reusables.actions.enterprise-s3-permission %}

Enabling {% data variables.product.prodname_actions %}

{% data variables.product.prodname_actions %} support on {% data variables.product.prodname_ghe_server %} 2.22 was available as a limited beta. To configure {% data variables.product.prodname_actions %} for your instance, upgrade to {% data variables.product.prodname_ghe_server %} 3.0 or later. For more information, see the {% data variables.product.prodname_ghe_server %} 3.0 release notes and "Upgrading {% data variables.product.prodname_ghe_server %}."

Further reading

{% endif %}

{% ifversion ghes > 2.22 %}

Enabling {% data variables.product.prodname_actions %} with your storage provider

Follow one of the procedures below to enable {% data variables.product.prodname_actions %} with your chosen storage provider:

Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise

You can use policies to manage access to {% data variables.product.prodname_actions %}. For more information, see "Enforcing GitHub Actions policies for your enterprise."

Adding self-hosted runners

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

To run {% data variables.product.prodname_actions %} workflows, you need to add self-hosted runners. You can add self-hosted runners at the enterprise, organization, or repository levels. For more information, see "Adding self-hosted runners."

Managing which actions can be used in your enterprise

You can control which actions your users are allowed to use in your enterprise. This includes setting up {% data variables.product.prodname_github_connect %} for automatic access to actions from {% data variables.product.prodname_dotcom_the_website %}, or manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}.

For more information, see "About using actions in your enterprise."

General security hardening for {% data variables.product.prodname_actions %}

If you want to learn more about security practices for {% data variables.product.prodname_actions %}, see "Security hardening for {% data variables.product.prodname_actions %}."

{% endif %}

Reserved Names

When you enable {% data variables.product.prodname_actions %} for your enterprise, two organizations are created: github and actions. If your enterprise already uses the github organization name, github-org (or github-github-org if github-org is also in use) will be used instead. If your enterprise already uses the actions organization name, github-actions (or github-actions-org if github-actions is also in use) will be used instead. Once actions is enabled, you won't be able to use these names anymore.