English
No results found.

Explore by product

Enterprise administrators
  • Get started
  • Account and profile
  • Authentication
  • Repositories
  • GitHub
  • Enterprise administrators
  • Billing and payments
  • Organizations
  • Code security
  • GitHub Issues
  • GitHub Actions
  • GitHub Codespaces
  • GitHub Packages
  • Search on GitHub
  • Developers
  • REST API
  • GraphQL API
  • GitHub CLI
  • GitHub Discussions
  • GitHub Sponsors
  • Building communities
  • GitHub Pages
  • Education
  • GitHub Desktop
  • Atom
  • Electron
  • CodeQL
  • npm
    • English
  • English
  • 简体中文 (Simplified Chinese)
  • 日本語 (Japanese)
  • Español (Spanish)
  • Português do Brasil (Portuguese)

    • This version of GitHub Enterprise was discontinued on 2021-09-23. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

    Article version

    In this article

    About cluster nodes

    Nodes are GitHub Enterprise Server instances that operate in a cluster. Each node runs a set of services that are provided to the cluster, and ultimately to the users.

    Note: GitHub Enterprise Server clustering must be configured with HTTPS.

    Minimum hardware recommendations

    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.

    ServicesMinimum Memory RequiredMinimum Data Volume Free Space Required
    job-server,
    memcache-server,
    web-server    		14 GB1 GB
    consul-server,
    mysql-server,
    redis-server    		14 GB10 GB
    git-server,
    metrics-server,
    pages-server,
    storage-server    		7 GB10 GB
    elasticsearch-server14 GB10 GB

    Services required for clustering

    For adequate redundancy, use these minimum nodes operating each service.

    Note: Your organization's needs for scalability will depend on many factors including the size and number of repositories, number of users, and overall utilization.

    ServicesMinimum Nodes Required
    job-server,
    memcache-server,
    metrics-server,
    web-server    		2
    mysql-server,
    redis-server    		2
    consul-server3
    git-server,
    pages-server,
    storage-server    		3
    elasticsearch-server3

    Cluster design recommendations

    Clustering allows services that make up GitHub Enterprise Server to be scaled out independently of each other. This flexibility can be used to design and implement a cluster that fits organizations with different scalability requirements. For example, some organizations may need more storage throughput for large or frequent fetches, but web server usage may be relatively low. Another organization may have good performance with fewer storage resources, but need many nodes running pages-server or elasticsearch-server. Many different combinations are possible. Work with your account representative to determine the best cluster configuration for your specific needs.

    • 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. GitHub Enterprise 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
        • jobs-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

    Example cluster diagram

    Note: This is only an example. Your organization's optimal cluster design will depend on your unique needs. Talk to your dedicated representative or GitHub's Sales team so we can help you determine the best cluster configuration.

    Example Cluster