Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repo sync #29978

Merged
merged 4 commits into from
Nov 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 112 additions & 0 deletions assets/ghes-3.11-opentelemetry-attribute-mappings.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
Category,Old Attribute,New Attribute
Memex,queue,gh.job.queue
Memex,status,gh.memex.automation.status
Memex,topic,messaging.kafka.source.topic
Memex,partition,messaging.kafka.source.partition
Memex,schema,messaging.kafka.message.schema
Memex,offset,messaging.kafka.message.offset
Memex,timestamp,messaging.kafka.message.timestamp
Memex,item_ids,gh.memex.unauthorized_item_ids
Authzd,authzd_request,gh.authzd.request.attributes
Authzd,authzd.request,gh.authzd.request.attributes
Authzd,authzd_response,gh.authzd.decisions
Authzd,authzd.response,gh.authzd.decisions
Authzd,authzd.rpc,gh.authzd.rpc
Authzd,gh.authzd.enumerator.request.size,gh.authzd.enumerator.response.size
Dependency Graph,job_timeout,gh.job.timeout
Dependency Graph,push_id,gh.push.id
Dependency Graph,ref,gh.commit.ref
Dependency Graph,commit_sha,gh.commit.oid
Dependency Graph,repo_count,gh.dependency_graph.manifest_paths_count
Dependency Graph,max_manifest_files,gh.dependency_graph.max_manifest_files
Dependency Graph,push_count,gh.dependency_graph.changed_manifest.count
Dependency Graph,base,gh.comparison.base_rev
Dependency Graph,head,gh.comparison.head_rev
Driftwood,deployed_to,gh.driftwood.deployed_to
Driftwood,release,gh.driftwood.release
Driftwood,ref,gh.driftwood.ref
Driftwood,service,gh.driftwood.service
Driftwood,exception_id,gh.driftwood.exception_id
Registry,ecosystem,gh.registry.ecosystem
Registry,v2_enabled,gh.registry.v2_enabled
Registry,display_login,gh.registry.display_login
Registry,user_id,gh.registry.owner_id
Registry,namespace,gh.registry.namespace
Registry,namespace,gh.registry.user_name
Registry,version,gh.registry.version
Registry,no_versions,gh.registry.no_versions
Registry,latest_version_id,gh.registry.latest_version_id
Registry,force,gh.registry.force
Registry,retry_failed,gh.registry.retry_failed
Registry,package_type,gh.registry.package_type
Registry,N/A,gh.registry.pkg_count
Registry,N/A,gh.registry.namespace_count
Registry,N/A,gh.registry.unmigrated_package_count
Registry,repo,gh.registry.repository_name
Packages,name,gh.packages.user_name
Packages,repo,gh.packages.repository_name
Packages,actions_usage,gh.packages.actions_usage
Packages,combined_usage,gh.packages.combined_usage
Packages,known_packages_usage,gh.packages.known_packages_usage
Packages,overcharged_usage,gh.packages.overcharged_usage
Packages,billing_difference,gh.packages.billing_difference
Container Registry,owner,gh.container-registry.owner_name
Container Registry,repository,gh.container-registry.repository_name
Container Registry,combined_usage,gh.container-registry.combined_usage
Container Registry,actions_usage,gh.container-registry.actions_usage
Container Registry,non_docker_usage,gh.container-registry.non_docker_usage
Container Registry,docker_usage,gh.container-registry.docker_usage
Container Registry,size,gh.container-registry.size
Registry,package_id,gh.registry.package_id
Registry,unmigrated_count,gh.registry.unmigrated_count
Registry,failed_count,gh.registry.failed_count
Registry,unmigrated_ver_count,gh.registry.unmigrated_ver_count
Registry,failed_ver_count,gh.registry.failed_ver_count
Registry,id,gh.registry.migration_run_id
Registry,success_pkg_count,gh.registry.success_pkg_count
Registry,failed_pkg_count,gh.registry.failed_pkg_count
Registry,success_org_count,gh.registry.success_org_count
Registry,failed_org_count,gh.registry.failed_org_count
Registry,migrated_pkg_count,gh.registry.migrated_pkg_count
Registry,total_org_count,gh.registry.total_org_count
Registry,total_pkg_count,gh.registry.total_pkg_count
Registry,enqueued_at,gh.registry.job_enqueued_at
Registry,is_forced,gh.registry.job_is_forced
Registry,is_error_retry,gh.registry.job_is_error_retry
Registry,delay_package_migration,gh.registry.job_delay_package_migration
Registry,is_first_run,gh.registry.job_is_first_run
Registry,offset_id,gh.registry.job_offset_id
Registry,progress,gh.registry.job_progress
Registry,created_at,gh.registry.created_at
Registry,unmigrated_version_count,gh.registry.unmigrated_version_count
Registry,owner_ids,gh.registry.unmigrated_owner_ids
Registry,ecosystem,gh.registry.package_ecosystem
Registry,batch,gh.registry.batch
Registry,namespace,gh.registry.package_namespace
Registry,N/A,gh.registry.version_name
Registry,N/A,gh.registry.retry_count
Registry,version_id,gh.registry.version_id
Registry,owner,gh.registry.owner_namespace
Registry,actor_id,gh.registry.actor_id
Registry,version_deleted_name,gh.registry.version_deleted_name
Registry,N/A,gh.registry.hydro_message
Registry,N/A,gh.registry.hydro_partition
Registry,N/A,gh.registry.hydro_offset
Registry,user,gh.registry.user
Registry,N/A,gh.registry.migrated_package_id
Registry,unmigrated_count,gh.registry.unmigrated_count
Registry,last_migrated_package_id,gh.registry.last_migrated_package_id
Registry,last_migrated_version_id,gh.registry.last_migrated_version_id
Registry,value,gh.registry.value
AWS Namespace Cleaner,readonly,gh.aws_namespace_cleaner.readonly
AWS Namespace Cleaner,namespace,gh.aws_namespace_cleaner.namespace
AWS Namespace Cleaner,owner_id,gh.aws_namespace_cleaner.owner_id
AWS Namespace Cleaner,batch_size,gh.aws_namespace_cleaner.batch_size
AWS Namespace Cleaner,count,gh.aws_namespace_cleaner.count
AWS Namespace Cleaner,objects,gh.aws_namespace_cleaner.objects
AWS Namespace Cleaner,errors,gh.aws_namespace_cleaner.errors
AWS Namespace Cleaner,guid,gh.aws_namespace_cleaner.guid
AWS Namespace Cleaner,deleted,gh.aws_namespace_cleaner.deleted
Apps,github_app,gh.integration.slug
Apps,current_integration,gh.integration.id
Apps,current_integration_installation,gh.installation.id
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Administering your instance using the GitHub CLI
intro: 'You can adminster your GitHub Enterprise Server instance using the GitHub CLI extension for GHES Manage API.'
versions:
feature: ghes-manage-api-cli-extension
type: how_to
topics:
- Enterprise
- Fundamentals
shortTitle: Using the GitHub CLI
---
## About the `gh es` extension for {% data variables.product.prodname_cli %}

{% data reusables.cli.about-cli %} For more information about the {% data variables.product.prodname_cli %}, see "[AUTOTITLE](/github-cli/github-cli/about-github-cli)".

`gh es` is a {% data variables.product.prodname_cli %} extension that allows you to perform administrative tasks on {% data variables.location.product_location %} by using the instance's REST API endpoints. For more information about GitHub CLI extensions, see "[AUTOTITLE](/github-cli/github-cli/using-github-cli-extensions)".

You can use the `gh es` extension to manage the root site administrator password, configure maintenance mode, view metadata and status information for your instance's nodes, and more. For installation and usage instructions, see the [github/gh-es repository](https://github.com/github/gh-es) on {% data variables.product.prodname_dotcom_the_website %}.

## Further reading

- "[AUTOTITLE](/rest/enterprise-admin/manage-ghes)"
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ $ ghe-announce -d -s MESSAGE
> Announcement message set.
# Removes a previously set message
$ ghe-announce -u
> Removed the announcement message, which was user dismissible: MESSAGE
> Removed the announcement message, which was user
> dismissible: MESSAGE
```

{% endif %}
Expand All @@ -68,9 +69,11 @@ With this command, you can also pause or resume jobs in the queue.

```shell
$ ghe-aqueduct status
# lists queues and the number of currently queued jobs for all queues
# lists queues and the number of currently queued jobs
# for all queues
$ ghe-aqueduct queue_depth --queue QUEUE
# lists the number of currently queued jobs for the specified queue
# lists the number of currently queued jobs for the
# specified queue
$ ghe-aqueduct pause --queue QUEUE
# pauses the specified queue
$ ghe-aqueduct resume --queue QUEUE
Expand Down Expand Up @@ -115,7 +118,8 @@ With this utility, you can both retrieve and modify the configuration settings o
$ ghe-config core.github-hostname
# Gets the configuration value of `core.github-hostname`
$ ghe-config core.github-hostname URL
# Sets the configuration value of `core.github-hostname` to the specified URL
# Sets the configuration value of `core.github-hostname`
# to the specified URL
$ ghe-config -l
# Lists all the configuration values
```
Expand All @@ -130,7 +134,8 @@ Allows you to exempt a list of users from REST API rate limits. A hard limit of

``` shell
$ ghe-config app.github.rate-limiting-exempt-users "hubot github-actions[bot]"
# Exempts the users hubot and github-actions[bot] from rate limits. Usernames are case-sensitive.
# Exempts the users hubot and github-actions[bot] from rate limits.
# Usernames are case-sensitive.
```

### ghe-config-apply
Expand Down Expand Up @@ -632,6 +637,27 @@ ghe-cluster-balance help

{% endif %}

### ghe-cluster-maintenance

With the `ghe-cluster-maintenance` utility, you can set or unset maintenance mode for every node in a cluster.

```shell
$ ghe-cluster-maintenance -h
# Shows options
$ ghe-cluster-maintenance -q
# Queries the current mode
$ ghe-cluster-maintenance -s
# Sets maintenance mode
{%- ifversion custom-maintenance-mode-message %}
$ ghe-cluster-maintenance -s "MESSAGE"
# Sets maintenance mode with a custom message
$ ghe-cluster-maintenance -m "MESSAGE"
# Updates the custom message
{%- endif %}
$ ghe-cluster-maintenance -u
# Unsets maintenance mode
```

### ghe-cluster-status

Check the health of your nodes and services in a cluster deployment of {% data variables.product.prodname_ghe_server %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ topics:
- Enterprise
children:
- /accessing-the-administrative-shell-ssh
- /administering-your-instance-using-the-github-cli
- /command-line-utilities
shortTitle: Command line
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ topics:

{% data reusables.enterprise_site_admin_settings.management-console-access %} For more information about {% data variables.enterprise.management_console %} access, see "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console)."

{% ifversion ghes-manage-api-cli-extension %}You can also use the `gh es` {% data variables.product.prodname_cli %} extension to manage the root site administrator password, which controls access to the Management Console. For more information, see the [GH ES CLI usage documentation](https://github.com/github/gh-es/blob/main/USAGE.md#gh-es-access-set-password) and "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli)".{% endif %}

{% ifversion enterprise-management-console-multi-user-auth %}

## Types of {% data variables.enterprise.management_console %} accounts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,30 +93,25 @@ You can schedule maintenance for different times or dates with the {% data varia

{% endif %}

## Enabling or disabling maintenance mode for {% data variables.product.prodname_ghe_server %} via the CLI
{% ifversion ghes-manage-api-cli-extension %}

With the `ghe-maintenance` utility, you can set or unset maintenance mode for a single instance of {% data variables.product.prodname_ghe_server %}.
## Managing maintenance mode using the {% data variables.product.prodname_cli %}

```shell
$ ghe-maintenance -h
# Shows options
$ ghe-maintenance -q
# Queries the current mode
$ ghe-maintenance -s
# Sets maintenance mode
{%- ifversion custom-maintenance-mode-message %}
$ ghe-maintenance -s "MESSAGE"
# Sets maintenance mode with a custom message
$ ghe-maintenance -m "MESSAGE"
# Updates the custom message
{%- endif %}
$ ghe-maintenance -u
# Unsets maintenance mode
```
You can manage maintenance mode on {% data variables.location.product_location %} using the {% data variables.product.prodname_cli %} `gh es` extension. For more information, see the GH ES CLI usage documentation for [`gh es maintenance set`](https://github.com/github/gh-es/blob/main/USAGE.md#gh-es-maintenance-set) and [`gh es maintenance get`](https://github.com/github/gh-es/blob/main/USAGE.md#gh-es-maintenance-get).

For more information, see "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli)".

{% endif %}

{% ifversion custom-maintenance-mode-message %}

## Enabling or disabling maintenance mode for all nodes in a cluster via the CLI
## Managing maintenance mode using SSH

With the `ghe-cluster-maintenance` utility, you can set or unset maintenance mode for every node in a cluster.
If you have SSH access, you can use the `ghe-maintenance` command line utility to can set or unset maintenance mode for a {% data variables.product.product_name %} instance with one node, or multiple nodes in a high-availability configuration. For more information, see "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)" and "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-maintenance)."

## Managing maintenance mode for a cluster using SSH

If you have SSH access to your {% data variables.product.prodname_ghe_server %} instance, you can use the `ghe-cluster-maintenance` command line utility to set or unset maintenance mode for every node in a cluster. For more information, see "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)" and "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-cluster-maintenance)."

```shell
$ ghe-cluster-maintenance -h
Expand All @@ -134,3 +129,5 @@ $ ghe-cluster-maintenance -m "MESSAGE"
$ ghe-cluster-maintenance -u
# Unsets maintenance mode
```

{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ admin@ghe-data-node-0:~$ ghe-cluster-status | grep error

{% endnote %}

{% ifversion ghes-manage-api-cli-extension %}

## Monitoring cluster status using the {% data variables.product.prodname_cli %}

You can use the `gh es` extension for {% data variables.product.prodname_cli %} to check the status of your {% data variables.product.product_name %} cluster. For more information, see the [GH ES CLI usage documentation](https://github.com/github/gh-es/blob/main/USAGE.md#gh-es-cluster-status) and "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli)".

{% endif %}

## Monitoring cluster status with Nagios

You can configure [Nagios](https://www.nagios.org/) to monitor {% data variables.product.prodname_ghe_server %}. In addition to monitoring basic connectivity to each of the cluster nodes, you can check the cluster status by configuring Nagios to use the `ghe-cluster-status -n` command. This returns output in a format that Nagios understands.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ You can also monitor replication status from the overview dashboard on your inst

`http(s)://HOSTNAME/setup/replication`

{% ifversion ghes-manage-api-cli-extension %}

## Monitoring replication using the {% data variables.product.prodname_cli %}

You can monitor replication status on your instance using the `gh es` extension for {% data variables.product.prodname_cli %}. For more information, see the [GH ES CLI usage documentation](https://github.com/github/gh-es/blob/main/USAGE.md#gh-es-replication-status)" and "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli)".

{% endif %}

{% ifversion replication-management-api %}

## Monitoring replication using the REST API
Expand Down
4 changes: 2 additions & 2 deletions content/admin/overview/system-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-ent

{% data variables.product.product_name %} runs a customized Linux operating system with only the necessary applications and services. {% data variables.product.company_short %} distributes patches for the instance's core operating system as part of its standard product release cycle. Patches address functionality, stability, and non-critical security issues for {% data variables.product.product_name %}. {% data variables.product.company_short %} also provides critical security patches as needed outside of the regular release cycle.

{% data variables.product.product_name %} is provided as an appliance, and many of the operating system packages are modified compared to the usual Debian distribution. We do not support modifying the underlying operating system for this reason (including operating system upgrades), which is aligned with the [{% data variables.product.prodname_ghe_server %} license and support agreement](https://enterprise.github.com/license), under section 11.3 Exclusions.
{% data variables.product.product_name %} is provided as an appliance, and many of the operating system packages are modified compared to the usual {% ifversion ghes > 3.10 %}Ubuntu{% else %}Debian{% endif %} distribution. We do not support modifying the underlying operating system for this reason (including operating system upgrades), which is aligned with the [{% data variables.product.prodname_ghe_server %} license and support agreement](https://enterprise.github.com/license), under section 11.3 Exclusions.

Currently, the base operating system for {% data variables.product.product_name %} is Debian 10 (Buster), which receives support under the Debian Long Term Support program.
Currently, the base operating system for {% data variables.product.product_name %} is {% ifversion ghes > 3.10 %}Ubuntu 20 (Focal Fossa){% else %}Debian 10 (Buster), which receives support under the Debian Long Term Support program{% endif %}.

Regular patch updates are released on the {% data variables.product.product_name %} [releases](https://enterprise.github.com/releases) page, and the [release notes](/admin/release-notes) page provides more information. These patches typically contain upstream vendor and project security patches after they've been tested and quality approved by our engineering team. There can be a slight time delay from when the upstream update is released to when it's tested and bundled in an upcoming {% data variables.product.product_name %} patch release.

Expand Down
5 changes: 3 additions & 2 deletions content/rest/orgs/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: Rules
shortTitle: Rules
intro: >-
Use the REST API to manage rulesets for organizations. Organization
rulesets control how people can interact with selected branches and tags in
Use the REST API to manage rulesets for organizations. Organization rulesets
control how people can interact with selected branches and tags in
repositories in an organization.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
ghes: '>=3.11'
topics:
- API
autogenerated: rest
Expand Down
5 changes: 3 additions & 2 deletions content/rest/repos/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ intro: >-
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
ghes: '>=3.11'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
redirect_from:
- /early-access/repositories/using-the-rest-api-to-manage-repository-rulesets
redirect_from:
- /early-access/repositories/using-the-rest-api-to-manage-repository-rulesets
---

<!-- Content after this section is automatically generated -->
3 changes: 2 additions & 1 deletion content/rest/security-advisories/global-advisories.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Global security advisories
intro: 'Use the REST API to view global security advisories.'
intro: Use the REST API to view global security advisories.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
ghes: '>=3.11'
topics:
- API
autogenerated: rest
Expand Down
1 change: 1 addition & 0 deletions content/rest/security-advisories/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: Use the REST API to view and manage security advisories.
versions:
fpt: '*'
ghec: '*'
ghes: '>=3.11'
topics:
- API
children:
Expand Down
4 changes: 4 additions & 0 deletions data/features/ghes-manage-api-cli-extension.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Reference: #11807
# GH CLI extension for GHES Manage API
versions:
ghes: '>=3.11'
Loading
Loading