Skip to content

Commit 8bd8c10

Browse files
vgrllecoursenkellyarwinebuckelijgithub-openapi-bot
authored
GitHub Enterprise Server 3.3 release candidate (github#22286)
Co-authored-by: Laura Coursen <[email protected]> Co-authored-by: Kelly Arwine <[email protected]> Co-authored-by: vgrl <[email protected]> Co-authored-by: Elijah Buck <[email protected]> Co-authored-by: Laura Coursen <[email protected]> Co-authored-by: Kelly Arwine <[email protected]> Co-authored-by: github-openapi-bot <[email protected]> Co-authored-by: Felicity Chapman <[email protected]> Co-authored-by: Jules Parker <[email protected]> Co-authored-by: mc <[email protected]> Co-authored-by: github-openapi-bot <[email protected]> Co-authored-by: github-openapi-bot <[email protected]> Co-authored-by: Matt Pollard <[email protected]>
1 parent 05d02fe commit 8bd8c10

File tree

210 files changed

+624602
-248
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

210 files changed

+624602
-248
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Loading
8.72 KB
Loading
Binary file not shown.
Loading
Loading
Loading
Loading
Loading
Loading

content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ To add a `repo:` filter, you must include the owner of the repository in the que
108108

109109
### Supported `is:` queries
110110

111-
To filter notifications for specific activity on {% data variables.product.product_location %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot %}{% else %} security{% endif %} alerts, use `is:repository-vulnerability-alert`.{% endif %}
111+
To filter notifications for specific activity on {% data variables.product.product_location %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% data variables.product.prodname_dependabot %} alerts, use `is:repository-vulnerability-alert`{% endif %}.
112112

113113
- `is:check-suite`
114114
- `is:commit`
@@ -167,7 +167,7 @@ For example, to see notifications from the octo-org organization, use `org:octo-
167167
{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
168168
## {% data variables.product.prodname_dependabot %} custom filters
169169

170-
{% ifversion fpt or ghec %}
170+
{% ifversion fpt or ghec or ghes > 3.2 %}
171171
If you use {% data variables.product.prodname_dependabot %} to keep your dependencies up-to-date, you can use and save these custom filters:
172172
- `is:repository_vulnerability_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %}.
173173
- `reason:security_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %} and security update pull requests.
@@ -176,9 +176,9 @@ If you use {% data variables.product.prodname_dependabot %} to keep your depende
176176
For more information about {% data variables.product.prodname_dependabot %}, see "[About managing vulnerable dependencies](/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies)."
177177
{% endif %}
178178

179-
{% ifversion ghes or ghae-issue-4864 %}
179+
{% ifversion ghes < 3.3 or ghae-issue-4864 %}
180180

181-
If you use {% data variables.product.prodname_dependabot %} to keep your dependencies-up-to-date, you can use and save these custom filters to show notifications for {% data variables.product.prodname_dependabot_alerts %}:
181+
If you use {% data variables.product.prodname_dependabot %} to tell you about vulnerable dependencies, you can use and save these custom filters to show notifications for {% data variables.product.prodname_dependabot_alerts %}:
182182
- `is:repository_vulnerability_alert`
183183
- `reason:security_alert`
184184

content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ intro: 'You can control features that secure and analyze the code in your projec
44
versions:
55
fpt: '*'
66
ghec: '*'
7+
ghes: '>3.2'
78
topics:
89
- Accounts
910
redirect_from:
@@ -17,6 +18,8 @@ shortTitle: Manage security & analysis
1718

1819
You can still manage the security and analysis features for individual repositories. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."
1920

21+
You can also review the security log for all activity on your user account. For more information, see "[Reviewing your security log](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)."
22+
2023
{% data reusables.security.some-security-and-analysis-features-are-enabled-by-default %}
2124

2225
{% data reusables.security.security-and-analysis-features-enable-read-only %}
@@ -28,23 +31,23 @@ For an overview of repository-level security, see "[Securing your repository](/c
2831
{% data reusables.user_settings.access_settings %}
2932
{% data reusables.user_settings.security-analysis %}
3033
3. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**.
31-
!["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/settings/security-and-analysis-disable-or-enable-all.png)
32-
6. Optionally, enable the feature by default for new repositories in your organization.
33-
!["Enable by default" option for new repositories](/assets/images/help/settings/security-and-analysis-enable-by-default-in-modal.png)
34+
{% ifversion ghes > 3.2 %}!["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/enterprise/3.3/settings/security-and-analysis-disable-or-enable-all.png){% else %}!["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/settings/security-and-analysis-disable-or-enable-all.png){% endif %}
35+
6. Optionally, enable the feature by default for new repositories that you own.
36+
{% ifversion ghes > 3.2 %}!["Enable by default" option for new repositories](/assets/images/enterprise/3.3/settings/security-and-analysis-enable-by-default-in-modal.png){% else %}!["Enable by default" option for new repositories](/assets/images/help/settings/security-and-analysis-enable-by-default-in-modal.png){% endif %}
3437
7. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories you own.
35-
![Button to disable or enable feature](/assets/images/help/settings/security-and-analysis-enable-dependency-graph.png)
38+
{% ifversion ghes > 3.2 %}![Button to disable or enable feature](/assets/images/enterprise/3.3/settings/security-and-analysis-enable-dependency-graph.png){% else %}![Button to disable or enable feature](/assets/images/help/settings/security-and-analysis-enable-dependency-graph.png){% endif %}
3639

3740
{% data reusables.security.displayed-information %}
3841

3942
## Enabling or disabling features for new repositories
4043

4144
{% data reusables.user_settings.access_settings %}
4245
{% data reusables.user_settings.security-analysis %}
43-
3. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories in your organization.
44-
![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/settings/security-and-analysis-enable-or-disable-feature-checkbox.png)
46+
3. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories that you own.
47+
{% ifversion ghes > 3.2 %}![Checkbox for enabling or disabling a feature for new repositories](/assets/images/enterprise/3.3/settings/security-and-analysis-enable-or-disable-feature-checkbox.png){% else %}![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/settings/security-and-analysis-enable-or-disable-feature-checkbox.png){% endif %}
4548

4649
## Further reading
4750

4851
- "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)"
4952
- "[Managing vulnerabilities in your project's dependencies](/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies)"
50-
{% ifversion fpt or ghec %}- "[Keeping your dependencies updated automatically](/github/administering-a-repository/keeping-your-dependencies-updated-automatically)"{% endif %}
53+
- "[Keeping your dependencies updated automatically](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically)"

content/admin/advanced-security/deploying-github-advanced-security-in-your-enterprise.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -290,15 +290,11 @@ GitHub helps you avoid using third-party software that contains known vulnerabil
290290
|----|----|
291291
| Dependabot Alerts | You can track your repository's dependencies and receive Dependabot alerts when your enterprise detects vulnerable dependencies. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)." |
292292
| Dependency Graph | The dependency graph is a summary of the manifest and lock files stored in a repository. It shows you the ecosystems and packages your codebase depends on (its dependencies) and the repositories and packages that depend on your project (its dependents). For more information, see "[About the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)." |{% ifversion ghes > 3.1 or ghec %}
293-
| Dependency Review | If a pull request contains changes to dependencies, you can view a summary of what has changed and whether there are known vulnerabilities in any of the dependencies. For more information, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)" or "[Reviewing Dependency Changes in a Pull Request](/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)." | {% endif %} {% ifversion ghec %}
293+
| Dependency Review | If a pull request contains changes to dependencies, you can view a summary of what has changed and whether there are known vulnerabilities in any of the dependencies. For more information, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)" or "[Reviewing Dependency Changes in a Pull Request](/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)." | {% endif %} {% ifversion ghec or ghes > 3.2 %}
294294
| Dependabot Security Updates | Dependabot can fix vulnerable dependencies for you by raising pull requests with security updates. For more information, see "[About Dependabot security updates](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)." |
295295
| Dependabot Version Updates | Dependabot can be used to keep the packages you use updated to the latest versions. For more information, see "[About Dependabot version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates)." | {% endif %}
296296

297-
{% note %}
298-
299-
**Note:** Dependabot security updates and version updates are currently only available for {% data variables.product.prodname_ghe_cloud %} and will be available for {% data variables.product.prodname_ghe_server %} as outlined in our [public roadmap](https://github.com/github/roadmap).
300-
301-
{% endnote %}
297+
{% data reusables.dependabot.beta-security-and-version-updates-onboarding %}
302298

303299
### Step 8: Establish a remediation process
304300

content/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ For example, you can enable any {% data variables.product.prodname_GH_advanced_s
110110
```shell
111111
ghe-config app.secret-scanning.enabled false
112112
```
113-
- To disable {% data variables.product.prodname_dependabot %}, enter the following {% ifversion ghes > 3.1 %}command{% else %}commands{% endif %}.
113+
- To disable {% data variables.product.prodname_dependabot_alerts %}, enter the following {% ifversion ghes > 3.1 %}command{% else %}commands{% endif %}.
114114
{% ifversion ghes > 3.1 %}```shell
115115
ghe-config app.dependency-graph.enabled false
116116
```

content/admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-the-dependency-graph-and-dependabot-alerts-on-your-enterprise-account.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ Before enabling {% data variables.product.prodname_dependabot_alerts %} for your
103103

104104
{% endtip %}
105105

106+
When you enable {% data variables.product.prodname_dependabot_alerts %}, you should consider also setting up {% data variables.product.prodname_actions %} for {% data variables.product.prodname_dependabot_security_updates %}. This feature allows developers to fix vulnerabilities in their dependencies. For more information, see "[Setting up {% data variables.product.prodname_dependabot %} security and version updates on your enterprise](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/setting-up-dependabot-updates)."
107+
106108
## Viewing vulnerable dependencies on {% data variables.product.product_location %}
107109

108110
You can view all vulnerabilities in {% data variables.product.product_location %} and manually sync vulnerability data from {% data variables.product.prodname_dotcom_the_website %} to update the list.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: About repository caching
3+
intro: "You can increase the performance of Git read operations for distributed teams and CI farms with repository caching."
4+
versions:
5+
ghes: '>=3.3'
6+
type: overview
7+
topics:
8+
- Enterprise
9+
---
10+
11+
{% data reusables.enterprise.repository-caching-release-phase %}
12+
13+
If you have teams and CI farms located around the world, you may experience reduced performance on your primary {% data variables.product.prodname_ghe_server %} instance. While active geo-replicas can improve the performance of read requests, this comes at the cost of limiting write throughput. To reduce load on your primary instance and improve write throughput performance, you can configure a repository cache, an asynchronous read-only mirror of repositories located near these geographically-distributed clients.
14+
15+
A repository cache eliminates the need for {% data variables.product.product_name %} to transmit the same Git data over a long-haul network link multiple times to serve multiple clients, by serving your repository data close to CI farms and distributed teams. For instance, if your primary instance is in North America and you also have a large presence in Asia, you will benefit from setting up the repository cache in Asia for use by CI runners there.
16+
17+
The repository cache listens to the primary instance, whether that's a single instance or a geo-replicated set of instances, for changes to Git data. CI farms and other read-heavy consumers clone and fetch from the repository cache instead of the primary instance. Changes are propagated across the network, at periodic intervals, once per cache instance rather than once per client. Git data will typically be visible on the repository cache within several minutes after the data is pushed to the primary instance.
18+
19+
You have fine-grained control over which repositories are allowed to sync to the repository cache.
20+
21+
{% data reusables.enterprise.repository-caching-config-summary %} For more information, see "[Configuring a repository cache](/admin/enterprise-management/caching-repositories/configuring-a-repository-cache)."
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
title: Configuring a repository cache
3+
intro: "You can configure a repository cache by creating a new appliance, connecting the repository cache to your primary appliance, and configuring replication of repository networks to the repository cache."
4+
versions:
5+
ghes: '>=3.3'
6+
type: how_to
7+
topics:
8+
- Enterprise
9+
---
10+
11+
{% data reusables.enterprise.repository-caching-release-phase %}
12+
13+
## About configuration for repository caching
14+
15+
{% data reusables.enterprise.repository-caching-config-summary %} Then, you can set data location policies that govern which repository networks are replicated to the repository cache.
16+
17+
Repository caching is not supported with clustering.
18+
19+
## DNS for repository caches
20+
21+
The primary instance and repository cache should have different DNS names. For example, if your primary instance is at `github.example.com`, you might decide to name a cache `europe-ci.github.example.com` or `github.asia.example.com`.
22+
23+
To have your CI machines fetch from the repository cache instead of the primary instance, you can use Git's `url.<base>.insteadOf` configuration setting. For more information, see [`git-config`](https://git-scm.com/docs/git-config#Documentation/git-config.txt-urlltbasegtinsteadOf) in the Git documentation.
24+
25+
For example, the global `.gitconfig` for the CI machine would include these lines.
26+
27+
```
28+
[url "https://europe-ci.github.example.com/"]
29+
insteadOf = https://github.example.com/
30+
```
31+
32+
Then, when told to fetch `https://github.example.com/myorg/myrepo`, Git will instead fetch from `https://europe-ci.github.example.com/myorg/myrepo`.
33+
34+
## Configuring a repository cache
35+
36+
1. During the beta, you must enable the feature flag for repository caching on your primary {% data variables.product.prodname_ghe_server %} appliance.
37+
38+
```
39+
$ ghe-config cluster.cache-enabled true
40+
```
41+
42+
1. Set up a new {% data variables.product.prodname_ghe_server %} appliance on your desired platform. This appliance will be your repository cache. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/admin/guides/installation/setting-up-a-github-enterprise-server-instance)."
43+
{% data reusables.enterprise_installation.replica-steps %}
44+
1. Connect to the repository cache's IP address using SSH.
45+
46+
```shell
47+
$ ssh -p 122 admin@<em>REPLICA IP</em>
48+
```
49+
50+
{% data reusables.enterprise_installation.generate-replication-key-pair %}
51+
{% data reusables.enterprise_installation.add-ssh-key-to-primary %}
52+
1. To verify the connection to the primary and enable replica mode for the repository cache, run `ghe-repl-setup` again.
53+
54+
```shell
55+
$ ghe-repl-setup <em>PRIMARY IP</em>
56+
```
57+
58+
1. Set a `cache_location` for the repository cache, replacing *CACHE-LOCATION* with an alphanumeric identifier, such as the region where the cache is deployed.
59+
60+
```shell
61+
$ ghe-repl-node --cache <em>CACHE-LOCATION</em>
62+
```
63+
64+
{% data reusables.enterprise_installation.replication-command %}
65+
{% data reusables.enterprise_installation.verify-replication-channel %}
66+
1. To enable replication of repository networks to the repository cache, set a data location policy. For more information, see "[Data location policies](#data-location-policies)."
67+
68+
## Data location policies
69+
70+
You can control data locality by configuring data location policies for your repositories with the `spokesctl cache-policy` command. Data location policies determine which repository networks are replicated on which repository caches. By default, no repository networks will be replicated on any repository caches until a data location policy is configured.
71+
72+
You can configure a policy to replicate all networks with the `--default` flag. For example, this command will create a policy to replicate a single copy of every repository network to the set of repository caches whose `cache_location` is "kansas".
73+
74+
```
75+
$ ghe-spokesctl cache-policy set --default 1 kansas
76+
```
77+
78+
To configure replication for a repository network, specify the repository that is the root of the network. A repository network includes a repository and all of the repository's forks. You cannot replicate part of a network without replicating the whole network.
79+
80+
```
81+
$ ghe-spokesctl cache-policy set <owner/repository> 1 kansas
82+
```
83+
84+
You can override a policy that replicates all networks and exclude specific networks by specifying a replica count of zero for the network. For example, this command specifies that any repository cache in location "kansas" cannot contain any copies of that network.
85+
86+
```
87+
$ ghe-spokesctl cache-policy set <owner/repository> 0 kansas
88+
```
89+
90+
Replica counts greater than one in a given cache location are not supported.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Caching repositories
3+
intro: "You can improve performance for your geographically-distributed team with repository caching, which provides read-only mirrors close to your users and CI clients."
4+
versions:
5+
ghes: '>=3.3'
6+
topics:
7+
- Enterprise
8+
children:
9+
- /about-repository-caching
10+
- /configuring-a-repository-cache
11+
---
12+
13+
{% data reusables.enterprise.repository-caching-release-phase %}

0 commit comments

Comments
 (0)