Skip to content

Commit 6f22140

Browse files
promptless[bot]promptless[bot]
authored
Completely rewrite all runpodctl reference documentation
1 parent 37fd8a6 commit 6f22140

22 files changed

+601
-377
lines changed

‎runpodctl/reference/runpodctl-config.mdx‎

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,34 @@
11
---
2-
title: "Config"
2+
title: "config"
3+
sidebarTitle: "config"
34
---
45

5-
## runpodctl config
6+
Configure the Runpod CLI with your API credentials and API URL to enable programmatic access to your Runpod resources.
67

7-
CLI Config
8+
```sh
9+
runpodctl config [flags]
10+
```
811

9-
### Synopsis
12+
## Example
1013

11-
Runpod CLI Config Settings
14+
Configure the CLI with your API key:
1215

1316
```sh
14-
runpodctl config [flags]
17+
runpodctl config --apiKey rpaPOIUYYULKDSALVIUT3Q2ZRKZ98IUYTSK2OQQ2CWQxkd01
1518
```
1619

17-
### Options
20+
## Flags
1821

19-
```text
20-
--apiKey string Runpod API key
21-
--apiUrl string Runpod API URL (default "https://api.runpod.io/graphql")
22-
-h, --help help for config
23-
```
22+
The following flags are available for the `config` command:
23+
24+
---
25+
26+
`--apiKey <value>` • `string`
27+
28+
Your Runpod API key, which authenticates the CLI to access your account. You can generate an API key from the [Runpod console](https://www.runpod.io/console/user/settings).
29+
30+
---
2431

25-
### SEE ALSO
32+
`--apiUrl <value>` • `string` • default = `https://api.runpod.io/graphql`
2633

27-
* [runpodctl](/runpodctl/reference/runpodctl) - CLI for runpod.io
34+
The Runpod API endpoint URL. The default value should work for most users.

‎runpodctl/reference/runpodctl-create-pod.mdx‎

Lines changed: 117 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,129 @@
11
---
2-
title: "Create Pod"
3-
sidebarTitle: "Create Pod"
2+
title: "create pod"
3+
sidebarTitle: "create pod"
44
---
55

6-
## runpodctl create pod
6+
Create and start a new Pod on Runpod with configuration options for GPU type, storage, networking, and cloud tier.
77

8-
start a pod
8+
```sh
9+
runpodctl create pod [flags]
10+
```
911

10-
### Synopsis
12+
## Example
1113

12-
start a pod from runpod.io
14+
Create a Pod with 2 RTX 4090 GPUs in the Secure Cloud with a custom container image:
1315

1416
```sh
15-
runpodctl create pod [flags]
17+
runpodctl create pod --name "my-training-pod" --gpuType "RTX 4090" --gpuCount 2 --secureCloud --imageName "runpod/pytorch:2.0.1-py3.10-cuda11.8.0-devel" --containerDiskSize 50 --volumeSize 100
1618
```
1719

18-
### Options
19-
20-
```text
21-
--args string container arguments
22-
--communityCloud create in community cloud
23-
--containerDiskSize int container disk size in GB (default 20)
24-
--cost float32 $/hr price ceiling, if not defined, pod will be created with lowest price available
25-
--env strings container arguments
26-
--gpuCount int number of GPUs for the pod (default 1)
27-
--gpuType string gpu type id, e.g. 'NVIDIA GeForce RTX 3090'
28-
-h, --help help for pod
29-
--imageName string container image name
30-
--mem int minimum system memory needed (default 20)
31-
--name string any pod name for easy reference
32-
--ports strings ports to expose; max only 1 http and 1 tcp allowed; e.g. '8888/http'
33-
--secureCloud create in secure cloud
34-
--templateId string templateId to use with the pod
35-
--vcpu int minimum vCPUs needed (default 1)
36-
--volumePath string volume disk path (default "/workspace")
37-
--volumeSize int persistent volume disk size in GB (default 1)
38-
--networkVolumeId string network volume id
39-
```
20+
## Flags
21+
22+
The following flags are available for the `create pod` command:
23+
24+
---
25+
26+
`--name <value>` • `string`
27+
28+
A custom name for your Pod to make it easy to identify and reference.
29+
30+
---
31+
32+
`--gpuType <value>` • `string`
33+
34+
The [GPU type](/references/gpu-types) to use for the Pod (e.g., `RTX 4090`, `A100 80GB`, `H100 SXM`).
35+
36+
---
37+
38+
`--gpuCount <number>` • `integer` • default = `1`
39+
40+
The number of GPUs to allocate to the Pod.
41+
42+
---
43+
44+
`--secureCloud`
45+
46+
Create the Pod in the Secure Cloud tier, which offers enterprise-grade infrastructure with enhanced reliability.
47+
48+
---
49+
50+
`--communityCloud`
51+
52+
Create the Pod in the Community Cloud tier, which typically offers lower pricing with spot instance availability.
53+
54+
---
55+
56+
`--imageName <value>` • `string`
57+
58+
The Docker container image to use for the Pod (e.g., `runpod/pytorch:latest`).
59+
60+
---
61+
62+
`--templateId <value>` • `string`
63+
64+
The ID of a template to use for Pod configuration, which pre-defines the image and environment settings.
65+
66+
---
67+
68+
`--containerDiskSize <number>` • `integer` • default = `20`
69+
70+
The size of the container disk in gigabytes, used for temporary storage within the container.
71+
72+
---
73+
74+
`--volumeSize <number>` • `integer` • default = `1`
75+
76+
The size of the persistent volume in gigabytes, which retains data across Pod restarts.
77+
78+
---
79+
80+
`--volumePath <value>` • `string` • default = `/workspace`
81+
82+
The mount path for the persistent volume inside the container.
83+
84+
---
85+
86+
`--networkVolumeId <value>` • `string`
87+
88+
The ID of an existing [network volume](/storage/network-volumes) to attach to the Pod for shared storage across multiple Pods.
89+
90+
---
91+
92+
`--cost <number>` • `float`
93+
94+
The maximum price ceiling in dollars per hour. If not specified, the Pod will be created at the lowest available price.
95+
96+
---
97+
98+
`--mem <number>` • `integer` • default = `20`
99+
100+
The minimum system memory required in gigabytes.
101+
102+
---
103+
104+
`--vcpu <number>` • `integer` • default = `1`
105+
106+
The minimum number of vCPUs required for the Pod.
107+
108+
---
109+
110+
`--env <value>` • `string`
111+
112+
Environment variables to set in the container. Specify multiple times for multiple variables (e.g., `--env KEY1=VALUE1 -env KEY2=VALUE2`).
113+
114+
---
115+
116+
`--args <value>` • `string`
117+
118+
Additional arguments to pass to the container when it starts.
119+
120+
---
121+
122+
`--ports <value>` • `string`
123+
124+
Ports to expose from the container. Maximum of 1 HTTP port and 1 TCP port allowed (e.g., `--ports 8888/http --ports 22/tcp`).
40125

41-
### SEE ALSO
126+
## Related commands
42127

43-
* [runpodctl create](/runpodctl/reference/runpodctl-create) - create a resource
128+
- [`runpodctl create`](/runpodctl/reference/runpodctl-create)
129+
- [`runpodctl create pods`](/runpodctl/reference/runpodctl-create-pods)

‎runpodctl/reference/runpodctl-create-pods.mdx‎

Lines changed: 123 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,135 @@
11
---
2-
title: "Create Pods"
2+
title: "create pods"
3+
sidebarTitle: "create pods"
34
---
45

5-
## runpodctl create pods
6+
Create multiple Pods at once with identical configurations (useful for parallel workloads or distributed training).
67

7-
create a group of pods
8+
```sh
9+
runpodctl create pods [flags]
10+
```
811

9-
### Synopsis
12+
## Example
1013

11-
create a group of pods on runpod.io
14+
Create 3 identical Pods for distributed training in the Secure Cloud:
1215

1316
```sh
14-
runpodctl create pods [flags]
17+
runpodctl create pods --name "training-worker" --podCount 3 --gpuType "A100 80GB" --gpuCount 1 --secureCloud --imageName "runpod/pytorch:2.0.1-py3.10-cuda11.8.0-devel"
1518
```
1619

17-
### Options
18-
19-
```text
20-
--args string container arguments
21-
--communityCloud create in community cloud
22-
--containerDiskSize int container disk size in GB (default 20)
23-
--cost float32 $/hr price ceiling, if not defined, pod will be created with lowest price available
24-
--env strings container arguments
25-
--gpuCount int number of GPUs for the pod (default 1)
26-
--gpuType string gpu type id, e.g. 'NVIDIA GeForce RTX 3090'
27-
-h, --help help for pods
28-
--imageName string container image name
29-
--mem int minimum system memory needed (default 20)
30-
--name string any pod name for easy reference
31-
--podCount int number of pods to create with the same name (default 1)
32-
--ports strings ports to expose; max only 1 http and 1 tcp allowed; e.g. '8888/http'
33-
--secureCloud create in secure cloud
34-
--vcpu int minimum vCPUs needed (default 1)
35-
--volumePath string volume disk path (default "/workspace")
36-
--volumeSize int persistent volume disk size in GB (default 1)
37-
```
20+
## Flags
21+
22+
The following flags are available for the `create pods` command:
23+
24+
---
25+
26+
`--name <value>` • `string`
27+
28+
A custom name for the Pods. All Pods in the group will share this base name.
29+
30+
---
31+
32+
`--podCount <number>` • `integer` • default = `1`
33+
34+
The number of Pods to create.
35+
36+
---
37+
38+
`--gpuType <value>` • `string`
39+
40+
The GPU type to use for the Pods (e.g., `RTX 4090`, `A100 80GB`, `H100 SXM`).
41+
42+
---
43+
44+
`--gpuCount <number>` • `integer` • default = `1`
45+
46+
The number of GPUs to allocate to each Pod.
47+
48+
---
49+
50+
`--secureCloud`
51+
52+
Create the Pods in the Secure Cloud tier, which offers enterprise-grade infrastructure with enhanced reliability.
53+
54+
---
55+
56+
`--communityCloud`
57+
58+
Create the Pods in the Community Cloud tier, which typically offers lower pricing with spot instance availability.
59+
60+
---
61+
62+
`--imageName <value>` • `string`
63+
64+
The Docker container image to use for the Pods (e.g., `runpod/pytorch:latest`).
65+
66+
---
67+
68+
`--templateId <value>` • `string`
69+
70+
The ID of a template to use for Pod configuration, which pre-defines the image and environment settings.
71+
72+
---
73+
74+
`--containerDiskSize <number>` • `integer` • default = `20`
75+
76+
The size of the container disk in gigabytes for each Pod.
77+
78+
---
79+
80+
`--volumeSize <number>` • `integer` • default = `1`
81+
82+
The size of the persistent volume in gigabytes for each Pod.
83+
84+
---
85+
86+
`--volumePath <value>` • `string` • default = `/workspace`
87+
88+
The mount path for the persistent volume inside each container.
89+
90+
---
91+
92+
`--networkVolumeId <value>` • `string`
93+
94+
The ID of an existing network volume to attach to all Pods for shared storage.
95+
96+
---
97+
98+
`--cost <number>` • `float`
99+
100+
The maximum price ceiling in dollars per hour. If not specified, Pods will be created at the lowest available price.
101+
102+
---
103+
104+
`--mem <number>` • `integer` • default = `20`
105+
106+
The minimum system memory required in gigabytes for each Pod.
107+
108+
---
109+
110+
`--vcpu <number>` • `integer` • default = `1`
111+
112+
The minimum number of vCPUs required for each Pod.
113+
114+
---
115+
116+
`--env <value>` • `string`
117+
118+
Environment variables to set in the containers. Specify multiple times for multiple variables.
119+
120+
---
121+
122+
`--args <value>` • `string`
123+
124+
Additional arguments to pass to the containers when they start.
125+
126+
---
127+
128+
`--ports <value>` • `string`
129+
130+
Ports to expose from the containers. Maximum of 1 HTTP port and 1 TCP port allowed per Pod.
38131

39-
### SEE ALSO
132+
## Related commands
40133

41-
* [runpodctl create](/runpodctl/reference/runpodctl-create) - create a resource
134+
- [`runpodctl create`](/runpodctl/reference/runpodctl-create)
135+
- [`runpodctl create pod`](/runpodctl/reference/runpodctl-create-pod)

0 commit comments

Comments
 (0)