Updated on 2024-07-04 GMT+08:00

Updating an Ingress

Function

This API is used to update a specified ingress.

The following fields can be updated:

  • metadata.labels

  • metadata.generateName

  • metadata.annotations

  • spec.rules

Calling Method

For details, see Calling APIs.

URI

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

name

Yes

String

name of the Ingress

namespace

Yes

String

object name and auth scope, such as for teams and projects

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

dryRun

No

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

No

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. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

force

No

Boolean

Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

pretty

No

String

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

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

Currently, three types of patch request methods are supported. For details, see "Update API Objects in Place Using kubectl patch" (https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/).

  • Json Patch, Content-Type: application/json-patch+json As defined in RFC6902, Json Patch contains a series of operations on a JSON object. After receiving the object, the server applies the represented operations to the JSON object.

  • Merge Patch, Content-Type: application/merge-patch+json According to RFC 7386, Merge Patch contains some description of a JSON object. The JSON object is submitted to the server end and merges with the current object of the server end, which means to replace the list field of the current resource object to form a new object.

  • Strategic Merge Patch, Content-Type: application/strategic-merge-patch+json Strategic Merge Patch is used to add legal metadata to API objects and uses new metadata to determine which lists should be merged and which ones should not. The current metadata is used as the structure labels.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

-

Yes

Object

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

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

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

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

io.k8s.api.extensions.v1beta1.IngressSpec object

Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

status

io.k8s.api.extensions.v1beta1.IngressStatus object

Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Table 6 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Parameter

Type

Description

annotations

Map<String,String>

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

clusterName

String

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

creationTimestamp

String

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds

Long

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp

String

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers

Array of strings

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

generateName

String

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation

Long

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels

Map<String,String>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

managedFields

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

name

String

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

String

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

resourceVersion

String

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink

String

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

uid

String

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Table 7 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Parameter

Type

Description

apiVersion

String

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

fieldsType

String

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

fieldsV1

Object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

manager

String

Manager is an identifier of the workflow managing these fields.

operation

String

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

time

String

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

Table 8 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Parameter

Type

Description

apiVersion

String

API version of the referent.

blockOwnerDeletion

Boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

controller

Boolean

If true, this reference points to the managing controller.

kind

String

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

String

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uid

String

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Table 9 io.k8s.api.extensions.v1beta1.IngressSpec

Parameter

Type

Description

backend

io.k8s.api.extensions.v1beta1.IngressBackend object

A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.

ingressClassName

String

IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated kubernetes.io/ingress.class annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.

rules

Array of io.k8s.api.extensions.v1beta1.IngressRule objects

A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.

tls

Array of io.k8s.api.extensions.v1beta1.IngressTLS objects

TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.

Table 10 io.k8s.api.extensions.v1beta1.IngressRule

Parameter

Type

Description

host

String

Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The : delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.

Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. ".foo.com"). The wildcard character '' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule.

http

io.k8s.api.extensions.v1beta1.HTTPIngressRuleValue object

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]/[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]?[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.

Table 11 io.k8s.api.extensions.v1beta1.HTTPIngressRuleValue

Parameter

Type

Description

paths

Array of io.k8s.api.extensions.v1beta1.HTTPIngressPath objects

A collection of paths that map requests to backends.

Table 12 io.k8s.api.extensions.v1beta1.HTTPIngressPath

Parameter

Type

Description

backend

io.k8s.api.extensions.v1beta1.IngressBackend object

Backend defines the referenced service endpoint to which the traffic will be forwarded to.

path

String

Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched.

pathType

String

PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz).

  • ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types. Defaults to ImplementationSpecific.

property

Map<String,String>

Extension property on the path.

Table 13 io.k8s.api.extensions.v1beta1.IngressBackend

Parameter

Type

Description

resource

io.k8s.api.core.v1.TypedLocalObjectReference object

Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.

serviceName

String

Specifies the name of the referenced service.

servicePort

String

Specifies the port of the referenced service.

Table 14 io.k8s.api.core.v1.TypedLocalObjectReference

Parameter

Type

Description

apiGroup

String

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

String

Kind is the type of resource being referenced

name

String

Name is the name of resource being referenced

Table 15 io.k8s.api.extensions.v1beta1.IngressTLS

Parameter

Type

Description

hosts

Array of strings

Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.

secretName

String

SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.

Table 16 io.k8s.api.extensions.v1beta1.IngressStatus

Parameter

Type

Description

loadBalancer

io.k8s.api.core.v1.LoadBalancerStatus object

LoadBalancer contains the current status of the load-balancer.

Table 17 io.k8s.api.core.v1.LoadBalancerStatus

Parameter

Type

Description

ingress

Array of io.k8s.api.core.v1.LoadBalancerIngress objects

Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

Table 18 io.k8s.api.core.v1.LoadBalancerIngress

Parameter

Type

Description

hostname

String

Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)

ip

String

IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)

Example Requests

Changing the servicePort value of the ingress to 8082

{
  "spec" : {
    "rules" : [ {
      "http" : {
        "paths" : [ {
          "backend" : {
            "serviceName" : "redis",
            "servicePort" : 8082
          },
          "path" : "/"
        } ]
      }
    } ]
  }
}

Example Responses

Status code: 200

OK

{
  "apiVersion" : "extensions/v1beta1",
  "kind" : "Ingress",
  "metadata" : {
    "annotations" : {
      "kubernetes.io/elb.id" : "xxx",
      "kubernetes.io/elb.ip" : "192.168.137.182",
      "kubernetes.io/elb.port" : "6071"
    },
    "creationTimestamp" : "2018-09-04T02:16:14Z",
    "generation" : 3,
    "labels" : {
      "app" : "redis",
      "isExternal" : "true",
      "zone" : "data"
    },
    "name" : "redis",
    "namespace" : "namespace-test",
    "resourceVersion" : "5165479",
    "selfLink" : "/apis/extensions/v1beta1/namespaces/namespace-test/ingresses/redis",
    "uid" : "7f86c310-afe8-11e8-b6ef-f898ef6c78b4"
  },
  "spec" : {
    "rules" : [ {
      "http" : {
        "paths" : [ {
          "backend" : {
            "serviceName" : "redis",
            "servicePort" : 8082
          },
          "path" : "/"
        } ]
      }
    } ]
  },
  "status" : {
    "loadBalancer" : {
      "ingress" : [ {
        "ip" : "192.168.137.182"
      } ]
    }
  }
}

Status Codes

Status Code

Description

200

OK

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

405

MethodNotAllowed

406

NotAcceptable

409

Conflict

415

UnsupportedMediaType

422

Invalid

429

TooManyRequests

500

InternalError

503

ServiceUnavailable

504

ServerTimeout