Skip to content

Commit 1e81f8e

Browse files
[UX] Rename networking to proxy_jump in the kubernetes backend #3136
1 parent 2d90bbc commit 1e81f8e

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

docs/docs/concepts/backends.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1049,27 +1049,27 @@ In case of a self-managed cluster, also specify the IP address of any node in th
10491049
- type: kubernetes
10501050
kubeconfig:
10511051
filename: ~/.kube/config
1052-
networking:
1053-
ssh_host: localhost # The external IP address of any node
1054-
ssh_port: 32000 # Any port accessible outside of the cluster
1052+
proxy_jump:
1053+
hostname: localhost # The external IP address of any node
1054+
port: 32000 # Any port accessible outside of the cluster
10551055
```
10561056

10571057
</div>
10581058

1059-
The port specified to `ssh_port` must be accessible outside of the cluster.
1059+
The port specified to `port` must be accessible outside of the cluster.
10601060

10611061
??? info "Kind"
10621062
If you are using [Kind](https://kind.sigs.k8s.io/), make sure to make
1063-
to set up `ssh_port` via `extraPortMappings` for proxying SSH traffic:
1063+
to set up `port` via `extraPortMappings` for proxying SSH traffic:
10641064

10651065
```yaml
10661066
kind: Cluster
10671067
apiVersion: kind.x-k8s.io/v1alpha4
10681068
nodes:
10691069
- role: control-plane
10701070
extraPortMappings:
1071-
- containerPort: 32000 # Must be same as `ssh_port`
1072-
hostPort: 32000 # Must be same as `ssh_port`
1071+
- containerPort: 32000 # Must be same as `port`
1072+
hostPort: 32000 # Must be same as `port`
10731073
```
10741074
10751075
Go ahead and create the cluster like this:
@@ -1092,13 +1092,13 @@ In case of a self-managed cluster, also specify the IP address of any node in th
10921092
- type: kubernetes
10931093
kubeconfig:
10941094
filename: ~/.kube/config
1095-
networking:
1096-
ssh_port: 32000 # Any port accessible outside of the cluster
1095+
proxy_jump:
1096+
port: 32000 # Any port accessible outside of the cluster
10971097
```
10981098

10991099
</div>
11001100

1101-
The port specified to `ssh_port` must be accessible outside of the cluster.
1101+
The port specified to `port` must be accessible outside of the cluster.
11021102

11031103
??? info "EKS"
11041104
For example, if you are using EKS, make sure to add it via an ingress rule

docs/docs/reference/server/config.yml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ to configure [backends](../../concepts/backends.md) and other [server-level sett
293293
cat my-service-account-file.json | jq -c | jq -R
294294
```
295295

296-
###### `projects[n].backends[type=kubernetes].networking` { #kubernetes-networking data-toc-label="networking" }
296+
###### `projects[n].backends[type=kubernetes].proxy_jump` { #kubernetes-proxy_jump data-toc-label="proxy_jump" }
297297

298298
#SCHEMA# dstack._internal.core.backends.kubernetes.models.KubernetesProxyJumpConfig
299299
overrides:

0 commit comments

Comments
 (0)