diff --git a/docs/cloud/private_connectivity_sourcegraph_connect.mdx b/docs/cloud/private_connectivity_sourcegraph_connect.mdx index ec09ca9bb..1c7f34de5 100644 --- a/docs/cloud/private_connectivity_sourcegraph_connect.mdx +++ b/docs/cloud/private_connectivity_sourcegraph_connect.mdx @@ -1,22 +1,32 @@ -# Private Resources on on-prem data center via Sourcegraph Connect agent +# Private Resources in On-Prem Data Centers via Sourcegraph Connect Agent -This feature is in the Experimental stage. Please contact Sourcegraph directly via [preferred contact method](https://about.sourcegraph.com/contact) for more information. +This feature is in the Experimental stage. [Contact us](https://about.sourcegraph.com/contact) for more information. -As part of the [Enterprise tier](https://sourcegraph.com/pricing), Sourcegraph Cloud supports connecting private resources on any on-prem private network by running Sourcegraph Connect tunnel agent in customer infrastructure. +As part of the [Enterprise tier](https://sourcegraph.com/pricing), Sourcegraph Cloud supports connecting to private code hosts and artifact registries in the customer's network by deploying the Sourcegraph Connect tunnel agent in the customer's network. ## How it works -Sourcegraph will set up a tunnel server in a customer dedicated GCP project. Customer will start the tunnel agent provided by Sourcegraph with the provided credential. After start, the agent will authenticate and establish a secure connection with Sourcegraph tunnel server. +Sourcegraph Connect consists of three components: -Sourcegraph Connect consists of three major components: +### Tunnel Clients -Tunnel agent: deployed inside the customer network, which uses its own identity and encrypts traffic between the customer code host and client. Agent can only communicate with permitted customer code hosts inside the customer network. Only agents are allowed to establish secure connections with tunnel server, the server can only accept connections if agent identity is approved. +Forward proxy clients for the Sourcegraph Cloud instance's containers to reach the customer's private code hosts and artifact registries, through the tunnel server. -Tunnel server: a centralized broker between client and agent managed by Sourcegraph. Its purpose is to set up mTLS, proxy encrypted traffic between clients and agents and enforce ACL. +Managed by Sourcegraph, and deployed in the customer's Sourcegraph Cloud instance's VPC. -Tunnel client: forward proxy clients managed by sourcegraph. Every client has its own identity and it cannot establish a direct connection with the customer agent, and has to go through tunnel server. +### Tunnel Server -[link](https://link.excalidraw.com/readonly/453uvY8infI8wskSecGJ) +The broker between agents and clients, it authenticates agents and clients, enforces ACLs, sets up mTLS, and proxies encrypted traffic between agents and clients. + +Managed by Sourcegraph, and deployed in the customer's Sourcegraph Cloud instance's VPC. + +### Tunnel Agents + +Deployed by the customer inside their network, agents proxy and encrypt traffic between the customer's private resources and the Sourcegraph Cloud tunnel clients. + +The agent has its own identity, and using credentials provided to the customer during deployment, the agent authenticates and establishes a secure connection with the tunnel server. Only agents are allowed to establish secure connections with the tunnel server, and the server only accepts a connection if the agent's identity is approved. + +Agents can only communicate with permitted code hosts and artifact registries.