forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request github#31814 from github/repo-sync
Repo sync
- Loading branch information
Showing
9 changed files
with
223 additions
and
170 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
...ring-your-instance-from-the-web-ui/managing-search-indices-for-your-instance.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| title: Managing search indices for your instance | ||
| shortTitle: Manage search indices | ||
| intro: '{% data variables.product.product_name %} uses Elasticsearch to power search features, and provides tools for managing search and index behavior.' | ||
| permissions: Enterprise owners can manage search indices for a {% data variables.product.prodname_ghe_server %} instance. | ||
| versions: | ||
| ghes: '*' | ||
| type: reference | ||
| topics: | ||
| - Enterprise | ||
| - Fundamentals | ||
| --- | ||
|
|
||
| ## About search for {% data variables.product.prodname_ghe_server %} | ||
|
|
||
| Users can search your instance to find, navigate, and understand issues, pull requests, code, and other content on {% data variables.product.product_name %}. Elasticsearch powers the search functionality on your instance. You can view the current status of Elasticsearch, and you can control search and index behavior. | ||
|
|
||
| For more information about search for {% data variables.product.product_name %}, see "[AUTOTITLE](/search-github)." For more information about Elasticsearch, see the [Elasticsearch website](https://elastic.co). | ||
|
|
||
| ## About index management | ||
|
|
||
| {% data variables.product.product_name %} reconciles the state of the search index with data on the instance automatically and regularly, including: | ||
|
|
||
| - Issues, pull requests, repositories, and users in the database | ||
| - Git repositories (source code) on disk | ||
|
|
||
| In normal use, enterprise owners do not need to create new indices or schedule repair jobs. For troubleshooting or other support purposes, {% data variables.contact.github_support %} may instruct you to run a repair job. | ||
|
|
||
| ## Viewing search indices | ||
|
|
||
| 1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %}. | ||
| 1. In the left sidebar, click **Search indexes**. | ||
| 1. Under "Index management", click the search index you want to view. | ||
|
|
||
| ## Creating a new search index | ||
|
|
||
| 1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %}. | ||
| 1. In the left sidebar, click **Search indexes**. | ||
| 1. Next to "Index management", click **Create new index**. | ||
| 1. Select the **Select the index to create** dropdown, then click the search index you want to create. | ||
| 1. If you want the index to be searchable, select the **Make this index searchable** checkbox. | ||
| 1. If you want the index to be writable, select the **Make this index writable** checkbox. | ||
| 1. Click **Create index**. | ||
|
|
||
| ## Managing search indices | ||
|
|
||
| When you view an existing search index in the site admin dashboard, you can perform the following actions: | ||
|
|
||
| - Make the index searchable. | ||
| - Make the index writable. | ||
| - Update the index. | ||
| - Delete the index. | ||
| - Reset the index repair state. | ||
| - Start a new index repair job. | ||
| - Enable or disable index repair jobs. | ||
|
|
||
| ## Managing code search | ||
|
|
||
| You can enable or disable both search and index operations for source code. For more information about code search, see "[AUTOTITLE](/search-github/searching-on-github/searching-code)." | ||
|
|
||
| 1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %}. | ||
| 1. In the left sidebar, click **Search indexes**. | ||
| 1. In the "Code search" section, next to "Searching" or "Indexing", click **Enable** or **Disable**. | ||
|
|
||
| ## Repairing search indices | ||
|
|
||
| Your instance uses repair jobs to reconcile the data, and schedules a repair job in the background when the following events occur: | ||
|
|
||
| - A new search index is created. | ||
| - Missing data needs to be backfilled. | ||
| - Old search data needs to be updated. | ||
|
|
||
| In the "Repair" section of the search index, a progress bar shows the current status of a repair job across background workers. You can ignore the value shown in the progress bar after a repair job has completed. The progress bar shows the difference between the repair offset and the highest record ID in the database, and will decrease as more repositories are added to {% data variables.location.product_location %} even though those repositories are actually indexed. | ||
|
|
||
| To minimize the effects on I/O performance and reduce the chances of operations timing out, run the repair job during off-peak hours. As the job reconciles the search index with database and Git repository data, one CPU will be used. Monitor your system's load averages and CPU usage with a utility like `top`. If you don't notice any significant increase in resource consumption, it should also be safe to run an index repair job during peak hours. | ||
|
|
||
| Repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset. |
165 changes: 0 additions & 165 deletions
165
...ur-instance/administering-your-instance-from-the-web-ui/site-admin-dashboard.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
...ers-in-your-enterprise/about-reserved-usernames-for-github-enterprise-server.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| title: About reserved usernames for GitHub Enterprise Server | ||
| shortTitle: Reserved usernames | ||
| intro: Certain words are reserved for internal use and cannot be used as usernames. | ||
| permissions: Enterprise owners can view usernames reserved by {% data variables.product.product_name %}. | ||
| versions: | ||
| ghes: '*' | ||
| type: reference | ||
| topics: | ||
| - Enterprise | ||
| - Fundamentals | ||
| --- | ||
|
|
||
| ## About reserved usernames | ||
|
|
||
| {% data variables.product.product_name %} reserves certain usernames for internal use. You cannot assign reserved usernames to users or organizations on your instance. For example, the following words are reserved: | ||
|
|
||
| - `admin` | ||
| - `enterprise` | ||
| - `login` | ||
| - `staff` | ||
| - `support` | ||
|
|
||
| ## Viewing reserved username | ||
|
|
||
| You can view a full list of reserved usernames for {% data variables.location.product_location %}. | ||
|
|
||
| 1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %}. | ||
| 1. In the left sidebar, click **Reserved logins**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.