Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
×

Eviction [policy/v1]

Description

Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …​/pods/<pod name>/evictions.

Type

object

Specification

Property Type Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

deleteOptions

DeleteOptions

DeleteOptions may be provided

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

ObjectMeta describes the pod that is being evicted.

API endpoints

The following API endpoints are available:

  • /api/v1/namespaces/{namespace}/pods/{name}/eviction

    • POST: create eviction of a Pod

/api/v1/namespaces/{namespace}/pods/{name}/eviction

Table 1. Global path parameters
Parameter Type Description

name

string

name of the Eviction

namespace

string

object name and auth scope, such as for teams and projects
Table 2. Global query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

pretty

string

If 'true', then the output is pretty printed.
HTTP method

POST

Description

create eviction of a Pod

Table 3. Body parameters
Parameter Type Description

body

Eviction schema
Table 4. HTTP responses
HTTP code Reponse body

200 - OK

Eviction schema

201 - Created

Eviction schema

202 - Accepted

Eviction schema

401 - Unauthorized

Empty