runpod-sdk 0.2.2

Unofficial Rust SDK for RunPod: deploy and scale GPU workloads with serverless endpoints and on-demand pods
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

use serde::{Deserialize, Serialize};

/// Container registry authentication credentials.
///
/// Represents stored authentication credentials for accessing private container registries.
/// These credentials enable RunPod to pull private Docker images during Pod and Serverless
/// endpoint deployment.
///
/// # Security Notice
///
/// This struct only contains non-sensitive information. Actual passwords and tokens
/// are securely stored by RunPod and never returned in API responses.
///
/// # Usage
///
/// Authentication records are typically referenced by their ID when creating Pods or
/// Serverless endpoints that require access to private container images.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ContainerRegistryAuth {
    /// A unique string identifying the container registry authentication.
    /// This ID is used to reference the authentication when creating Pods or endpoints.
    pub id: String,

    /// A user-defined name for the container registry authentication.
    /// The name must be unique within your RunPod account and should be descriptive
    /// enough to identify the registry or purpose (e.g., "production-ecr", "my-dockerhub").
    pub name: String,
}

/// Collection of container registry authentication records.
///
/// This type alias represents the standard response format when listing
/// container registry authentications, containing an array of [`ContainerRegistryAuth`] instances.
pub type ContainerRegistryAuths = Vec<ContainerRegistryAuth>;

/// Input parameters for creating new container registry authentication.
///
/// Use this struct to provide the necessary credentials for accessing a private container registry.
/// All fields are required to establish authentication with the registry.
///
/// # Security Best Practices
///
/// - Use registry-specific access tokens instead of account passwords when available
/// - Ensure the username and password/token combination has the minimum required permissions
/// - Use descriptive names that help identify the registry and intended use case
/// - Regularly rotate credentials to maintain security
///
/// # Registry-Specific Examples
///
/// ## Docker Hub
/// ```rust
/// # use runpod_sdk::model::ContainerRegistryAuthCreateInput;
/// let docker_hub_auth = ContainerRegistryAuthCreateInput {
///     name: "dockerhub-production".to_string(),
///     username: "myusername".to_string(),
///     password: "dckr_pat_1234567890abcdef".to_string(), // Docker access token
/// };
/// ```
///
/// ## AWS ECR
/// ```rust
/// # use runpod_sdk::model::ContainerRegistryAuthCreateInput;
/// let ecr_auth = ContainerRegistryAuthCreateInput {
///     name: "aws-ecr-us-west-2".to_string(),
///     username: "AWS".to_string(),
///     password: "eyJwYXlsb2FkIjoi...".to_string(), // ECR authorization token
/// };
/// ```
///
/// ## GitHub Container Registry
/// ```rust
/// # use runpod_sdk::model::ContainerRegistryAuthCreateInput;
/// let ghcr_auth = ContainerRegistryAuthCreateInput {
///     name: "github-packages".to_string(),
///     username: "myusername".to_string(),
///     password: "ghp_1234567890abcdef".to_string(), // GitHub personal access token
/// };
/// ```
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ContainerRegistryAuthCreateInput {
    /// A user-defined name for the container registry authentication.
    /// The name must be unique within your RunPod account. Choose a descriptive
    /// name that identifies the registry and its intended use case.
    ///
    /// Examples: "production-ecr", "staging-dockerhub", "private-harbor"
    pub name: String,

    /// The username for authenticating with the container registry.
    /// This varies by registry type:
    /// - Docker Hub: Your Docker Hub username
    /// - AWS ECR: Always "AWS"
    /// - GitHub Container Registry: Your GitHub username
    /// - Google Container Registry: "_json_key" for service account authentication
    pub username: String,

    /// The password, token, or credential for authenticating with the container registry.
    /// For enhanced security, use registry-specific access tokens when available:
    /// - Docker Hub: Use access tokens instead of passwords
    /// - AWS ECR: Use ECR authorization tokens
    /// - GitHub: Use personal access tokens with package permissions
    /// - Google GCR: Use service account JSON key (as string) for the password
    pub password: String,
}