文档首页 > > API参考> Kubernetes API> Ingress> 创建Ingress

创建Ingress

分享
更新时间:2020/09/18 GMT+08:00

功能介绍

This API is used to create an Ingress.

URI

POST /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses (Supports 1.15 and 1.15+)

POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses (Supports 1.15-)

表1描述该API的参数。

表1 参数解释

参数

是否必选

描述

namespace

Yes

Object name and auth scope, such as for teams and projects.

pretty

No

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

body

Yes

请参见表2

请求消息

请求参数:

请求参数如表2所示。

表2 请求参数

参数

是否必选

参数类型

描述

apiVersion

No

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.

kind

No

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.

metadata

No

metadata object

Standard object’s metadata.

spec

No

spec object

Spec is the desired state of the Ingress.

status

No

status object

Status is the current state of the Ingress.

表3 metadata字段数据结构说明

参数

是否必选

参数类型

描述

annotations

No

Object

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.

clusterName

No

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

No

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.

deletionGracePeriodSeconds

No

Integer

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

No

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.

enable

No

Boolean

Enable identify whether the resource is available.

finalizers

No

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.

generateName

No

String

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.

generation

No

Integer

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

initializers

No

initializers object

An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven’t explicitly asked to observe uninitialized objects.

When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.

labels

No

Object

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.

name

No

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.

namespace

No

String

Namespace defines the space within 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.

ownerReferences

No

Array of strings

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

No

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.

selfLink

No

String

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

uid

No

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.

表4 spec字段数据结构说明

参数

是否必选

参数类型

描述

backend

No

backend 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.

rules

No

Array of IngressRule object

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

No

Array of IngressTLS object

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.

表5 status字段数据结构说明

参数

是否必选

参数类型

描述

loadBalancer

No

loadBalancer object

LoadBalancer contains the current status of the load-balancer.

表6 backend字段数据结构说明

参数

是否必选

参数类型

描述

serviceName

No

String

Specifies the name of the referenced service.

servicePort

No

Integer

Specifies the port of the referenced service.

表7 loadBalancer字段数据结构说明

参数

是否必选

参数类型

描述

ingress

No

Array of strings

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

表8 IngressRule字段数据结构说明

参数

是否必选

参数类型

描述

http

No

http object

Is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend 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 '#'.

host

No

String

Host is the fully qualified domain name of a network host, as defined by RFC 3986. Incoming requests are matched against the host before the http. If the host is unspecified, the Ingress routes all traffic based on the http rule.

表9 http字段数据结构说明

参数

是否必选

参数类型

描述

paths

Yes

Array of HTTPIngressPath object

A collection of paths that map requests to backends.

表10 HTTPIngressPath字段数据结构说明

参数

是否必选

参数类型

描述

path

No

String

Paths must begin with a '/'. If unspecified, the path defaults to a catch all sending traffic to the backend.

backend

No

backend object

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

property

No

Object

Extension property on the path

表11 IngressTLS字段数据结构说明

参数

是否必选

参数类型

描述

hosts

No

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.

serviceName

No

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.

请求示例:

{
    "apiVersion": "extensions/v1beta1",
    "kind": "Ingress",
    "metadata": {
        "annotations": {
            "ingress.kubernetes.io/secure-backends": "false",
            "ingress.beta.kubernetes.io/role": "data",
            "kubernetes.io/elb.ip": "192.168.0.39",
            "kubernetes.io/elb.port": "80",
            "kubernetes.io/elb.subnet-id": "bf04639b-9e67-4f02-ac63-379e9ce48ea2"
        },
        "labels": {
            "zone": "data",
            "isExternal": "true",
            "deploy-ingress": "ingress-test"
        },
        "name": "ingress-test"
    },
    "spec": {
        "tls": {
            "secretName: ": "ingress-test"
        },
        "rules": [
            {
                "http": {
                    "paths": [
                        {
                            "backend": {
                                "serviceName": "ingress-test",
                                "servicePort": 8080
                            },
                            "path": "/healthz",
                            "property": {
                                "ingress.beta.kubernetes.io/url-match-mode": "EQUAL_TO"
                            }
                        }
                    ]
                }
            }
        ]
    }
}

响应消息

响应参数:

响应参数的详细描述请参见表2

响应示例:

{
    "kind": "Ingress",
    "apiVersion": "extensions/v1beta1",
    "metadata": {
        "name": "ingress-test",
        "namespace": "default",
        "selfLink": "/apis/extensions/v1beta1/namespaces/default/ingresses/ingress-test",
        "uid": "3acdf7b4-7ac5-11e8-a5f8-fa163e458c2a",
        "resourceVersion": "1473939",
        "generation": 1,
        "creationTimestamp": "2018-06-28T11:20:14Z",
        "labels": {
            "isExternal": "true",
            "zone": "data"
        },
        "annotations": {
            "ingress.beta.kubernetes.io/role": "data",
            "ingress.kubernetes.io/secure-backends": "false",
            "kubernetes.io/elb.subnet-id": "bf04639b-9e67-4f02-ac63-379e9ce48ea2",
            "kubernetes.io/elb.ip": "192.168.0.39",
            "kubernetes.io/elb.port": "80",
            "kubernetes.io/ingress.class": "public-elb",
            "protocol": "HTTP"
        }
    },
    "spec": {
        "rules": [
            {
                "host": "test",
                "http": {
                    "paths": [
                        {
                            "path": "/healthz",
                            "backend": {
                                "serviceName": "ingress-test",
                                "servicePort": 8080
                            },
                            "property": {
                                "ingress.beta.kubernetes.io/url-match-mode": "STARTS_WITH"
                            }
                        }
                    ]
                }
            }
        ]
    },
    "status": {
        "loadBalancer": {}
    }
}

状态码

表12描述API的状态码。

表12 状态码

状态码

描述

201

success

异常状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问