|
| 1 | +--- |
| 2 | +title: Connecting to a private network |
| 3 | +intro: 'You can connect {% data variables.product.prodname_dotcom %}-hosted runners to resources on a private network, including package registries, secret managers, and other on-premises services.' |
| 4 | +versions: |
| 5 | + fpt: '*' |
| 6 | + ghes: '*' |
| 7 | + ghec: '*' |
| 8 | +type: how_to |
| 9 | +topics: |
| 10 | + - Actions |
| 11 | + - Developer |
| 12 | +--- |
| 13 | + |
| 14 | +{% data reusables.actions.enterprise-beta %} |
| 15 | +{% data reusables.actions.enterprise-github-hosted-runners %} |
| 16 | + |
| 17 | +## About {% data variables.product.prodname_dotcom %}-hosted runners networking |
| 18 | + |
| 19 | +By default, {% data variables.product.prodname_dotcom %}-hosted runners have access to the public internet. However, you may also want these runners to access resources on your private network, such as a package registry, a secret manager, or other on-premise services. |
| 20 | + |
| 21 | +{% data variables.product.prodname_dotcom %}-hosted runners are shared across all {% data variables.product.prodname_dotcom %} customers, so you will need a way of connecting your private network to just your runners while they are running your workflows. There are a few different approaches you could take to configure this access, each with different advantages and disadvantages. |
| 22 | + |
| 23 | +{% ifversion fpt or ghec or ghes > 3.4 %} |
| 24 | +### Using an API Gateway with OIDC |
| 25 | + |
| 26 | +With {% data variables.product.prodname_actions %}, you can use OpenID Connect (OIDC) tokens to authenticate your workflow outside of {% data variables.product.prodname_actions %}. For example, you could run an API Gateway on the edge of your private network that authenticates incoming requests with the OIDC token and then makes API requests on behalf of your workflow in your private network. |
| 27 | + |
| 28 | +The following diagram gives an overview of this solution's architecture: |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | +It's important that you authenticate not just that the OIDC token came from {% data variables.product.prodname_actions %}, but that it came specifically from your expected workflows, so that other {% data variables.product.prodname_actions %} users aren't able to access services in your private network. You can use OIDC claims to create these conditions. For more information, see "[Defining trust conditions on cloud roles using OIDC claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#defining-trust-conditions-on-cloud-roles-using-oidc-claims)." |
| 33 | + |
| 34 | +The main disadvantage of this approach is you have to implement the API gateway to make requests on your behalf, as well as run it on the edge of your network. |
| 35 | + |
| 36 | +But there are various advantages too: |
| 37 | +- You don't need to configure any firewalls, or modify the routing of your private network. |
| 38 | +- The API gateway is stateless, and so it scales horizontally to handle high availability and high throughput. |
| 39 | + |
| 40 | +For more information, see [a reference implementation of an API Gateway](https://github.com/github/actions-oidc-gateway-example) (note that this requires customization for your use case and is not ready-to-run as-is), and "[About security hardening with OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)". |
| 41 | +{% endif %} |
| 42 | + |
| 43 | +### Using WireGuard to create a network overlay |
| 44 | + |
| 45 | +If you don't want to maintain separate infrastructure for an API Gateway, you can create an overlay network between your runner and a service in your private network, by running WireGuard in both places. |
| 46 | + |
| 47 | +There are various disadvantages to this approach: |
| 48 | + |
| 49 | +- To reach WireGuard running on your private service, you will need a well-known IP address and port that your workflow can reference: this can either be a public IP address and port, a port mapping on a network gateway, or a service that dynamically updates DNS. |
| 50 | +- WireGuard doesn't handle NAT traversal out of the box, so you'll need to identify a way to provide this service. |
| 51 | +- This connection is one-to-one, so if you need high availability or high throughput you'll need to build that on top of WireGuard. |
| 52 | +- You'll need to generate and securely store keys for both the runner and your private service. WireGuard uses UDP, so your network must support UDP traffic. |
| 53 | + |
| 54 | +There are some advantages too, as you can run WireGuard on an existing server so you don't have to maintain separate infrastructure, and it's well supported on {% data variables.product.prodname_dotcom %}-hosted runners. |
| 55 | + |
| 56 | +### Example: Configuring WireGuard |
| 57 | + |
| 58 | +This example workflow configures WireGuard to connect to a private service. |
| 59 | + |
| 60 | +For this example, the WireGuard instance running in the private network has this configuration: |
| 61 | +- Overlay network IP address of `192.168.1.1` |
| 62 | +- Public IP address and port of `1.2.3.4:56789` |
| 63 | +- Public key `examplepubkey1234...` |
| 64 | + |
| 65 | +The WireGuard instance in the {% data variables.product.prodname_actions %} runner has this configuration: |
| 66 | +- Overlay network IP address of `192.168.1.2` |
| 67 | +- Private key stores as an {% data variables.product.prodname_actions %} secret under `WIREGUARD_PRIVATE_KEY` |
| 68 | + |
| 69 | +```yaml |
| 70 | +name: WireGuard example |
| 71 | + |
| 72 | +on: |
| 73 | + workflow_dispatch: |
| 74 | + |
| 75 | +jobs: |
| 76 | + wireguard_example: |
| 77 | + runs-on: ubuntu-latest |
| 78 | + steps: |
| 79 | + - run: sudo apt install wireguard |
| 80 | + |
| 81 | + - run: echo "${{ secrets.WIREGUARD_PRIVATE_KEY }}" > privatekey |
| 82 | + |
| 83 | + - run: sudo ip link add dev wg0 type wireguard |
| 84 | + |
| 85 | + - run: sudo ip address add dev wg0 192.168.1.2 peer 192.168.1.1 |
| 86 | + |
| 87 | + - run: sudo wg set wg0 listen-port 48123 private-key privatekey peer examplepubkey1234... allowed-ips 0.0.0.0/0 endpoint 1.2.3.4:56789 |
| 88 | + |
| 89 | + - run: sudo ip link set up dev wg0 |
| 90 | + |
| 91 | + - run: curl -vvv http://192.168.1.1 |
| 92 | +``` |
| 93 | +
|
| 94 | +For more information, see [WireGuard's Quick Start](https://www.wireguard.com/quickstart/), as well as "[Encrypted Secrets](/actions/security-guides/encrypted-secrets)" for how to securely store keys. |
| 95 | +
|
| 96 | +### Using Tailscale to create a network overlay |
| 97 | +
|
| 98 | +Tailscale is a commercial product built on top of WireGuard. This option is very similar to WireGuard, except Tailscale is more of a complete product experience instead of an open source component. |
| 99 | +
|
| 100 | +It's disadvantages are similar to WireGuard: The connection is one-to-one, so you might need to do additional work for high availability or high throughput. You still need to generate and securely store keys. The protocol is still UDP, so your network must support UDP traffic. |
| 101 | +
|
| 102 | +However, there are some advantages over WireGuard: NAT traversal is built-in, so you don't need to expose a port to the public internet. It is by far the quickest of these options to get up and running, since Tailscale provides an {% data variables.product.prodname_actions %} workflow with a single step to connect to the overlay network. |
| 103 | +
|
| 104 | +For more information, see the [Tailscale GitHub Action](https://github.com/tailscale/github-action), as well as "[Encrypted Secrets](/actions/security-guides/encrypted-secrets)" for how to securely store keys. |
0 commit comments