> ## Documentation Index
> Fetch the complete documentation index at: https://namespace.so/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Access and networking
> Expose ingresses and read SSH, VNC, Kubernetes, and network configuration for Namespace compute instances with the TypeScript SDK.
Once an instance is running, `client.compute` also hands out the configuration needed to reach it: public ingresses, SSH and VNC endpoints, a kubeconfig, and the workspace network configuration.
The examples on this page use a Compute client:
```typescript theme={null}
import { createComputeClient } from "@namespacelabs/sdk/api/compute";
const client = createComputeClient();
```
## `compute.createIngress()`
Expose a backend inside the instance to the public internet, usually to serve HTTPS-terminated traffic from a container running in the instance. See [Ingress](/docs/architecture/networking/ingress) for how Namespace routes and secures this traffic.
Example
```typescript {1-9} theme={null}
const { allocatedIngresses } = await client.compute.createIngress({
instanceId,
ingresses: [
{
name: "api",
exportedPortBackend: { port: 8080 },
},
],
});
console.log(allocatedIngresses[0]?.fqdn);
```
API reference
```typescript theme={null}
createIngress(
request: MessageInitShape,
options?: CallOptions,
): Promise
```
Arguments and options
The instance that serves the backend.
The ingresses to create.
The ingress name, matching `[a-z0-9]([a-z0-9-_]*[a-z0-9])?`.
The backend to route to, as a `port` and an optional `ipAddress` inside the instance.
HTTP match rules for the ingress. Each rule carries a `match` and can set `doesNotRequireAuth`.
Routes all first-level subdomains of the instance wildcard domain to this ingress. Requires the instance to have a wildcard domain.
Cancellation, timeout, and header options. See [Shared call options](/docs/reference/typescript-sdk/compute/manage#shared-call-options).
Return value
Returns a `CreateIngressResponse` with `allocatedIngresses`. Each `AllocatedIngress` carries the `name` you requested, the allocated `fqdn`, and a `description`.
If the instance does not exist, the call fails with `NotFound`.
***
## `compute.listIngresses()`
List the backends exposed from an instance to the public internet. The response includes ingresses created with `createIngress()` and those exposed declaratively through the Kubernetes ingress manager feature.
Example
```typescript {1} theme={null}
const { allocatedIngresses } = await client.compute.listIngresses({ instanceId });
for (const ingress of allocatedIngresses) {
console.log(ingress.name, ingress.fqdn);
}
```
API reference
```typescript theme={null}
listIngresses(
request: MessageInitShape,
options?: CallOptions,
): Promise
```
Arguments and options
The instance to list ingresses for.
Cancellation, timeout, and header options. See [Shared call options](/docs/reference/typescript-sdk/compute/manage#shared-call-options).
Return value
Returns a `ListIngressesResponse` with `allocatedIngresses`.
If the instance does not exist, the call fails with `NotFound`. If it is already terminated, the call fails with `FailedPrecondition`.
***
## `compute.getSSHConfig()`
Return the configuration needed to open an SSH session to the instance. See [SSH and remote display](/docs/architecture/compute/ssh-remote-display) for what the session supports.
Example
```typescript {1} theme={null}
const config = await client.compute.getSSHConfig({ instanceId });
console.log(`ssh ${config.username}@${config.endpoint}`);
```
API reference
```typescript theme={null}
getSSHConfig(
request: MessageInitShape,
options?: CallOptions,
): Promise
```
Arguments and options
The instance to provide an SSH configuration for.
A container name to connect to. The connection endpoint then targets that container.
Cancellation, timeout, and header options. See [Shared call options](/docs/reference/typescript-sdk/compute/manage#shared-call-options).
Return value
Returns a `GetSSHConfigResponse`.
The SSH endpoint to connect to. Use it together with `username`.
The username for the session, as in `ssh @`.
When set, a private key that establishes the session. Any key returned here has limited access rights, restricted to a single instance.
If the instance does not exist, the call fails with `NotFound`.
***
## `compute.getVNCConfig()`
Return the configuration needed to reach the instance's remote display over VNC.
Example
```typescript {1} theme={null}
const config = await client.compute.getVNCConfig({ instanceId });
console.log(config.endpoint, config.username);
```
API reference
```typescript theme={null}
getVNCConfig(
request: MessageInitShape,
options?: CallOptions,
): Promise
```
Arguments and options
The instance to provide a VNC configuration for.
Cancellation, timeout, and header options. See [Shared call options](/docs/reference/typescript-sdk/compute/manage#shared-call-options).
Return value
Returns a `GetVNCConfigResponse` with the `endpoint` exposed by the instance ingress, and the `username` and `password` to use when the VNC server requires authentication.
If the instance does not exist, the call fails with `NotFound`. If it exposes no VNC service, the call fails with `FailedPrecondition`.
The token used to connect to the returned endpoint must also grant access to the instance ingress.
***
## `compute.getKubernetesConfig()`
Return a kubeconfig for the Kubernetes cluster running inside the instance.
Example
```typescript {3} theme={null}
import { writeFile } from "node:fs/promises";
const { kubeconfig } = await client.compute.getKubernetesConfig({ instanceId });
await writeFile("kubeconfig.yaml", kubeconfig);
```
API reference
```typescript theme={null}
getKubernetesConfig(
request: MessageInitShape,
options?: CallOptions,
): Promise
```
Arguments and options
The instance to read the Kubernetes configuration from.
Cancellation, timeout, and header options. See [Shared call options](/docs/reference/typescript-sdk/compute/manage#shared-call-options).
Return value
Returns a `GetKubernetesConfigResponse` with `kubeconfig`, the configuration `kubectl` uses to reach Kubernetes inside the instance.
If the instance does not exist, the call fails with `NotFound`. If it is not running Kubernetes, the call fails with `FailedPrecondition`.
***
## `compute.getNetworkConfiguration()`
Return the network configuration of the workspace. Unlike the other methods on this page, it describes the workspace rather than one instance. See [Networking](/docs/architecture/networking) for the wider picture.
Example
```typescript {1} theme={null}
const { egress } = await client.compute.getNetworkConfiguration({});
for (const cidr of egress?.egressCidrs ?? []) {
console.log(cidr.kind, cidr.cidr, cidr.segment);
}
```
API reference
```typescript theme={null}
getNetworkConfiguration(
request: MessageInitShape,
options?: CallOptions,
): Promise
```
Arguments and options
The request has no fields. Pass an empty object.
Cancellation, timeout, and header options. See [Shared call options](/docs/reference/typescript-sdk/compute/manage#shared-call-options).
Return value
Returns a `GetNetworkConfigurationResponse` whose `egress` carries `egressCidrs`. Each entry has a `kind`, the `cidr` itself, and the `segment` it belongs to. Use these ranges when you need to allow Namespace traffic through a firewall.
## Related documentation
Create instances and start containers to expose.
How Namespace routes and secures public traffic.
Interactive access to an instance.