docs-bot
@@ -404,10 +404,10 @@ stop/waiting
|
||||
|
||||
### ghe-set-password
|
||||
|
||||
With `ghe-set-password`, you can set a new password to authenticate into the [{% data variables.enterprise.management_console %}](/admin/configuration/administering-your-instance-from-the-management-console).
|
||||
This utility allows you to set a new {% ifversion enterprise-management-console-multi-user-auth %}root site administrator {% endif %}password for authentication to the {% data variables.enterprise.management_console %}. For more information, see "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-web-ui/managing-access-to-the-management-console)."
|
||||
|
||||
```shell
|
||||
ghe-set-password <new_password>
|
||||
ghe-set-password
|
||||
```
|
||||
|
||||
### ghe-setup-network
|
||||
|
||||
@@ -25,7 +25,7 @@ Each node in a {% data variables.product.product_name %} cluster is a virtual ma
|
||||
|
||||
Each node must have a root volume, as well as a separate data volume. These are minimum recommendations. More resources may be required depending on your usage, such as user activity and selected integrations.
|
||||
|
||||
| Services | Minimum memory required | Minimum data volume free space Required |
|
||||
| Services | Minimum memory required | Minimum data volume free space required |
|
||||
| :- | :- | :- |
|
||||
| `job-server`,<br/>`memcache-server`,<br/>`web-server` | 14 GB | 1 GB |
|
||||
| `consul-server`,<br/>`mysql-server`,<br/>`redis-server` | 14 GB | 10 GB |
|
||||
@@ -44,13 +44,16 @@ For adequate redundancy, use these minimum nodes operating each service.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
| Services | Minimum nodes required |
|
||||
| :- | :- |
|
||||
| `job-server`,<br/>`memcache-server`,<br/>`metrics-server`,<br/>`web-server` | 2 |
|
||||
| `mysql-server`,<br/>`redis-server` | 2 |
|
||||
| `consul-server` | 3 |
|
||||
| `git-server`,<br/>`pages-server`,<br/>`storage-server` | 3 |
|
||||
| `elasticsearch-server` | 3 |
|
||||
## Example cluster configuration
|
||||
|
||||
The following example demonstrates a minimal cluster configuration, which includes 11 nodes that run the necessary services.
|
||||
|
||||
| Tiers | Services | Minimum nodes required |
|
||||
| :- | :- | :- |
|
||||
| Front end | `job-server`,<br/>`memcache-server`,<br/>`web-server` | 2 |
|
||||
| Database | `consul-server`,<br/>`mysql-server`,<br/>`redis-server` | 3 |
|
||||
| Storage | `git-server`,<br/>`metrics-server`,<br/>`pages-server`,<br/>`storage-server` | 3 |
|
||||
| Search | `elasticsearch-server` | 3 |
|
||||
|
||||
## Cluster design recommendations
|
||||
|
||||
@@ -58,19 +61,3 @@ Clustering allows services that make up {% data variables.product.prodname_ghe_s
|
||||
|
||||
- Spread redundant nodes across independent hardware. If you share CPU, memory, or storage devices, you'll reduce performance and introduce single points of failure. Shared networking components can also reduce throughput and increase risk of loss of connectivity in the event of an outage.
|
||||
- Use fast storage. Storage area networks (SAN) are often optimized for maximum space utilization, availability and fault tolerance, not absolute throughput. {% data variables.product.prodname_ghe_server %} clustering provides redundancy and availability, and will perform best on the fastest storage available. Local SSD storage is recommended.
|
||||
- Establish tiers of nodes that make sense for your organization. An example configuration:
|
||||
- Front-end tier with two nodes and the following services:
|
||||
- `web-server`
|
||||
- `job-server`
|
||||
- `memcache-server`
|
||||
- Database tier with three nodes and the following services:
|
||||
- `consul-server`
|
||||
- `mysql-server`
|
||||
- `redis-server`
|
||||
- Search tier with three nodes and the following service:
|
||||
- `elasticsearch-server`
|
||||
- Storage tier with three nodes and the following services:
|
||||
- `git-server`
|
||||
- `pages-server`
|
||||
- `storage-server`
|
||||
- `metrics-server`
|
||||
|
||||
@@ -59,3 +59,9 @@ The items in the table below can be migrated with a repository. Any items not sh
|
||||
| Webhooks | Only active webhooks are migrated.
|
||||
| Repository deploy keys | Repository deploy keys are migrated.
|
||||
| Protected branches | Protected branch settings and associated data are migrated.
|
||||
|
||||
## About migration of external authentication data
|
||||
|
||||
If the source location for your migration is a {% data variables.product.company_short %} product that uses LDAP or SAML authentication, `ghe-migrator` does not migrate external authentication data linked to user accounts. For more information about authentication options, see {% data variables.product.prodname_ghe_server %}, see "About authentication for your enterprise" in the [{% data variables.product.prodname_ghe_server %} docs](/enterprise-server@latest/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)" or the [{% data variables.product.prodname_ghe_cloud %} docs](/enterprise-cloud@latest/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).
|
||||
|
||||
If you migrate to a destination instance and then configure external authentication, users must sign in to the destination instance with a user account that has the same username or user ID as the account on the source instance. Administrators can review the external attribute that an instance uses to map user account names from the {% data variables.enterprise.management_console %}. For more information, see "[AUTOTITLE]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/administering-your-instance/administering-your-instance-from-the-web-ui/accessing-the-management-console)."
|
||||
|
||||
@@ -20,7 +20,7 @@ Specify the port number when making API calls to endpoints for the Manage {% dat
|
||||
|
||||
### Authentication
|
||||
|
||||
To authenticate requests to endpoints for the Manage {% data variables.product.prodname_ghe_server %} API, specify the password for the instance's root site administrator account as an authentication token. Use standard HTTP authentication to send the password. The `api_key` user identifies the root site administrator. The following example demonstrates authentication for this API. Replace ROOT-SITE-ADMINISTRATOR-PASSWORD with the password, and ADMINISTRATION-PORT with either 8442 or 8080.
|
||||
To authenticate requests to endpoints for the Manage {% data variables.product.prodname_ghe_server %} API, specify the password for the instance's root site administrator account as an authentication token. Use standard HTTP authentication to send the password. The `api_key` user identifies the root site administrator. The following example demonstrates authentication for this API. Replace ROOT-SITE-ADMINISTRATOR-PASSWORD with the password, and ADMINISTRATION-PORT with either 8443 or 8080.
|
||||
|
||||
```shell
|
||||
curl -L -u "api_key:ROOT-SITE-ADMINISTRATOR-PASSWORD" 'http(s)://HOSTNAME:ADMINISTRATION-PORT/manage'
|
||||
|
||||
Reference in New Issue
Block a user