Skip to content

Commit 352440f

Browse files
isaacmbrownmattpollardrachaelrenkdocs-botvgrl
authored
GitHub Enterprise Server 3.11 release candidate (#44684)
Co-authored-by: Matt Pollard <[email protected]> Co-authored-by: Rachael Rose Renk <[email protected]> Co-authored-by: docs-bot <[email protected]> Co-authored-by: Vanessa <[email protected]>
1 parent 3f55bf9 commit 352440f

File tree

35 files changed

+894614
-40
lines changed

35 files changed

+894614
-40
lines changed

‎assets/ghes-3.11-opentelemetry-attribute-mappings.csv‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
Category,Old Attribute,New Attribute
2+
Memex,queue,gh.job.queue
3+
Memex,status,gh.memex.automation.status
4+
Memex,topic,messaging.kafka.source.topic
5+
Memex,partition,messaging.kafka.source.partition
6+
Memex,schema,messaging.kafka.message.schema
7+
Memex,offset,messaging.kafka.message.offset
8+
Memex,timestamp,messaging.kafka.message.timestamp
9+
Memex,item_ids,gh.memex.unauthorized_item_ids
10+
Authzd,authzd_request,gh.authzd.request.attributes
11+
Authzd,authzd.request,gh.authzd.request.attributes
12+
Authzd,authzd_response,gh.authzd.decisions
13+
Authzd,authzd.response,gh.authzd.decisions
14+
Authzd,authzd.rpc,gh.authzd.rpc
15+
Authzd,gh.authzd.enumerator.request.size,gh.authzd.enumerator.response.size
16+
Dependency Graph,job_timeout,gh.job.timeout
17+
Dependency Graph,push_id,gh.push.id
18+
Dependency Graph,ref,gh.commit.ref
19+
Dependency Graph,commit_sha,gh.commit.oid
20+
Dependency Graph,repo_count,gh.dependency_graph.manifest_paths_count
21+
Dependency Graph,max_manifest_files,gh.dependency_graph.max_manifest_files
22+
Dependency Graph,push_count,gh.dependency_graph.changed_manifest.count
23+
Dependency Graph,base,gh.comparison.base_rev
24+
Dependency Graph,head,gh.comparison.head_rev
25+
Driftwood,deployed_to,gh.driftwood.deployed_to
26+
Driftwood,release,gh.driftwood.release
27+
Driftwood,ref,gh.driftwood.ref
28+
Driftwood,service,gh.driftwood.service
29+
Driftwood,exception_id,gh.driftwood.exception_id
30+
Registry,ecosystem,gh.registry.ecosystem
31+
Registry,v2_enabled,gh.registry.v2_enabled
32+
Registry,display_login,gh.registry.display_login
33+
Registry,user_id,gh.registry.owner_id
34+
Registry,namespace,gh.registry.namespace
35+
Registry,namespace,gh.registry.user_name
36+
Registry,version,gh.registry.version
37+
Registry,no_versions,gh.registry.no_versions
38+
Registry,latest_version_id,gh.registry.latest_version_id
39+
Registry,force,gh.registry.force
40+
Registry,retry_failed,gh.registry.retry_failed
41+
Registry,package_type,gh.registry.package_type
42+
Registry,N/A,gh.registry.pkg_count
43+
Registry,N/A,gh.registry.namespace_count
44+
Registry,N/A,gh.registry.unmigrated_package_count
45+
Registry,repo,gh.registry.repository_name
46+
Packages,name,gh.packages.user_name
47+
Packages,repo,gh.packages.repository_name
48+
Packages,actions_usage,gh.packages.actions_usage
49+
Packages,combined_usage,gh.packages.combined_usage
50+
Packages,known_packages_usage,gh.packages.known_packages_usage
51+
Packages,overcharged_usage,gh.packages.overcharged_usage
52+
Packages,billing_difference,gh.packages.billing_difference
53+
Container Registry,owner,gh.container-registry.owner_name
54+
Container Registry,repository,gh.container-registry.repository_name
55+
Container Registry,combined_usage,gh.container-registry.combined_usage
56+
Container Registry,actions_usage,gh.container-registry.actions_usage
57+
Container Registry,non_docker_usage,gh.container-registry.non_docker_usage
58+
Container Registry,docker_usage,gh.container-registry.docker_usage
59+
Container Registry,size,gh.container-registry.size
60+
Registry,package_id,gh.registry.package_id
61+
Registry,unmigrated_count,gh.registry.unmigrated_count
62+
Registry,failed_count,gh.registry.failed_count
63+
Registry,unmigrated_ver_count,gh.registry.unmigrated_ver_count
64+
Registry,failed_ver_count,gh.registry.failed_ver_count
65+
Registry,id,gh.registry.migration_run_id
66+
Registry,success_pkg_count,gh.registry.success_pkg_count
67+
Registry,failed_pkg_count,gh.registry.failed_pkg_count
68+
Registry,success_org_count,gh.registry.success_org_count
69+
Registry,failed_org_count,gh.registry.failed_org_count
70+
Registry,migrated_pkg_count,gh.registry.migrated_pkg_count
71+
Registry,total_org_count,gh.registry.total_org_count
72+
Registry,total_pkg_count,gh.registry.total_pkg_count
73+
Registry,enqueued_at,gh.registry.job_enqueued_at
74+
Registry,is_forced,gh.registry.job_is_forced
75+
Registry,is_error_retry,gh.registry.job_is_error_retry
76+
Registry,delay_package_migration,gh.registry.job_delay_package_migration
77+
Registry,is_first_run,gh.registry.job_is_first_run
78+
Registry,offset_id,gh.registry.job_offset_id
79+
Registry,progress,gh.registry.job_progress
80+
Registry,created_at,gh.registry.created_at
81+
Registry,unmigrated_version_count,gh.registry.unmigrated_version_count
82+
Registry,owner_ids,gh.registry.unmigrated_owner_ids
83+
Registry,ecosystem,gh.registry.package_ecosystem
84+
Registry,batch,gh.registry.batch
85+
Registry,namespace,gh.registry.package_namespace
86+
Registry,N/A,gh.registry.version_name
87+
Registry,N/A,gh.registry.retry_count
88+
Registry,version_id,gh.registry.version_id
89+
Registry,owner,gh.registry.owner_namespace
90+
Registry,actor_id,gh.registry.actor_id
91+
Registry,version_deleted_name,gh.registry.version_deleted_name
92+
Registry,N/A,gh.registry.hydro_message
93+
Registry,N/A,gh.registry.hydro_partition
94+
Registry,N/A,gh.registry.hydro_offset
95+
Registry,user,gh.registry.user
96+
Registry,N/A,gh.registry.migrated_package_id
97+
Registry,unmigrated_count,gh.registry.unmigrated_count
98+
Registry,last_migrated_package_id,gh.registry.last_migrated_package_id
99+
Registry,last_migrated_version_id,gh.registry.last_migrated_version_id
100+
Registry,value,gh.registry.value
101+
AWS Namespace Cleaner,readonly,gh.aws_namespace_cleaner.readonly
102+
AWS Namespace Cleaner,namespace,gh.aws_namespace_cleaner.namespace
103+
AWS Namespace Cleaner,owner_id,gh.aws_namespace_cleaner.owner_id
104+
AWS Namespace Cleaner,batch_size,gh.aws_namespace_cleaner.batch_size
105+
AWS Namespace Cleaner,count,gh.aws_namespace_cleaner.count
106+
AWS Namespace Cleaner,objects,gh.aws_namespace_cleaner.objects
107+
AWS Namespace Cleaner,errors,gh.aws_namespace_cleaner.errors
108+
AWS Namespace Cleaner,guid,gh.aws_namespace_cleaner.guid
109+
AWS Namespace Cleaner,deleted,gh.aws_namespace_cleaner.deleted
110+
Apps,github_app,gh.integration.slug
111+
Apps,current_integration,gh.integration.id
112+
Apps,current_integration_installation,gh.installation.id

‎content/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Administering your instance using the GitHub CLI
3+
intro: 'You can adminster your GitHub Enterprise Server instance using the GitHub CLI extension for GHES Manage API.'
4+
versions:
5+
feature: ghes-manage-api-cli-extension
6+
type: how_to
7+
topics:
8+
- Enterprise
9+
- Fundamentals
10+
shortTitle: Using the GitHub CLI
11+
---
12+
## About the `gh es` extension for {% data variables.product.prodname_cli %}
13+
14+
{% data reusables.cli.about-cli %} For more information about the {% data variables.product.prodname_cli %}, see "[AUTOTITLE](/github-cli/github-cli/about-github-cli)".
15+
16+
`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)".
17+
18+
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 %}.
19+
20+
## Further reading
21+
22+
- "[AUTOTITLE](/rest/enterprise-admin/manage-ghes)"

‎content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md‎

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ $ ghe-announce -d -s MESSAGE
4242
> Announcement message set.
4343
# Removes a previously set message
4444
$ ghe-announce -u
45-
> Removed the announcement message, which was user dismissible: MESSAGE
45+
> Removed the announcement message, which was user
46+
> dismissible: MESSAGE
4647
```
4748

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

6970
```shell
7071
$ ghe-aqueduct status
71-
# lists queues and the number of currently queued jobs for all queues
72+
# lists queues and the number of currently queued jobs
73+
# for all queues
7274
$ ghe-aqueduct queue_depth --queue QUEUE
73-
# lists the number of currently queued jobs for the specified queue
75+
# lists the number of currently queued jobs for the
76+
# specified queue
7477
$ ghe-aqueduct pause --queue QUEUE
7578
# pauses the specified queue
7679
$ ghe-aqueduct resume --queue QUEUE
@@ -115,7 +118,8 @@ With this utility, you can both retrieve and modify the configuration settings o
115118
$ ghe-config core.github-hostname
116119
# Gets the configuration value of `core.github-hostname`
117120
$ ghe-config core.github-hostname URL
118-
# Sets the configuration value of `core.github-hostname` to the specified URL
121+
# Sets the configuration value of `core.github-hostname`
122+
# to the specified URL
119123
$ ghe-config -l
120124
# Lists all the configuration values
121125
```
@@ -130,7 +134,8 @@ Allows you to exempt a list of users from REST API rate limits. A hard limit of
130134

131135
``` shell
132136
$ ghe-config app.github.rate-limiting-exempt-users "hubot github-actions[bot]"
133-
# Exempts the users hubot and github-actions[bot] from rate limits. Usernames are case-sensitive.
137+
# Exempts the users hubot and github-actions[bot] from rate limits.
138+
# Usernames are case-sensitive.
134139
```
135140

136141
### ghe-config-apply
@@ -632,6 +637,27 @@ ghe-cluster-balance help
632637

633638
{% endif %}
634639

640+
### ghe-cluster-maintenance
641+
642+
With the `ghe-cluster-maintenance` utility, you can set or unset maintenance mode for every node in a cluster.
643+
644+
```shell
645+
$ ghe-cluster-maintenance -h
646+
# Shows options
647+
$ ghe-cluster-maintenance -q
648+
# Queries the current mode
649+
$ ghe-cluster-maintenance -s
650+
# Sets maintenance mode
651+
{%- ifversion custom-maintenance-mode-message %}
652+
$ ghe-cluster-maintenance -s "MESSAGE"
653+
# Sets maintenance mode with a custom message
654+
$ ghe-cluster-maintenance -m "MESSAGE"
655+
# Updates the custom message
656+
{%- endif %}
657+
$ ghe-cluster-maintenance -u
658+
# Unsets maintenance mode
659+
```
660+
635661
### ghe-cluster-status
636662

637663
Check the health of your nodes and services in a cluster deployment of {% data variables.product.prodname_ghe_server %}.

‎content/admin/administering-your-instance/administering-your-instance-from-the-command-line/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ topics:
88
- Enterprise
99
children:
1010
- /accessing-the-administrative-shell-ssh
11+
- /administering-your-instance-using-the-github-cli
1112
- /command-line-utilities
1213
shortTitle: Command line
1314
---

‎content/admin/administering-your-instance/administering-your-instance-from-the-web-ui/managing-access-to-the-management-console.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ topics:
1616

1717
{% 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)."
1818

19+
{% 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 %}
20+
1921
{% ifversion enterprise-management-console-multi-user-auth %}
2022

2123
## Types of {% data variables.enterprise.management_console %} accounts

‎content/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode.md‎

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -93,30 +93,25 @@ You can schedule maintenance for different times or dates with the {% data varia
9393

9494
{% endif %}
9595

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

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

100-
```shell
101-
$ ghe-maintenance -h
102-
# Shows options
103-
$ ghe-maintenance -q
104-
# Queries the current mode
105-
$ ghe-maintenance -s
106-
# Sets maintenance mode
107-
{%- ifversion custom-maintenance-mode-message %}
108-
$ ghe-maintenance -s "MESSAGE"
109-
# Sets maintenance mode with a custom message
110-
$ ghe-maintenance -m "MESSAGE"
111-
# Updates the custom message
112-
{%- endif %}
113-
$ ghe-maintenance -u
114-
# Unsets maintenance mode
115-
```
100+
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).
101+
102+
For more information, see "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli)".
103+
104+
{% endif %}
105+
106+
{% ifversion custom-maintenance-mode-message %}
116107

117-
## Enabling or disabling maintenance mode for all nodes in a cluster via the CLI
108+
## Managing maintenance mode using SSH
118109

119-
With the `ghe-cluster-maintenance` utility, you can set or unset maintenance mode for every node in a cluster.
110+
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)."
111+
112+
## Managing maintenance mode for a cluster using SSH
113+
114+
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)."
120115

121116
```shell
122117
$ ghe-cluster-maintenance -h
@@ -134,3 +129,5 @@ $ ghe-cluster-maintenance -m "MESSAGE"
134129
$ ghe-cluster-maintenance -u
135130
# Unsets maintenance mode
136131
```
132+
133+
{% endif %}

‎content/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/monitoring-the-health-of-your-cluster.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ admin@ghe-data-node-0:~$ ghe-cluster-status | grep error
4747

4848
{% endnote %}
4949

50+
{% ifversion ghes-manage-api-cli-extension %}
51+
52+
## Monitoring cluster status using the {% data variables.product.prodname_cli %}
53+
54+
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)".
55+
56+
{% endif %}
57+
5058
## Monitoring cluster status with Nagios
5159

5260
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.

‎content/admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/monitoring-a-high-availability-configuration.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ You can also monitor replication status from the overview dashboard on your inst
3131

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

34+
{% ifversion ghes-manage-api-cli-extension %}
35+
36+
## Monitoring replication using the {% data variables.product.prodname_cli %}
37+
38+
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)".
39+
40+
{% endif %}
41+
3442
{% ifversion replication-management-api %}
3543

3644
## Monitoring replication using the REST API

‎content/admin/overview/system-overview.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,9 @@ For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-ent
8080

8181
{% 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.
8282

83-
{% 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.
83+
{% 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.
8484

85-
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.
85+
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 %}.
8686

8787
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.
8888

‎content/rest/orgs/rules.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22
title: Rules
33
shortTitle: Rules
44
intro: >-
5-
Use the REST API to manage rulesets for organizations. Organization
6-
rulesets control how people can interact with selected branches and tags in
5+
Use the REST API to manage rulesets for organizations. Organization rulesets
6+
control how people can interact with selected branches and tags in
77
repositories in an organization.
88
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
99
fpt: '*'
1010
ghec: '*'
11+
ghes: '>=3.11'
1112
topics:
1213
- API
1314
autogenerated: rest

0 commit comments

Comments
 (0)