jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-03 06:04:16 -05:00
Code Issues Projects Releases Wiki Activity

Part 1: First fourth content unordered lists from dash to asterisk (#51094)

Browse Source
This commit is contained in:
Grace Park
2024-06-13 10:39:07 -07:00
committed by GitHub
parent ef824b1e7e
commit 0b94935b77
738 changed files with 6267 additions and 6267 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md
View File

@@ -33,7 +33,7 @@ shortTitle: Amazon S3 storage
Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps:
- Create your Amazon S3 bucket for storing data generated by workflow runs.
* Create your Amazon S3 bucket for storing data generated by workflow runs.
{% data reusables.actions.enterprise-common-prereqs %}
{% data reusables.actions.enterprise-oidc-prereqs %}
@@ -103,9 +103,9 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with a
1. Open the AWS Console, and navigate to the Identity and Access Management (IAM) service.
1. In the left menu, under "Access management", click **Roles**, then click **Create Role**.
1. On the "Select trusted entity" page, enter the following options:
- For "Trusted entity type", click **Web identity**.
- For "Identity provider", use the **Choose provider** drop-down menu and select the OIDC provider you created in the previous steps. It should be named `HOSTNAME/_services/token`, where `HOSTNAME` is the public hostname for {% data variables.location.product_location_enterprise %}.
- For "Audience", select `sts.amazonaws.com`.
* For "Trusted entity type", click **Web identity**.
* For "Identity provider", use the **Choose provider** drop-down menu and select the OIDC provider you created in the previous steps. It should be named `HOSTNAME/_services/token`, where `HOSTNAME` is the public hostname for {% data variables.location.product_location_enterprise %}.
* For "Audience", select `sts.amazonaws.com`.
1. Click **Next**.
1. On the "Add permissions" page, use the filter to find and select the `AmazonS3FullAccess` policy.
1. Click **Next**.
@@ -149,9 +149,9 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with a
{% data reusables.actions.enterprise-enable-checkbox %}
{% data reusables.actions.enterprise-s3-storage-setup %}
1. Under "Authentication", select **OpenID Connect (OIDC)**, and enter the values for your storage:
- **AWS S3 Bucket**: The name of your S3 bucket.
- **AWS Role**: The ARN for the role you created in the previous procedures. For example, `arn:aws:iam::123456789:role/my-role-name`.
- **AWS Region**: The AWS region for your bucket. For example, `us-east-1`.
* **AWS S3 Bucket**: The name of your S3 bucket.
* **AWS Role**: The ARN for the role you created in the previous procedures. For example, `arn:aws:iam::123456789:role/my-role-name`.
* **AWS Region**: The AWS region for your bucket. For example, `us-east-1`.
{% data reusables.enterprise_management_console.test-storage-button %}
{% data reusables.enterprise_management_console.save-settings %}

14
content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md
View File

@@ -25,15 +25,15 @@ shortTitle: Azure Blob storage
Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps:
- Create your Azure storage account for storing workflow data. {% 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.
* Create your Azure storage account for storing workflow data. {% 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.
* 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 %}
@@ -90,10 +90,10 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with a
{% data reusables.actions.enterprise-enable-checkbox %}
{% data reusables.actions.enterprise-azure-storage-setup %}
1. Under "Authentication", select **OpenID Connect (OIDC)**, and enter the values for your storage that you noted down in the previous procedures:
- Entra ID tenant ID
- Entra ID client ID
- Azure storage account name
- Azure blob endpoint suffix
* Entra ID tenant ID
* Entra ID client ID
* Azure storage account name
* Azure blob endpoint suffix
{% data reusables.enterprise_management_console.test-storage-button %}
{% data reusables.enterprise_management_console.save-settings %}

66
content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage.md
View File

@@ -29,7 +29,7 @@ shortTitle: Google Cloud Storage
Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps:
- Create your Google Cloud Storage bucket for storing data generated by workflow runs.
* Create your Google Cloud Storage bucket for storing data generated by workflow runs.
{% data reusables.actions.enterprise-common-prereqs %}
{% data reusables.actions.enterprise-oidc-prereqs %}
@@ -45,10 +45,10 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with G
When creating the service account, ensure that you do the following:
- Enable the IAM API as described at the start of [Creating and managing service accounts](https://cloud.google.com/iam/docs/creating-managing-service-accounts).
- Add the following roles to the service account:
- Service Account Token Creator
- Storage Object Admin
* Enable the IAM API as described at the start of [Creating and managing service accounts](https://cloud.google.com/iam/docs/creating-managing-service-accounts).
* Add the following roles to the service account:
* Service Account Token Creator
* Storage Object Admin
1. After creating the service account, note its email address, as it is need later. The service account email address is in the format `SERVICE-ACCOUNT-NAME@PROJECT-NAME.iam.gserviceaccount.com`.
### 2. Create an identity pool and identity provider
@@ -57,9 +57,9 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with G
1. Under "Create an identity pool", enter a name for the identity pool, and click **Continue**.
1. Under "Add a provider to pool":
- For "Select a provider", select **OpenID Connect (OIDC)**.
- For "Provider name", enter a name for the provider.
- For "Issuer (URL)", enter the following URL, replacing `HOSTNAME` with the public hostname for {% data variables.location.product_location_enterprise %}:
* For "Select a provider", select **OpenID Connect (OIDC)**.
* For "Provider name", enter a name for the provider.
* For "Issuer (URL)", enter the following URL, replacing `HOSTNAME` with the public hostname for {% data variables.location.product_location_enterprise %}:
```text
https://HOSTNAME/_services/token
@@ -71,13 +71,13 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with G
https://my-ghes-host.example.com/_services/token
```
- Under "Audiences", leave **Default audience** selected, but note the identity provider URL, as it is needed later. The identity provider URL is in the format `https://iam.googleapis.com/projects/PROJECT-NUMBER/locations/global/workloadIdentityPools/POOL-NAME/providers/PROVIDER-NAME`.
- Click **Continue**.
* Under "Audiences", leave **Default audience** selected, but note the identity provider URL, as it is needed later. The identity provider URL is in the format `https://iam.googleapis.com/projects/PROJECT-NUMBER/locations/global/workloadIdentityPools/POOL-NAME/providers/PROVIDER-NAME`.
* Click **Continue**.
1. Under "Configure provider attributes":
- For the "OIDC 1" mapping, enter `assertion.sub`.
- Under "Attribute Conditions", click **Add condition**.
- For "Condition CEL", enter the following condition, replacing `HOSTNAME` with the public hostname for {% data variables.location.product_location_enterprise %}:
* For the "OIDC 1" mapping, enter `assertion.sub`.
* Under "Attribute Conditions", click **Add condition**.
* For "Condition CEL", enter the following condition, replacing `HOSTNAME` with the public hostname for {% data variables.location.product_location_enterprise %}:
```text
google.subject == "HOSTNAME"
@@ -94,14 +94,14 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with G
**Note:** The hostname of {% data variables.location.product_location_enterprise %} used here _must not_ include the protocol.
{% endnote %}
- Click **Save**.
* Click **Save**.
1. After creating the identity pool, at the top of the identity pool's page, click **Grant access**.
- Under "Select service account", select the service account that you created in the previous procedure.
- Under "Select principals (identities that can access the service account)", select **Only identities matching the filter**.
- For "Attribute name", select **subject**.
- For "Attribute value", enter your {% data variables.product.prodname_ghe_server %} hostname, without the protocol. For example, `my-ghes-host.example.com`.
- Click **Save**.
- You can dismiss the "Configure your application" dialog, as the configuration file is not needed.
* Under "Select service account", select the service account that you created in the previous procedure.
* Under "Select principals (identities that can access the service account)", select **Only identities matching the filter**.
* For "Attribute name", select **subject**.
* For "Attribute value", enter your {% data variables.product.prodname_ghe_server %} hostname, without the protocol. For example, `my-ghes-host.example.com`.
* Click **Save**.
* You can dismiss the "Configure your application" dialog, as the configuration file is not needed.
### 3. Configure {% data variables.product.prodname_ghe_server %} to connect to Google Cloud Storage using OIDC
@@ -111,14 +111,14 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with G
{% data reusables.actions.enterprise-enable-checkbox %}
{% data reusables.actions.enterprise-gcp-storage-setup %}
1. Under "Authentication", select **OpenID Connect (OIDC)**, and enter the values for your storage:
- **Service URL**: The service URL for your bucket. This is usually `https://storage.googleapis.com`.
- **Bucket name**: The name of your bucket.
- **Workload Identity Provider ID**: The identity provider ID for your identity pool.
* **Service URL**: The service URL for your bucket. This is usually `https://storage.googleapis.com`.
* **Bucket name**: The name of your bucket.
* **Workload Identity Provider ID**: The identity provider ID for your identity pool.
This is in the format `projects/PROJECT-NUMBER/locations/global/workloadIdentityPools/POOL-NAME/providers/PROVIDER-NAME`. Note that you must remove the `https://iam.googleapis.com/` prefix from the value noted in the previous procedure.
For example, `projects/1234567890/locations/global/workloadIdentityPools/my-pool/providers/my-provider`.
- **Service account**: The service account email address that you noted in the previous procedure. For example, `ghes-oidc-service-account@my-project.iam.gserviceaccount.com`.
* **Service account**: The service account email address that you noted in the previous procedure. For example, `ghes-oidc-service-account@my-project.iam.gserviceaccount.com`.
{% data reusables.enterprise_management_console.test-storage-button %}
{% data reusables.enterprise_management_console.save-settings %}
@@ -130,15 +130,15 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with G
The service account must have the following [Identity and Access Management (IAM) permissions](https://cloud.google.com/storage/docs/access-control/iam-permissions) for the bucket:
- `storage.objects.create`
- `storage.objects.get`
- `storage.objects.list`
- `storage.objects.update`
- `storage.objects.delete`
- `storage.multipartUploads.create`
- `storage.multipartUploads.abort`
- `storage.multipartUploads.listParts`
- `storage.multipartUploads.list`
* `storage.objects.create`
* `storage.objects.get`
* `storage.objects.list`
* `storage.objects.update`
* `storage.objects.delete`
* `storage.multipartUploads.create`
* `storage.multipartUploads.abort`
* `storage.multipartUploads.listParts`
* `storage.multipartUploads.list`
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.management-console %}
{% data reusables.enterprise_management_console.actions %}

2
content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-storage.md
View File

@@ -22,7 +22,7 @@ shortTitle: MinIO storage
Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps:
- Create your MinIO bucket for storing data generated by workflow runs. For more information about installing and configuring MinIO, see "[MinIO High Performance Object Storage](https://min.io/docs/minio/container/index.html)" and "[mc mb](https://min.io/docs/minio/linux/reference/minio-mc/mc-mb.html)" in the MinIO documentation.
* Create your MinIO bucket for storing data generated by workflow runs. For more information about installing and configuring MinIO, see "[MinIO High Performance Object Storage](https://min.io/docs/minio/container/index.html)" and "[mc mb](https://min.io/docs/minio/linux/reference/minio-mc/mc-mb.html)" in the MinIO documentation.
To avoid resource contention on the appliance, we recommend that MinIO be hosted separately from {% data variables.location.product_location %}.

18
content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md
View File

@@ -27,8 +27,8 @@ Configuring self-hosted runners is only one step in the middle of the process fo
{% else %}
Before you configure self-hosted runners for {% data variables.product.prodname_dependabot_updates %}, you must:
- Configure {% data variables.location.product_location %} to use {% data variables.product.prodname_actions %} with self-hosted runners. For more information, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server)."
- Enable {% data variables.product.prodname_dependabot_alerts %} for your enterprise. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."
* Configure {% data variables.location.product_location %} to use {% data variables.product.prodname_actions %} with self-hosted runners. For more information, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server)."
* Enable {% data variables.product.prodname_dependabot_alerts %} for your enterprise. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."
{% endif %}
## Configuring self-hosted runners for {% data variables.product.prodname_dependabot_updates %}
@@ -50,13 +50,13 @@ If your {% data variables.product.prodname_ghe_server %} instance uses a self-si
1. Provision self-hosted runners, at the repository, organization, or enterprise account level. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)" and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)."
1. Set up the self-hosted runners with the requirements described above. For example, on a VM running Ubuntu 20.04 you would:
- Install Docker and ensure that the runner users have access to Docker. For more information, see the Docker documentation.
- [Install Docker Engine on Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
- Recommended approach: [Run the Docker daemon as a non-root user (Rootless mode)](https://docs.docker.com/engine/security/rootless/)
- Alternative approach: [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)
- Verify that the runners have access to the public internet and can only access the internal networks that {% data variables.product.prodname_dependabot %} needs.
- Install any self-signed certificates for your {% data variables.product.prodname_ghe_server %} instance or for registries that {% data variables.product.prodname_dependabot %} will need to interact with.
- Configure Node.js to use the same certificate. For more information, see "[AUTOTITLE](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#configuring-nodejs-to-use-the-certificate)."
* Install Docker and ensure that the runner users have access to Docker. For more information, see the Docker documentation.
* [Install Docker Engine on Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
* Recommended approach: [Run the Docker daemon as a non-root user (Rootless mode)](https://docs.docker.com/engine/security/rootless/)
* Alternative approach: [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)
* Verify that the runners have access to the public internet and can only access the internal networks that {% data variables.product.prodname_dependabot %} needs.
* Install any self-signed certificates for your {% data variables.product.prodname_ghe_server %} instance or for registries that {% data variables.product.prodname_dependabot %} will need to interact with.
* Configure Node.js to use the same certificate. For more information, see "[AUTOTITLE](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#configuring-nodejs-to-use-the-certificate)."
1. Assign a `dependabot` label to each runner you want {% data variables.product.prodname_dependabot %} to use. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners#assigning-a-label-to-a-self-hosted-runner)."