Skip to main content

Configuring a repository cache

You can configure a repository cache for GitHub Enterprise Server by creating a new instance, connecting the repository cache to your primary instance, and configuring replication of repository networks to the repository cache.

Note: Repository caching is currently in beta and subject to change.

About configuration for repository caching

Você pode configurar o cache do repositório criando um tipo especial de réplica chamado cache de repositório. Then, you can set data location policies that govern which repository networks are replicated to the repository cache.

Repository caching is not supported with clustering.

DNS for repository caches

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.

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 in the Git documentation.

For example, the global .gitconfig for the CI machine would include these lines.

[url "https://europe-ci.github.example.com/"]
	insteadOf = https://github.example.com/

Then, when told to fetch https://github.example.com/myorg/myrepo, Git will instead fetch from https://europe-ci.github.example.com/myorg/myrepo.

Configuring a repository cache

  1. Set up a new GitHub Enterprise Server instance on your desired platform. This instance will be your repository cache. For more information, see "Setting up a GitHub Enterprise Server instance."

  2. Defina uma senha de administrador correspondente à senha no appliance primário e continue.

  3. Clique em Configurar como Réplica. Opções de instalação com o link para configurar a nova instância como réplica

  4. Em "Add new SSH key" (Adicionar nova chave SSH), digite a chave SSH. Adicionar chave SSH

  5. Clique em Adicionar chave.

  6. Connect to the repository cache's IP address using SSH.

    $ ssh -p 122 admin@REPLICA-IP
  7. Para gerar um par de chaves para replicação, use o comando ghe-repl-setup com o endereço IP do dispositivo primário e copie a chave pública retornada.

    $ ghe-repl-setup PRIMARY IP
  8. Para adicionar a chave pública à lista de chaves autorizadas no dispositivo primário, procure https://PRIMARY-HOSTNAME/setup/settings e adicione a chave copiada da réplica à lista.

  9. To verify the connection to the primary and enable replica mode for the repository cache, run ghe-repl-setup again.

    $ ghe-repl-setup PRIMARY-IP
  10. Set a cache-location for the repository cache, replacing CACHE-LOCATION with an alphanumeric identifier, such as the region where the cache is deployed. Also set a datacenter name for this cache; new caches will attempt to seed from another cache in the same datacenter.

    $ ghe-repl-node --cache CACHE-LOCATION --datacenter REPLICA-DC-NAME
  11. Para iniciar a replicação dos armazenamentos de dados, use o comando ghe-repl-start.

    $ ghe-repl-start

    Aviso: ghe-repl-start causa uma breve interrupção no servidor primário, durante o qual os usuários podem receber erros internos do servidor. Para fornecer uma mensagem mais amigável, execute ghe-maintenance -s no nó primário antes de executar ghe-repl-start no nó de réplica a fim de colocar o dispositivo no modo de manutenção. Quando a replicação for iniciada, desabilite o modo de manutenção com ghe-maintenance -u. A replicação do Git não progredirá enquanto o nó primário estiver no modo de manutenção.

  12. Para verificar o status do canal de replicação de cada armazenamento de dados, use o comando ghe-repl-status.

    $ ghe-repl-status
  13. 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

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.

Data location policies affect only Git content. Content in the database, such as issues and pull request comments, will be replicated to all nodes regardless of policy.

Note: Data location policies are not the same as access control. You must use repository roles to control which users may access a repository. For more information about repository roles, see "Repository roles for an organization."

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".

$ ghe-spokesctl cache-policy set --default 1 kansas

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.

$ ghe-spokesctl cache-policy set <owner/repository> 1 kansas

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.

$ ghe-spokesctl cache-policy set <owner/repository> 0 kansas

Replica counts greater than one in a given cache location are not supported.