kubernetes_asyncio.client.models.v1_service_spec module

Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: v1.34.3 Generated by: https://openapi-generator.tech

class kubernetes_asyncio.client.models.v1_service_spec.V1ServiceSpec(allocate_load_balancer_node_ports=None, cluster_ip=None, cluster_ips=None, external_ips=None, external_name=None, external_traffic_policy=None, health_check_node_port=None, internal_traffic_policy=None, ip_families=None, ip_family_policy=None, load_balancer_class=None, load_balancer_ip=None, load_balancer_source_ranges=None, ports=None, publish_not_ready_addresses=None, selector=None, session_affinity=None, session_affinity_config=None, traffic_distribution=None, type=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

property allocate_load_balancer_node_ports

Gets the allocate_load_balancer_node_ports of this V1ServiceSpec. # noqa: E501

allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is “true”. It may be set to “false” if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. # noqa: E501

Returns:

The allocate_load_balancer_node_ports of this V1ServiceSpec. # noqa: E501

Return type:

bool

attribute_map = {'allocate_load_balancer_node_ports': 'allocateLoadBalancerNodePorts', 'cluster_ip': 'clusterIP', 'cluster_ips': 'clusterIPs', 'external_ips': 'externalIPs', 'external_name': 'externalName', 'external_traffic_policy': 'externalTrafficPolicy', 'health_check_node_port': 'healthCheckNodePort', 'internal_traffic_policy': 'internalTrafficPolicy', 'ip_families': 'ipFamilies', 'ip_family_policy': 'ipFamilyPolicy', 'load_balancer_class': 'loadBalancerClass', 'load_balancer_ip': 'loadBalancerIP', 'load_balancer_source_ranges': 'loadBalancerSourceRanges', 'ports': 'ports', 'publish_not_ready_addresses': 'publishNotReadyAddresses', 'selector': 'selector', 'session_affinity': 'sessionAffinity', 'session_affinity_config': 'sessionAffinityConfig', 'traffic_distribution': 'trafficDistribution', 'type': 'type'}

property cluster_ip

Gets the cluster_ip of this V1ServiceSpec. # noqa: E501

clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are “None”, empty string (“”), or a valid IP address. Setting this to “None” makes a “headless service” (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies # noqa: E501

Returns:

The cluster_ip of this V1ServiceSpec. # noqa: E501

Return type:

str

property cluster_ips

Gets the cluster_ips of this V1ServiceSpec. # noqa: E501

ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are “None”, empty string (“”), or a valid IP address. Setting this to “None” makes a “headless service” (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. This field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies # noqa: E501

Returns:

The cluster_ips of this V1ServiceSpec. # noqa: E501

Return type:

list[str]

property external_ips

Gets the external_ips of this V1ServiceSpec. # noqa: E501

externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. # noqa: E501

Returns:

The external_ips of this V1ServiceSpec. # noqa: E501

Return type:

list[str]

property external_name

Gets the external_name of this V1ServiceSpec. # noqa: E501

externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires type to be “ExternalName”. # noqa: E501

Returns:

The external_name of this V1ServiceSpec. # noqa: E501

Return type:

str

property external_traffic_policy

Gets the external_traffic_policy of this V1ServiceSpec. # noqa: E501

externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service’s “externally-facing” addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to “Local”, the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, “Cluster”, uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get “Cluster” semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node. # noqa: E501

Returns:

The external_traffic_policy of this V1ServiceSpec. # noqa: E501

Return type:

str

property health_check_node_port

Gets the health_check_node_port of this V1ServiceSpec. # noqa: E501

healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set. # noqa: E501

Returns:

The health_check_node_port of this V1ServiceSpec. # noqa: E501

Return type:

int

property internal_traffic_policy

Gets the internal_traffic_policy of this V1ServiceSpec. # noqa: E501

InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to “Local”, the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, “Cluster”, uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). # noqa: E501

Returns:

The internal_traffic_policy of this V1ServiceSpec. # noqa: E501

Return type:

str

property ip_families

Gets the ip_families of this V1ServiceSpec. # noqa: E501

IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are “IPv4” and “IPv6”. This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to “headless” services. This field will be wiped when updating a Service to type ExternalName. This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. # noqa: E501

Returns:

The ip_families of this V1ServiceSpec. # noqa: E501

Return type:

list[str]

property ip_family_policy

Gets the ip_family_policy of this V1ServiceSpec. # noqa: E501

IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be “SingleStack” (a single IP family), “PreferDualStack” (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or “RequireDualStack” (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. # noqa: E501

Returns:

The ip_family_policy of this V1ServiceSpec. # noqa: E501

Return type:

str

property load_balancer_class

Gets the load_balancer_class of this V1ServiceSpec. # noqa: E501

loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. “internal-vip” or “example.com/internal-vip”. Unprefixed names are reserved for end-users. This field can only be set when the Service type is ‘LoadBalancer’. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type ‘LoadBalancer’. Once set, it can not be changed. This field will be wiped when a service is updated to a non ‘LoadBalancer’ type. # noqa: E501

Returns:

The load_balancer_class of this V1ServiceSpec. # noqa: E501

Return type:

str

property load_balancer_ip

Gets the load_balancer_ip of this V1ServiceSpec. # noqa: E501

Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations. Using it is non-portable and it may not support dual-stack. Users are encouraged to use implementation-specific annotations when available. # noqa: E501

Returns:

The load_balancer_ip of this V1ServiceSpec. # noqa: E501

Return type:

str

property load_balancer_source_ranges

Gets the load_balancer_source_ranges of this V1ServiceSpec. # noqa: E501

If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.” More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ # noqa: E501

Returns:

The load_balancer_source_ranges of this V1ServiceSpec. # noqa: E501

Return type:

list[str]

openapi_types = {'allocate_load_balancer_node_ports': 'bool', 'cluster_ip': 'str', 'cluster_ips': 'list[str]', 'external_ips': 'list[str]', 'external_name': 'str', 'external_traffic_policy': 'str', 'health_check_node_port': 'int', 'internal_traffic_policy': 'str', 'ip_families': 'list[str]', 'ip_family_policy': 'str', 'load_balancer_class': 'str', 'load_balancer_ip': 'str', 'load_balancer_source_ranges': 'list[str]', 'ports': 'list[V1ServicePort]', 'publish_not_ready_addresses': 'bool', 'selector': 'dict(str, str)', 'session_affinity': 'str', 'session_affinity_config': 'V1SessionAffinityConfig', 'traffic_distribution': 'str', 'type': 'str'}

property ports

Gets the ports of this V1ServiceSpec. # noqa: E501

The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies # noqa: E501

Returns:

The ports of this V1ServiceSpec. # noqa: E501

Return type:

list[V1ServicePort]

property publish_not_ready_addresses

Gets the publish_not_ready_addresses of this V1ServiceSpec. # noqa: E501

publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet’s Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered “ready” even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior. # noqa: E501

Returns:

The publish_not_ready_addresses of this V1ServiceSpec. # noqa: E501

Return type:

bool

property selector

Gets the selector of this V1ServiceSpec. # noqa: E501

Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ # noqa: E501

Returns:

The selector of this V1ServiceSpec. # noqa: E501

Return type:

dict(str, str)

property session_affinity

Gets the session_affinity of this V1ServiceSpec. # noqa: E501

Supports “ClientIP” and “None”. Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies # noqa: E501

Returns:

The session_affinity of this V1ServiceSpec. # noqa: E501

Return type:

str

property session_affinity_config

Gets the session_affinity_config of this V1ServiceSpec. # noqa: E501

Returns:

The session_affinity_config of this V1ServiceSpec. # noqa: E501

Return type:

V1SessionAffinityConfig

to_dict(serialize=False)

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property traffic_distribution

Gets the traffic_distribution of this V1ServiceSpec. # noqa: E501

TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. Implementations can use this field as a hint, but are not required to guarantee strict adherence. If the field is not set, the implementation will apply its default routing strategy. If set to “PreferClose”, implementations should prioritize endpoints that are in the same zone. # noqa: E501

Returns:

The traffic_distribution of this V1ServiceSpec. # noqa: E501

Return type:

str

property type

Gets the type of this V1ServiceSpec. # noqa: E501

type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. “ClusterIP” allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is “None”, no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. “NodePort” builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. “LoadBalancer” builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. “ExternalName” aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types # noqa: E501

Returns:

The type of this V1ServiceSpec. # noqa: E501

Return type:

str