Class Service

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

Service object exists.
Related Endpoint objects are created. Each time we get an update, wait 10 seconds for any stragglers.
The endpoints objects target some number of living objects (unless the Service is an "empty headless" Service [1] or a Service with '.spec.type: ExternalName').
External IP address is allocated (if Service has '.spec.type: LoadBalancer').

Known limitations: Services targeting ReplicaSets (and, by extension, Deployments, StatefulSets, etc.) with '.spec.replicas' set to 0 are not handled, and will time out. To work around this limitation, set 'pulumi.com/skipAwait: "true"' on '.metadata.annotations' for the Service. Work to handle this case is in progress [2].

[1] https://kubernetes.io/docs/concepts/services-networking/service/#headless-services [2] https://github.com/pulumi/pulumi-kubernetes/pull/703

If the Service has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the 'customTimeouts' option on the resource.

Inheritance

System.Object

Resource

CustomResource

KubernetesResource

Service

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Kubernetes.Core.V1

Assembly: Pulumi.Kubernetes.dll

Syntax

public class Service : KubernetesResource

Constructors

View Source

Service(String, ServiceArgs, CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

Declaration

public Service(string name, ServiceArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ServiceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

ApiVersion

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

Declaration

public Output<string> ApiVersion { get; }

Property Value

Type	Description
Output<System.String>

View Source

Kind

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

Declaration

public Output<string> Kind { get; }

Property Value

Type	Description
Output<System.String>

View Source

Metadata

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

Declaration

public Output<ObjectMeta> Metadata { get; }

Property Value

Type	Description
Output<ObjectMeta>

View Source

Spec

Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Declaration

public Output<ServiceSpec> Spec { get; }

Property Value

Type	Description
Output<ServiceSpec>

View Source

Status

Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Declaration

public Output<ServiceStatus> Status { get; }

Property Value

Type	Description
Output<ServiceStatus>

Methods

View Source

Get(String, Input<String>, CustomResourceOptions)

Get an existing Service resource's state with the given name and ID.

Declaration

public static Service Get(string name, Input<string> id, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Service