ran script/content-migrations/remove-map-topics.js && script/content-migrations/update-tocs.js
This commit is contained in:
Sarah Schneider
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Enabling GitHub Actions with Amazon S3 storage
|
||||
intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use Amazon S3 storage to store artifacts generated by workflow runs.'
|
||||
permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.'
|
||||
versions:
|
||||
enterprise-server: '>=3.0'
|
||||
topics:
|
||||
- Enterprise
|
||||
redirect_from:
|
||||
- /admin/github-actions/enabling-github-actions-with-amazon-s3-storage
|
||||
---
|
||||
### Prerequisites
|
||||
|
||||
{% data reusables.actions.enterprise-s3-support-warning %}
|
||||
|
||||
Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps:
|
||||
|
||||
* Create your Amazon S3 bucket for storing artifacts generated by workflow runs. {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %}
|
||||
|
||||
{% data reusables.actions.enterprise-common-prereqs %}
|
||||
|
||||
### Enabling {% data variables.product.prodname_actions %} with Amazon S3 storage
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_management_console.actions %}
|
||||
{% data reusables.actions.enterprise-enable-checkbox %}
|
||||
1. Under "Artifact & Log Storage", select **Amazon S3**, and enter your storage bucket's details:
|
||||
|
||||
* **AWS Service URL**: The service URL for your bucket. For example, if your S3 bucket was created in the `us-west-2` region, this value should be `https://s3.us-west-2.amazonaws.com`.
|
||||
|
||||
For more information, see "[AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html)" in the AWS documentation.
|
||||
* **AWS S3 Bucket**: The name of your S3 bucket.
|
||||
* **AWS S3 Access Key** and **AWS S3 Secret Key**: The AWS access key ID and secret key for your bucket. For more information on managing AWS access keys, see the "[AWS Identity and Access Management Documentation](https://docs.aws.amazon.com/iam/index.html)."
|
||||
|
||||
|
||||
{% data reusables.enterprise_management_console.save-settings %}
|
||||
|
||||
{% data reusables.actions.enterprise-postinstall-nextsteps %}
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Enabling GitHub Actions with Azure Blob storage
|
||||
intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use Azure Blob storage to store artifacts generated by workflow runs.'
|
||||
permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.'
|
||||
versions:
|
||||
enterprise-server: '>=3.0'
|
||||
topics:
|
||||
- Enterprise
|
||||
redirect_from:
|
||||
- /admin/github-actions/enabling-github-actions-with-azure-blob-storage
|
||||
---
|
||||
### Prerequisites
|
||||
|
||||
Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps:
|
||||
|
||||
* Create your Azure storage account for storing workflow artifacts. {% data variables.product.prodname_actions %} stores its data as block blobs, and two storage account types are supported:
|
||||
* A **general-purpose** storage account (also known as `general-purpose v1` or `general-purpose v2`) using the **standard** performance tier.
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning:** Using the **premium** performance tier with a general-purpose storage account is not supported. The **standard** performance tier must be selected when creating the storage account, and it cannot be changed later.
|
||||
|
||||
{% endwarning %}
|
||||
* A **BlockBlobStorage** storage account, which uses the **premium** performance tier.
|
||||
|
||||
For more information on Azure storage account types and performance tiers, see the [Azure documentation](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview?toc=/azure/storage/blobs/toc.json#types-of-storage-accounts).
|
||||
{% data reusables.actions.enterprise-common-prereqs %}
|
||||
|
||||
### Enabling {% data variables.product.prodname_actions %} with Azure Blob storage
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_management_console.actions %}
|
||||
{% data reusables.actions.enterprise-enable-checkbox %}
|
||||
1. Under "Artifact & Log Storage", select **Azure Blob Storage**, and enter your Azure storage account's connection string. For more information on getting the connection string for your storage account, see the [Azure documentation](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys).
|
||||
|
||||
{% data reusables.enterprise_management_console.save-settings %}
|
||||
|
||||
{% data reusables.actions.enterprise-postinstall-nextsteps %}
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: Enabling GitHub Actions with MinIO Gateway for NAS storage
|
||||
intro: 'You can enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} and use MinIO Gateway for NAS storage to store artifacts generated by workflow runs.'
|
||||
permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.'
|
||||
versions:
|
||||
enterprise-server: '>=3.0'
|
||||
topics:
|
||||
- Enterprise
|
||||
redirect_from:
|
||||
- /admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage
|
||||
---
|
||||
### Prerequisites
|
||||
|
||||
{% data reusables.actions.enterprise-s3-support-warning %}
|
||||
|
||||
Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps:
|
||||
|
||||
* To avoid resource contention on the appliance, we recommend that MinIO be hosted separately from {% data variables.product.product_location %}.
|
||||
* Create your bucket for storing workflow artifacts. To set up your bucket and access key, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html). {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %}
|
||||
|
||||
{% data reusables.actions.enterprise-common-prereqs %}
|
||||
|
||||
### Enabling {% data variables.product.prodname_actions %} with MinIO Gateway for NAS storage
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_management_console.actions %}
|
||||
{% data reusables.actions.enterprise-enable-checkbox %}
|
||||
1. Under "Artifact & Log Storage", select **Amazon S3**, and enter your storage bucket's details:
|
||||
|
||||
* **AWS Service URL**: The URL to your MinIO service. For example, `https://my-minio.example:9000`.
|
||||
* **AWS S3 Bucket**: The name of your S3 bucket.
|
||||
* **AWS S3 Access Key** and **AWS S3 Secret Key**: The `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY` used for your MinIO instance. For more information, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html).
|
||||
|
||||
|
||||
1. Under "Artifact & Log Storage", select **Force path style**.
|
||||
|
||||
{% data reusables.enterprise_management_console.save-settings %}
|
||||
|
||||
{% data reusables.actions.enterprise-postinstall-nextsteps %}
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
title: Enforcing GitHub Actions policies for your enterprise
|
||||
intro: 'Enterprise administrators can manage access to {% data variables.product.prodname_actions %} in an enterprise.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise
|
||||
- /admin/github-actions/enforcing-github-actions-policies-for-your-enterprise
|
||||
versions:
|
||||
enterprise-server: '>=2.22'
|
||||
github-ae: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Actions
|
||||
- Enterprise
|
||||
- Policies
|
||||
---
|
||||
{% data reusables.actions.ae-beta %}
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
### About {% data variables.product.prodname_actions %} permissions for your enterprise
|
||||
|
||||
{% if currentVersion == "github-ae@latest" %}{% else %}When you enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, it is enabled for all organizations in your enterprise. {% endif %}You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your enterprise.
|
||||
|
||||
### Managing {% data variables.product.prodname_actions %} permissions for your enterprise
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
{% data reusables.actions.enterprise-actions-permissions %}
|
||||
|
||||
{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest"%}
|
||||
### Enabling workflows for private repository forks
|
||||
|
||||
{% data reusables.github-actions.private-repository-forks-overview %}
|
||||
|
||||
#### Configuring the private fork policy for your enterprise
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.actions-tab %}
|
||||
{% data reusables.github-actions.private-repository-forks-configure %}
|
||||
{% endif %}
|
||||
@@ -0,0 +1,128 @@
|
||||
---
|
||||
title: Getting started with GitHub Actions for GitHub Enterprise Server
|
||||
shortTitle: Getting started with GitHub Actions
|
||||
intro: 'Learn about enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} for the first time.'
|
||||
permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.'
|
||||
redirect_from:
|
||||
- /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
|
||||
versions:
|
||||
enterprise-server: '>=2.22'
|
||||
type: how_to
|
||||
topics:
|
||||
- Actions
|
||||
- Enterprise
|
||||
---
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
{% if currentVersion ver_gt "enterprise-server@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
|
||||
|
||||
{% if currentVersion == "enterprise-server@2.22" or currentVersion == "enterprise-server@3.0" %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: {% if currentVersion == "enterprise-server@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 %}](/admin/enterprise-management/upgrading-github-enterprise-server#about-minimum-requirements-for-github-enterprise-server-30-and-later)."
|
||||
|
||||
{% 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 |
|
||||
| :--- | :--- | :--- |
|
||||
| 4 | 32 GB | Demo or light testing |
|
||||
| 8 | 64 GB | 25 jobs |
|
||||
| 16 | 160 GB | 35 jobs |
|
||||
| 32 | 256 GB | 100 jobs |
|
||||
|
||||
If you {% if currentVersion == "enterprise-server@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](/admin/enterprise-management/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.
|
||||
|
||||
- [AWS](/admin/installation/installing-github-enterprise-server-on-aws#hardware-considerations)
|
||||
- [Azure](/admin/installation/installing-github-enterprise-server-on-azure#hardware-considerations)
|
||||
- [Google Cloud Platform](/admin/installation/installing-github-enterprise-server-on-google-cloud-platform#hardware-considerations)
|
||||
- [Hyper-V](/admin/installation/installing-github-enterprise-server-on-hyper-v#hardware-considerations)
|
||||
- [OpenStack KVM](/admin/installation/installing-github-enterprise-server-on-openstack-kvm#hardware-considerations)
|
||||
- [VMware](/admin/installation/installing-github-enterprise-server-on-vmware#hardware-considerations)
|
||||
- [XenServer](/admin/installation/installing-github-enterprise-server-on-xenserver#hardware-considerations)
|
||||
|
||||
{% 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](https://support.github.com/contact) to request support for additional storage providers.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% if currentVersion == "enterprise-server@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](/enterprise-server@3.0/admin/release-notes) and "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server)."
|
||||
|
||||
### Further reading
|
||||
|
||||
- "Hardware considerations" for your platform in "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/admin/installation/setting-up-a-github-enterprise-server-instance)"
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion ver_gt "enterprise-server@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:
|
||||
|
||||
* [Enabling GitHub Actions with Azure Blob storage](/admin/github-actions/enabling-github-actions-with-azure-blob-storage)
|
||||
* [Enabling GitHub Actions with Amazon S3 storage](/admin/github-actions/enabling-github-actions-with-amazon-s3-storage)
|
||||
* [Enabling GitHub Actions with MinIO Gateway for NAS storage](/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage)
|
||||
|
||||
### 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](/admin/github-actions/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](/actions/hosting-your-own-runners/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](/admin/github-actions/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 %}](/actions/learn-github-actions/security-hardening-for-github-actions)."
|
||||
|
||||
{% endif %}
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: Enabling GitHub Actions for GitHub Enterprise Server
|
||||
intro: 'Learn how to configure storage and enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}.'
|
||||
versions:
|
||||
enterprise-server: '>=2.22'
|
||||
topics:
|
||||
- Enterprise
|
||||
children:
|
||||
- /getting-started-with-github-actions-for-github-enterprise-server
|
||||
- /enabling-github-actions-with-azure-blob-storage
|
||||
- /enabling-github-actions-with-amazon-s3-storage
|
||||
- /enabling-github-actions-with-minio-gateway-for-nas-storage
|
||||
- /enforcing-github-actions-policies-for-your-enterprise
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user