Skip to content

Commit

Permalink
Hack week 2025: remove unneeded FBV instances (13) - Enterprise & OI…
Browse files Browse the repository at this point in the history
…DC (#53982)
  • Loading branch information
mchammer01 authored Jan 17, 2025
1 parent 8b6d917 commit 1b14395
Show file tree
Hide file tree
Showing 13 changed files with 8 additions and 147 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ $ ghe-announce -u
> Removed the announcement message
```

{% ifversion ghe-announce-dismiss %}
To allow each user to dismiss the announcement for themselves, use the `-d` flag.

```shell
Expand All @@ -46,8 +45,6 @@ $ ghe-announce -u
> dismissible: MESSAGE
```

{% endif %}

You can also set an announcement banner using the enterprise settings on {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner).

<!--For earlier releases of GHES, see the previous service `ghe-resque-info`-->
Expand Down Expand Up @@ -791,8 +788,6 @@ Flag | Description

{% endif %}

{% ifversion ghe-spokes-deprecation-phase-1 %}

### ghe-spokesctl

This utility allows you to manage replication of repositories on the distributed Git servers.
Expand All @@ -813,36 +808,6 @@ To evacuate storage services on a cluster node:
ghe-spokesctl server set evacuating git-server-UUID
```

{% else %}

### ghe-spokes

This utility allows you to manage the three copies of each repository on the distributed Git servers.

```shell
ghe-spokes
```

To show a summary of repository location and health:

```shell
ghe-spokes status
```

To show the servers in which the repository is stored:

```shell
ghe-spokes route
```

To evacuate storage services on a cluster node:

```shell
ghe-spokes server evacuate git-server-UUID
```

{% endif %}

### ghe-storage

This utility allows you to evacuate all storage services before evacuating a cluster node.
Expand Down Expand Up @@ -984,13 +949,9 @@ This utility tests the blob storage configuration for {% data variables.product.
For more information about the configuration of {% data variables.product.prodname_actions %}, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server).
{% ifversion ghes-actions-storage-oidc %}
> [!NOTE]
> This utility only works with configurations that use a credentials-based connection to the storage provider. To test OpenID Connect (OIDC) configurations, use [`ghe-actions-test-storage-with-oidc`](#ghe-actions-test-storage-with-oidc).
{% endif %}
```shell
ghe-actions-precheck -p [PROVIDER] -cs ["CONNECTION-STRING"]
```
Expand All @@ -1001,8 +962,6 @@ If your storage system is configured correctly, you'll see the following output.
All Storage tests passed
```

{% ifversion ghes-actions-storage-oidc %}

### ghe-actions-test-storage-with-oidc

This utility checks that the blob storage provider for {% data variables.product.prodname_actions %} on {% data variables.location.product_location %} is valid when OpenID Connect (OIDC) is used.
Expand All @@ -1014,8 +973,6 @@ This utility checks that the blob storage provider for {% data variables.product
ghe-actions-test-storage-with-oidc -p [PROVIDER] -cs ["CONNECTION-STRING"]
```

{% endif %}

### ghe-actions-stop

This utility stops {% data variables.product.prodname_actions %} from running on {% data variables.location.product_location %}.
Expand Down Expand Up @@ -1330,8 +1287,6 @@ In this example, `ghe-repl-status -vv` sends verbose status information from a r
## Upgrading {% data variables.product.prodname_ghe_server %}
{% ifversion ghes-upgrade-complete-indicator %}
### ghe-check-background-upgrade-jobs
During an upgrade to a feature release, this utility displays the status of background jobs on {% data variables.location.product_location %}. If you're running back-to-back upgrades, you should use this utility to check that all background jobs are complete before proceeding with the next upgrade.
Expand All @@ -1347,10 +1302,6 @@ During an upgrade to a feature release, this utility displays the status of back
ghe-check-background-upgrade-jobs
```

{% endif %}

{% ifversion ghe-migrations-cli-utility %}

### ghe-migrations

During an upgrade to a feature release, this utility displays the status of active database migrations on {% data variables.location.product_location %}. The output includes a version identifier for the migration, the migration's name, the migration's status, and the current duration of the migration.
Expand All @@ -1373,8 +1324,6 @@ By default, the visualizer refreshes every second. To specify the duration in se
ghe-migrations -refresh_rate SECONDS
```

{% endif %}

### ghe-update-check

This utility will check to see if a new patch release of {% data variables.product.prodname_enterprise %} is available. If it is, and if space is available on your instance, it will download the package. By default, it's saved to _/var/lib/ghe-updates_. An administrator can then [perform the upgrade](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,7 @@ People with admin permissions can set a more granular forking policy. For more i
{% data reusables.enterprise-accounts.repositories-tab %}
1. Under "Repository forking", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
1. Under "Repository forking", select the dropdown menu and click a policy.
{%- ifversion innersource-fork-policies %}
1. If forking is enabled, select a policy for where users are allowed to fork repositories.
{%- endif %}

## Enforcing a policy for inviting{% ifversion ghec %} outside{% endif %} collaborators to repositories

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ You can also set an announcement banner{% ifversion ghes %} in the administrativ
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}
{%- ifversion ghe-announce-dismiss %}
{%- ifversion ghes %}
1. Optionally, to allow each user to dismiss the announcement, select **User dismissible**.
{%- endif %}
1. Optionally, to allow each user to dismiss the announcement, select **Allow users to dismiss the announcement**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ shortTitle: Amazon S3 storage

{% data reusables.actions.enterprise-storage-about %}

{% ifversion ghes-actions-storage-oidc %}
{% data reusables.actions.enterprise-storage-about-oidc %}
{% endif %}

## Prerequisites

Expand All @@ -35,8 +33,6 @@ Before enabling {% data variables.product.prodname_actions %}, make sure you hav
{% data reusables.actions.enterprise-common-prereqs %}
{% data reusables.actions.enterprise-oidc-prereqs %}

{% ifversion ghes-actions-storage-oidc %}

## Enabling {% data variables.product.prodname_actions %} with Amazon S3 using OIDC (recommended)

To configure {% data variables.product.prodname_ghe_server %} to use OIDC with an Amazon S3 bucket, you must first create an Amazon OIDC provider, then create an Identity and Access Management (IAM) role, and finally configure {% data variables.product.prodname_ghe_server %} to use the provider and role to access your S3 bucket.
Expand Down Expand Up @@ -150,9 +146,7 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with a
{% data reusables.enterprise_management_console.test-storage-button %}
{% data reusables.enterprise_management_console.save-settings %}

{% endif %}

## Enabling {% data variables.product.prodname_actions %} with Amazon S3 storage{% ifversion ghes-actions-storage-oidc %} using access keys{% endif %}
## Enabling {% data variables.product.prodname_actions %} with Amazon S3 storage using access keys

1. Using the AWS Console or CLI, create an access key for your storage bucket.
{% data reusables.actions.enterprise-s3-permission %}
Expand All @@ -162,16 +156,10 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with a
{% data reusables.enterprise_site_admin_settings.management-console %}
{% data reusables.enterprise_management_console.actions %}
{% data reusables.actions.enterprise-enable-checkbox %}
{%- ifversion ghes-actions-storage-oidc %}
{% data reusables.actions.enterprise-s3-storage-setup %}
1. Under "Authentication", select **Credentials-based**, and enter your storage bucket's details:
{% data reusables.actions.enterprise-s3-storage-credential-fields %}
{%- else %}
1. Under "Artifact & Log Storage", select **Amazon S3**, then enter your storage bucket's details:

{% data reusables.actions.enterprise-s3-storage-credential-fields %}
{%- endif %}
{% data reusables.enterprise_management_console.test-storage-button %}
{% data reusables.enterprise_management_console.save-settings %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ shortTitle: Azure Blob storage

{% data reusables.actions.enterprise-storage-about %}

{% ifversion ghes-actions-storage-oidc %}
{% data reusables.actions.enterprise-storage-about-oidc %}
{% endif %}

## Prerequisites

Expand All @@ -38,8 +36,6 @@ Before enabling {% data variables.product.prodname_actions %}, make sure you hav
{% data reusables.actions.enterprise-common-prereqs %}
{% data reusables.actions.enterprise-oidc-prereqs %}

{% ifversion ghes-actions-storage-oidc %}

## Enabling {% data variables.product.prodname_actions %} with Azure Blob storage using OIDC (recommended)

To configure {% data variables.product.prodname_ghe_server %} to use OIDC with an Azure storage account, you must first register a Microsoft Entra ID (previously known as Azure AD) application with OIDC credentials, then configure your storage account, and finally configure {% data variables.product.prodname_ghe_server %} to access the storage container using the Entra ID.
Expand Down Expand Up @@ -94,20 +90,14 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with a
{% data reusables.enterprise_management_console.test-storage-button %}
{% data reusables.enterprise_management_console.save-settings %}

{% endif %}

## Enabling {% data variables.product.prodname_actions %} with Azure Blob storage{% ifversion ghes-actions-storage-oidc %} using a connection string{% endif %}
## Enabling {% data variables.product.prodname_actions %} with Azure Blob storage using a connection string

{% 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 %}
{%- ifversion ghes-actions-storage-oidc %}
{% data reusables.actions.enterprise-azure-storage-setup %}
1. Under "Authentication", select **Credentials-based**, 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).
{%- else %}
1. Under "Artifact & Log Storage", select **Azure Blob Storage**, then enter your Azure storage account's connection string. For more information about getting the connection string for your storage account, see the [View account access keys](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys) on Microsoft Learn.
{%- endif %}
{% data reusables.enterprise_management_console.test-storage-button %}
{% data reusables.enterprise_management_console.save-settings %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ redirect_from:
{% data reusables.actions.enterprise-storage-about %}

{% ifversion ghes-actions-storage-oidc %}
{% data reusables.actions.enterprise-storage-about-oidc %}
{% endif %}

## Prerequisites

Expand All @@ -32,8 +30,6 @@ Before enabling {% data variables.product.prodname_actions %}, make sure you hav
{% data reusables.actions.enterprise-common-prereqs %}
{% data reusables.actions.enterprise-oidc-prereqs %}

{% ifversion ghes-actions-storage-oidc %}

## Enabling {% data variables.product.prodname_actions %} with Google Cloud Storage using OIDC (recommended)

To configure {% data variables.product.prodname_ghe_server %} to use OIDC with Google Cloud Storage, you must first create a Google Cloud service account, then create a Google Cloud identity pool and identity provider, and finally configure {% data variables.product.prodname_ghe_server %} to use the provider and service account to access your Google Cloud Storage bucket.
Expand Down Expand Up @@ -119,9 +115,7 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with G
{% data reusables.enterprise_management_console.test-storage-button %}
{% data reusables.enterprise_management_console.save-settings %}
{% endif %}
## Enabling {% data variables.product.prodname_actions %} with Google Cloud Storage{% ifversion ghes-actions-storage-oidc %} using a HMAC key{% endif %}
## Enabling {% data variables.product.prodname_actions %} with Google Cloud Storage using a HMAC key
1. Create a Google Cloud service account that can access the bucket, and create a Hash-based Message Authentication Code (HMAC) key for the service account. For more information, see [Manage HMAC keys for service accounts](https://cloud.google.com/storage/docs/authentication/managing-hmackeys) in the Google Cloud documentation.
Expand All @@ -140,16 +134,10 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with G
{% data reusables.enterprise_site_admin_settings.management-console %}
{% data reusables.enterprise_management_console.actions %}
{% data reusables.actions.enterprise-enable-checkbox %}
{%- ifversion ghes-actions-storage-oidc %}
{% data reusables.actions.enterprise-gcp-storage-setup %}
1. Under "Authentication", select **Credentials-based**, and enter your storage bucket's details:
{% data reusables.actions.enterprise-gcp-storage-credential-fields %}
{%- else %}
1. Under "Artifact & Log Storage", select **Google Cloud Storage**, and enter your bucket's details:
{% data reusables.actions.enterprise-gcp-storage-credential-fields %}
{%- endif %}
{% data reusables.enterprise_management_console.test-storage-button %}
{% data reusables.enterprise_management_console.save-settings %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,13 @@ Before enabling {% data variables.product.prodname_actions %}, make sure you hav
{% data reusables.enterprise_site_admin_settings.management-console %}
{% data reusables.enterprise_management_console.actions %}
{% data reusables.actions.enterprise-enable-checkbox %}
{%- ifversion ghes-actions-storage-oidc %}
{% data reusables.actions.enterprise-s3-storage-setup %}
1. Under "Authentication", select **Credentials-based**, and enter your storage bucket's details:

> [!NOTE]
> For MinIO, you cannot use OpenID Connect (OIDC) authentication. You must use credentials-based authentication.
{% data reusables.actions.enterprise-minio-storage-credential-fields %}
{%- else %}
1. Under "Artifact & Log Storage", select **Amazon S3**, and enter your storage bucket's details:

{% data reusables.actions.enterprise-minio-storage-credential-fields %}
{% endif %}
1. Under "Artifact & Log Storage", select **Force path style**.
{% data reusables.enterprise_management_console.test-storage-button %}
{% data reusables.enterprise_management_console.save-settings %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,23 +49,14 @@ If you plan to take a node offline and the node runs any of the following roles,

* `git-server`:

{% ifversion ghe-spokes-deprecation-phase-1 %}
* Command:

```shell
ghe-spokesctl server status git-server-UUID
```

* Relevant output: `NETWORKS`, `GISTS`
{% else %}
* Command:

```shell
ghe-spokes evac-status git-server-UUID
```

* Relevant output: `Networks`, `Gists`
{% endif %}
* `pages-server`:

* Command:
Expand All @@ -90,20 +81,10 @@ If you plan to take a node offline and the node runs any of the following roles,

* Command (replace REASON FOR EVACUATION with the reason for evacuation):

{%- ifversion ghe-spokes-deprecation-phase-1 %}

```shell
ghe-spokesctl server set evacuating git-server-UUID 'REASON FOR EVACUATION'
```

{%- else %}

```shell
ghe-spokes server evacuate git-server-UUID 'REASON FOR EVACUATION'
```

{%- endif %}

* `pages-server`:

* Command:
Expand Down Expand Up @@ -133,20 +114,10 @@ If you plan to take a node offline and the node runs any of the following roles,
* `git-server`:
{%- ifversion ghe-spokes-deprecation-phase-1 %}
```shell
ghe-spokesctl server evac-status git-server-UUID
```
{%- else %}
```shell
ghe-spokes evac-status git-server-UUID
```
{%- endif %}
* `pages-server`:
```shell
Expand Down
Loading

0 comments on commit 1b14395

Please sign in to comment.