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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
//! Request builder types and parameters for subresources
use std::fmt::Debug;
use crate::{
params::{DeleteParams, PostParams},
request::{Error, Request, JSON_MIME},
};
pub use k8s_openapi::api::autoscaling::v1::{Scale, ScaleSpec, ScaleStatus};
// ----------------------------------------------------------------------------
// Log subresource
// ----------------------------------------------------------------------------
/// Params for logging
#[derive(Default, Clone, Debug)]
pub struct LogParams {
/// The container for which to stream logs. Defaults to only container if there is one container in the pod.
pub container: Option<String>,
/// Follow the log stream of the pod. Defaults to `false`.
pub follow: bool,
/// If set, the number of bytes to read from the server before terminating the log output.
/// This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.
pub limit_bytes: Option<i64>,
/// If `true`, then the output is pretty printed.
pub pretty: bool,
/// Return previous terminated container logs. Defaults to `false`.
pub previous: bool,
/// A relative time in seconds before the current time from which to show logs.
/// If this value precedes the time a pod was started, only logs since the pod start will be returned.
/// If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
pub since_seconds: Option<i64>,
/// An RFC3339 timestamp from which to show logs. If this value
/// precedes the time a pod was started, only logs since the pod start will be returned.
/// If this value is in the future, no logs will be returned.
/// Only one of sinceSeconds or sinceTime may be specified.
pub since_time: Option<chrono::DateTime<chrono::Utc>>,
/// If set, the number of lines from the end of the logs to show.
/// If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime
pub tail_lines: Option<i64>,
/// If `true`, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to `false`.
pub timestamps: bool,
}
impl Request {
/// Get a pod logs
pub fn logs(&self, name: &str, lp: &LogParams) -> Result<http::Request<Vec<u8>>, Error> {
let target = format!("{}/{}/log?", self.url_path, name);
let mut qp = form_urlencoded::Serializer::new(target);
if let Some(container) = &lp.container {
qp.append_pair("container", container);
}
if lp.follow {
qp.append_pair("follow", "true");
}
if let Some(lb) = &lp.limit_bytes {
qp.append_pair("limitBytes", &lb.to_string());
}
if lp.pretty {
qp.append_pair("pretty", "true");
}
if lp.previous {
qp.append_pair("previous", "true");
}
if let Some(ss) = &lp.since_seconds {
qp.append_pair("sinceSeconds", &ss.to_string());
} else if let Some(st) = &lp.since_time {
let ser_since = st.to_rfc3339_opts(chrono::SecondsFormat::Secs, true);
qp.append_pair("sinceTime", &ser_since);
}
if let Some(tl) = &lp.tail_lines {
qp.append_pair("tailLines", &tl.to_string());
}
if lp.timestamps {
qp.append_pair("timestamps", "true");
}
let urlstr = qp.finish();
let req = http::Request::get(urlstr);
req.body(vec![]).map_err(Error::BuildRequest)
}
}
// ----------------------------------------------------------------------------
// Eviction subresource
// ----------------------------------------------------------------------------
/// Params for evictable objects
#[derive(Default, Clone)]
pub struct EvictParams {
/// How the eviction should occur
pub delete_options: Option<DeleteParams>,
/// How the http post should occur
pub post_options: PostParams,
}
impl Request {
/// Create an eviction
pub fn evict(&self, name: &str, ep: &EvictParams) -> Result<http::Request<Vec<u8>>, Error> {
let target = format!("{}/{}/eviction?", self.url_path, name);
// This is technically identical to Request::create, but different url
let pp = &ep.post_options;
pp.validate()?;
let mut qp = form_urlencoded::Serializer::new(target);
pp.populate_qp(&mut qp);
let urlstr = qp.finish();
// eviction body parameters are awkward, need metadata with name
let data = serde_json::to_vec(&serde_json::json!({
"delete_options": ep.delete_options,
"metadata": { "name": name }
}))
.map_err(Error::SerializeBody)?;
let req = http::Request::post(urlstr).header(http::header::CONTENT_TYPE, JSON_MIME);
req.body(data).map_err(Error::BuildRequest)
}
}
// ----------------------------------------------------------------------------
// Attach subresource
// ----------------------------------------------------------------------------
/// Parameters for attaching to a container in a Pod.
///
/// - One of `stdin`, `stdout`, or `stderr` must be `true`.
/// - `stderr` and `tty` cannot both be `true` because multiplexing is not supported with TTY.
#[cfg(feature = "ws")]
#[cfg_attr(docsrs, doc(cfg(feature = "ws")))]
#[derive(Debug)]
pub struct AttachParams {
/// The name of the container to attach.
/// Defaults to the only container if there is only one container in the pod.
pub container: Option<String>,
/// Attach to the container's standard input. Defaults to `false`.
///
/// Call [`AttachedProcess::stdin`](https://docs.rs/kube/*/kube/api/struct.AttachedProcess.html#method.stdin) to obtain a writer.
pub stdin: bool,
/// Attach to the container's standard output. Defaults to `true`.
///
/// Call [`AttachedProcess::stdout`](https://docs.rs/kube/*/kube/api/struct.AttachedProcess.html#method.stdout) to obtain a reader.
pub stdout: bool,
/// Attach to the container's standard error. Defaults to `true`.
///
/// Call [`AttachedProcess::stderr`](https://docs.rs/kube/*/kube/api/struct.AttachedProcess.html#method.stderr) to obtain a reader.
pub stderr: bool,
/// Allocate TTY. Defaults to `false`.
///
/// NOTE: Terminal resizing is not implemented yet.
pub tty: bool,
/// The maximum amount of bytes that can be written to the internal `stdin`
/// pipe before the write returns `Poll::Pending`.
/// Defaults to 1024.
///
/// This is not sent to the server.
pub max_stdin_buf_size: Option<usize>,
/// The maximum amount of bytes that can be written to the internal `stdout`
/// pipe before the write returns `Poll::Pending`.
/// Defaults to 1024.
///
/// This is not sent to the server.
pub max_stdout_buf_size: Option<usize>,
/// The maximum amount of bytes that can be written to the internal `stderr`
/// pipe before the write returns `Poll::Pending`.
/// Defaults to 1024.
///
/// This is not sent to the server.
pub max_stderr_buf_size: Option<usize>,
}
#[cfg(feature = "ws")]
#[cfg_attr(docsrs, doc(cfg(feature = "ws")))]
impl Default for AttachParams {
// Default matching the server's defaults.
fn default() -> Self {
Self {
container: None,
stdin: false,
stdout: true,
stderr: true,
tty: false,
max_stdin_buf_size: None,
max_stdout_buf_size: None,
max_stderr_buf_size: None,
}
}
}
#[cfg(feature = "ws")]
#[cfg_attr(docsrs, doc(cfg(feature = "ws")))]
impl AttachParams {
/// Default parameters for an tty exec with stdin and stdout
#[must_use]
pub fn interactive_tty() -> Self {
Self {
stdin: true,
stdout: true,
stderr: false,
tty: true,
..Default::default()
}
}
/// Specify the container to execute in.
#[must_use]
pub fn container<T: Into<String>>(mut self, container: T) -> Self {
self.container = Some(container.into());
self
}
/// Set `stdin` field.
#[must_use]
pub fn stdin(mut self, enable: bool) -> Self {
self.stdin = enable;
self
}
/// Set `stdout` field.
#[must_use]
pub fn stdout(mut self, enable: bool) -> Self {
self.stdout = enable;
self
}
/// Set `stderr` field.
#[must_use]
pub fn stderr(mut self, enable: bool) -> Self {
self.stderr = enable;
self
}
/// Set `tty` field.
#[must_use]
pub fn tty(mut self, enable: bool) -> Self {
self.tty = enable;
self
}
/// Set `max_stdin_buf_size` field.
#[must_use]
pub fn max_stdin_buf_size(mut self, size: usize) -> Self {
self.max_stdin_buf_size = Some(size);
self
}
/// Set `max_stdout_buf_size` field.
#[must_use]
pub fn max_stdout_buf_size(mut self, size: usize) -> Self {
self.max_stdout_buf_size = Some(size);
self
}
/// Set `max_stderr_buf_size` field.
#[must_use]
pub fn max_stderr_buf_size(mut self, size: usize) -> Self {
self.max_stderr_buf_size = Some(size);
self
}
pub(crate) fn validate(&self) -> Result<(), Error> {
if !self.stdin && !self.stdout && !self.stderr {
return Err(Error::Validation(
"AttachParams: one of stdin, stdout, or stderr must be true".into(),
));
}
if self.stderr && self.tty {
// Multiplexing is not supported with TTY
return Err(Error::Validation(
"AttachParams: tty and stderr cannot both be true".into(),
));
}
Ok(())
}
fn append_to_url_serializer(&self, qp: &mut form_urlencoded::Serializer<String>) {
if self.stdin {
qp.append_pair("stdin", "true");
}
if self.stdout {
qp.append_pair("stdout", "true");
}
if self.stderr {
qp.append_pair("stderr", "true");
}
if self.tty {
qp.append_pair("tty", "true");
}
if let Some(container) = &self.container {
qp.append_pair("container", container);
}
}
#[cfg(feature = "kubelet-debug")]
// https://github.com/kubernetes/kubernetes/blob/466d9378dbb0a185df9680657f5cd96d5e5aab57/pkg/apis/core/types.go#L6005-L6013
pub(crate) fn append_to_url_serializer_local(&self, qp: &mut form_urlencoded::Serializer<String>) {
if self.stdin {
qp.append_pair("input", "1");
}
if self.stdout {
qp.append_pair("output", "1");
}
if self.stderr {
qp.append_pair("error", "1");
}
if self.tty {
qp.append_pair("tty", "1");
}
}
}
#[cfg(feature = "ws")]
#[cfg_attr(docsrs, doc(cfg(feature = "ws")))]
impl Request {
/// Attach to a pod
pub fn attach(&self, name: &str, ap: &AttachParams) -> Result<http::Request<Vec<u8>>, Error> {
ap.validate()?;
let target = format!("{}/{}/attach?", self.url_path, name);
let mut qp = form_urlencoded::Serializer::new(target);
ap.append_to_url_serializer(&mut qp);
let req = http::Request::get(qp.finish());
req.body(vec![]).map_err(Error::BuildRequest)
}
}
// ----------------------------------------------------------------------------
// Exec subresource
// ----------------------------------------------------------------------------
#[cfg(feature = "ws")]
#[cfg_attr(docsrs, doc(cfg(feature = "ws")))]
impl Request {
/// Execute command in a pod
pub fn exec<I, T>(
&self,
name: &str,
command: I,
ap: &AttachParams,
) -> Result<http::Request<Vec<u8>>, Error>
where
I: IntoIterator<Item = T>,
T: Into<String>,
{
ap.validate()?;
let target = format!("{}/{}/exec?", self.url_path, name);
let mut qp = form_urlencoded::Serializer::new(target);
ap.append_to_url_serializer(&mut qp);
for c in command.into_iter() {
qp.append_pair("command", &c.into());
}
let req = http::Request::get(qp.finish());
req.body(vec![]).map_err(Error::BuildRequest)
}
}
// ----------------------------------------------------------------------------
// tests
// ----------------------------------------------------------------------------
/// Cheap sanity check to ensure type maps work as expected
#[cfg(test)]
mod test {
use crate::{request::Request, resource::Resource};
use chrono::{DateTime, TimeZone, Utc};
use k8s::core::v1 as corev1;
use k8s_openapi::api as k8s;
use crate::subresource::LogParams;
#[test]
fn logs_all_params() {
let url = corev1::Pod::url_path(&(), Some("ns"));
let lp = LogParams {
container: Some("nginx".into()),
follow: true,
limit_bytes: Some(10 * 1024 * 1024),
pretty: true,
previous: true,
since_seconds: Some(3600),
since_time: None,
tail_lines: Some(4096),
timestamps: true,
};
let req = Request::new(url).logs("mypod", &lp).unwrap();
assert_eq!(req.uri(), "/api/v1/namespaces/ns/pods/mypod/log?&container=nginx&follow=true&limitBytes=10485760&pretty=true&previous=true&sinceSeconds=3600&tailLines=4096×tamps=true");
}
#[test]
fn logs_since_time() {
let url = corev1::Pod::url_path(&(), Some("ns"));
let date: DateTime<Utc> = Utc.with_ymd_and_hms(2023, 10, 19, 13, 14, 26).unwrap();
let lp = LogParams {
since_seconds: None,
since_time: Some(date),
..Default::default()
};
let req = Request::new(url).logs("mypod", &lp).unwrap();
assert_eq!(
req.uri(),
"/api/v1/namespaces/ns/pods/mypod/log?&sinceTime=2023-10-19T13%3A14%3A26Z" // cross-referenced with kubectl
);
}
}
// ----------------------------------------------------------------------------
// Portforward subresource
// ----------------------------------------------------------------------------
#[cfg(feature = "ws")]
#[cfg_attr(docsrs, doc(cfg(feature = "ws")))]
impl Request {
/// Request to forward ports of a pod
pub fn portforward(&self, name: &str, ports: &[u16]) -> Result<http::Request<Vec<u8>>, Error> {
if ports.is_empty() {
return Err(Error::Validation("ports cannot be empty".into()));
}
if ports.len() > 128 {
return Err(Error::Validation(
"the number of ports cannot be more than 128".into(),
));
}
if ports.len() > 1 {
let mut seen = std::collections::HashSet::with_capacity(ports.len());
for port in ports.iter() {
if seen.contains(port) {
return Err(Error::Validation(format!(
"ports must be unique, found multiple {port}"
)));
}
seen.insert(port);
}
}
let base_url = format!("{}/{}/portforward?", self.url_path, name);
let mut qp = form_urlencoded::Serializer::new(base_url);
qp.append_pair(
"ports",
&ports.iter().map(|p| p.to_string()).collect::<Vec<_>>().join(","),
);
let req = http::Request::get(qp.finish());
req.body(vec![]).map_err(Error::BuildRequest)
}
}