Skip to main content

Getting started with GitHub Actions for GitHub Enterprise Server

Learn about enabling and configuring GitHub Actions on GitHub Enterprise Server for the first time.

Кто может использовать эту функцию?

Site administrators can enable GitHub Actions and configure enterprise settings.

Примечание. В GitHub Enterprise Server в настоящее время не поддерживаются средства выполнения тестов, размещенные в GitHub. Дополнительные сведения о планируемой поддержке в будущем см. в GitHub public roadmap.

About GitHub Actions on GitHub Enterprise Server

This article explains how site administrators can configure GitHub Enterprise Server to use GitHub Actions.

GitHub Actions по умолчанию не включен для GitHub Enterprise Server. You'll need to determine whether your instance has adequate CPU and memory resources to handle the load from GitHub Actions without causing performance loss, and possibly increase those resources. You'll also need to decide which storage provider you'll use for the blob storage required to store artifacts and caches generated by workflow runs. Then, you'll enable GitHub Actions for your enterprise, manage access permissions, and add self-hosted runners to run workflows.

Прежде чем приступать к работе, необходимо составить план внедрения GitHub Actions в организации. Дополнительные сведения см. в разделе Introducing GitHub Actions to your enterprise.

При переносе предприятия на GitHub Actions от другого поставщика необходимо учитывать дополнительные аспекты. Дополнительные сведения см. в разделе Migrating your enterprise to GitHub Actions.

Review hardware requirements

The CPU and memory resources available to ваш экземпляр GitHub Enterprise Server determine the number of runners that can be configured without performance loss. Для запуска GitHub требуется не менее 8 виртуальных ЦП и 64 ГБ памяти для запуска GitHub Actions.

The peak quantity of connected runners without performance loss depends on such factors as job duration, artifact usage, number of repositories running Actions, and how much other work your instance is doing not related to Actions. Internal testing at GitHub demonstrated performance targets for GitHub Enterprise Server on a range of CPU and memory configurations.

vCPUsMemoryMaximum Connected Runners
864 GB740 runners
32160 GB2700 runners
96384 GB7000 runners
128512 GB7000 runners

GitHub measured maximum connected runners using multiple repositories, job duration of approximately 10 minutes, and 10 MB artifact uploads. You may experience different performance depending on the overall levels of activity on your instance.

Notes:

  • Beginning with GitHub Enterprise Server 3.6, GitHub documents connected runners as opposed to concurrent jobs. Connected runners represents the most runners you can connect and expect to utilize. It should also be noted that connecting more runners than you can expect to utilize can negatively impact performance.

  • Beginning with GitHub Enterprise Server 3.5, GitHub's internal testing uses 3rd generation CPUs to better reflect a typical customer configuration. This change in CPU represents a small portion of the changes to performance targets in this version of GitHub Enterprise Server.

If you plan to enable GitHub 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 GitHub Enterprise Server, see "Мониторинг экземпляра."

For more information about minimum hardware requirements for ваш экземпляр GitHub Enterprise Server, see the hardware considerations for your instance's platform.

Дополнительные сведения о настройке ресурсов для существующего экземпляра см. в разделе[ "AUTOTITLE" и "Увеличение емкости хранилища](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources)".

Optionally, you can limit resource consumption on ваш экземпляр GitHub Enterprise Server by configuring a rate limit for GitHub Actions. For more information, see "Configuring rate limits."

External storage requirements

To enable GitHub Actions on GitHub Enterprise Server, you must have access to external blob storage.

GitHub Actions использует внешнее хранилище BLOB-объектов для хранения данных, созданных рабочими процессами. Сохраненные данные включают журналы рабочих процессов и артефакты сборки, отправленные пользователем. The amount of storage required depends on your usage of GitHub Actions. Only a single external storage configuration is supported, and you can't use multiple storage providers at the same time.

All other GitHub Actions data, such as the workflow files in a repository's file structure, are stored on the data storage volume for ваш экземпляр GitHub Enterprise Server.

GitHub Actions supports these storage providers:

  • Azure Blob storage
  • Amazon S3
  • Google Cloud Storage
  • S3-compatible MinIO cluster

Note: These are the only storage providers that GitHub supports and can provide assistance with.

Существуют другие продукты хранения, совместимые с API S3, которые партнеры GitHub самостоятельно проверяются как работа с GitHub Actions на GitHub Enterprise Server. Дополнительные сведения см. в репозитории GHES служба хранилища Партнеров.

Для продуктов хранения, проверенных с помощью программы партнерства по технологии GitHub , поставщик хранилища отвечает за поддержку и документацию по использованию продукта хранилища с GitHub Actions.

Networking considerations

Если для организации включено GitHub Actions, поддерживаются только прокси-серверы HTTP. Прокси-серверы SOCKS5 и HTTPS не поддерживаются. For more information about using a proxy with GitHub Enterprise Server, see "Configuring an outbound web proxy server."

Enabling GitHub Actions with your storage provider

Follow one of the procedures below to enable GitHub Actions with your chosen storage provider:

Managing access permissions for GitHub Actions in your enterprise

You can use policies to manage access to GitHub Actions. For more information, see "Enforcing policies for GitHub Actions in your enterprise."

Adding self-hosted runners

Примечание. В GitHub Enterprise Server в настоящее время не поддерживаются средства выполнения тестов, размещенные в GitHub. Дополнительные сведения о планируемой поддержке в будущем см. в GitHub public roadmap.

To run GitHub 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 "Добавление локальных средств выполнения."

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 GitHub Connect for automatic access to actions from GitHub.com, or manually syncing actions from GitHub.com.

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

Общее усиление безопасности для GitHub Actions

Дополнительные сведения о методах безопасности для GitHub Actionsсм. в разделе "Защита системы безопасности для GitHub Actions".

Reserved names

When you enable GitHub 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.