komodo_client 2.1.0

Client for the Komodo build and deployment system
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use std::collections::HashMap;

use serde::{Deserialize, Serialize};
use typeshare::typeshare;

#[typeshare]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct NetworkListItem {
  pub name: Option<String>,
  pub id: Option<String>,
  pub created: Option<String>,
  pub scope: Option<String>,
  pub driver: Option<String>,
  pub enable_ipv6: Option<bool>,
  pub ipam_driver: Option<String>,
  pub ipam_subnet: Option<String>,
  pub ipam_gateway: Option<String>,
  pub internal: Option<bool>,
  pub attachable: Option<bool>,
  pub ingress: Option<bool>,
  /// Whether the network is attached to one or more containers
  pub in_use: bool,
}

#[typeshare]
#[derive(
  Debug, Clone, Default, PartialEq, Serialize, Deserialize,
)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct Network {
  #[serde(rename = "Name")]
  pub name: Option<String>,

  #[serde(rename = "Id")]
  pub id: Option<String>,

  #[serde(rename = "Created")]
  pub created: Option<String>,

  #[serde(rename = "Scope")]
  pub scope: Option<String>,

  #[serde(rename = "Driver")]
  pub driver: Option<String>,

  #[serde(rename = "EnableIPv6")]
  pub enable_ipv6: Option<bool>,

  #[serde(rename = "IPAM")]
  pub ipam: Option<Ipam>,

  #[serde(rename = "Internal")]
  pub internal: Option<bool>,

  #[serde(rename = "Attachable")]
  pub attachable: Option<bool>,

  #[serde(rename = "Ingress")]
  pub ingress: Option<bool>,

  /// This field is turned from map into array for easier usability.
  #[serde(rename = "Containers")]
  pub containers: Vec<NetworkContainer>,

  #[serde(default, rename = "Options")]
  pub options: HashMap<String, String>,

  #[serde(default, rename = "Labels")]
  pub labels: HashMap<String, String>,
}

#[typeshare]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct Ipam {
  /// Name of the IPAM driver to use.
  #[serde(rename = "Driver")]
  pub driver: Option<String>,
  /// List of IPAM configuration options, specified as a map:  ``` {\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>} ```
  #[serde(rename = "Config")]
  pub config: Vec<IpamConfig>,
  /// Driver-specific options, specified as a map.
  #[serde(rename = "Options")]
  pub options: HashMap<String, String>,
}

#[typeshare]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct IpamConfig {
  #[serde(rename = "Subnet")]
  pub subnet: Option<String>,
  #[serde(rename = "IPRange")]
  pub ip_range: Option<String>,
  #[serde(rename = "Gateway")]
  pub gateway: Option<String>,
  #[serde(rename = "AuxiliaryAddresses")]
  pub auxiliary_addresses: HashMap<String, String>,
}

#[typeshare]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct NetworkContainer {
  /// This is the key on the incoming map of NetworkContainer
  #[serde(default, rename = "ContainerID")]
  pub container_id: String,
  #[serde(rename = "Name")]
  pub name: Option<String>,
  #[serde(rename = "EndpointID")]
  pub endpoint_id: Option<String>,
  #[serde(rename = "MacAddress")]
  pub mac_address: Option<String>,
  #[serde(rename = "IPv4Address")]
  pub ipv4_address: Option<String>,
  #[serde(rename = "IPv6Address")]
  pub ipv6_address: Option<String>,
}