You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md
+27-24Lines changed: 27 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -131,46 +131,49 @@ Key | Description
131
131
{% ifversion ghes %}
132
132
## Indexing
133
133
134
-
GitHub's [code search][] features are powered by [ElasticSearch][]. This section of the site admin dashboard shows you the current status of your ElasticSearch cluster and provides you with several tools to control the behavior of searching and indexing. These tools are split into the following three categories.
134
+
GitHub's search features are powered by Elasticsearch. This section of the site admin dashboard shows you the current status of your Elasticsearch cluster and provides you with several tools to control search and index behavior.
For more information about code search, see "[Searching for information on {% data variables.product.prodname_dotcom %}](/search-github)." For more information about Elasticsearch, see the [Elasticsearch website](https://elastic.co).
138
137
139
-
### Code search
138
+
{% note %}
140
139
141
-
This allows you to enable or disable both search and index operations on source code.
140
+
**Note**: In normal use, site administrators 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.
142
141
143
-
### Code search index repair
142
+
{% endnote %}
144
143
145
-
This controls how the code search index is repaired. You can
144
+
### Index management
146
145
147
-
- enable or disable index repair jobs
148
-
- start a new index repair job
149
-
- reset all index repair state
146
+
{% data variables.product.product_name %} reconciles the state of the search index with data on the instance automatically and regularly.
150
147
151
-
{% data variables.product.prodname_enterprise %} uses repair jobs to reconcile the state of the search index with data stored in a database (issues, pull requests, repositories, and users) and data stored in Git repositories (source code). This happens when
148
+
- Issues, pull requests, repositories, and users in the database
149
+
- Git repositories (source code) on disk
152
150
153
-
- a new search index is created;
154
-
- missing data needs to be backfilled; or
155
-
- old search data needs to be updated.
151
+
Your instance uses repair jobs to reconcile the data, and schedules a repair job in the background when the following events occur.
156
152
157
-
In other words, repair jobs are started as needed and run in the background—they are not scheduled by site admins in any way.
153
+
- A new search index is created.
154
+
- Missing data needs to be backfilled.
155
+
- Old search data needs to be updated.
158
156
159
-
Furthermore, 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.
157
+
You can create a new index, or you can click on an existing index in the list to manage the index. You can perform the following operations on an index.
160
158
161
-
A progress bar shows the current status of a repair job across all of its background workers. It is the percentage difference of the repair offset with the highest record ID in the database. Don't worry about the value shown in the progress bar after a repair job has completed: because it shows the difference between the repair offset and the highest record ID in the database, it will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed.
159
+
- Make the index searchable.
160
+
- Make the index writable.
161
+
- Update the index.
162
+
- Delete the index
163
+
- Reset the index repair state.
164
+
- Start a new index repair job.
165
+
- Enable or disable index repair jobs.
162
166
163
-
You can start a new code-search index repair job at any time. It will use a single CPU as it reconciles the search index with database and Git repository data. To minimize the effects this will have on I/O performance and reduce the chances of operations timing out, try to run a repair job during off-peak hours first. Monitor your system's load averages and CPU usage with a utility like `top`; if you don't notice any significant changes, it should be safe to run an index repair job during peak hours, as well.
167
+
A progress bar shows the current status of a repair job across background workers. The bar is the percentage difference of the repair offset with the highest record ID in the database. 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.product.product_location %} even though those repositories are actually indexed.
164
168
165
-
### Issues index repair
169
+
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.
166
170
167
-
This controls how the [Issues][] index is repaired. You can
171
+
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.
0 commit comments