Show / Hide Table of Contents

Class Pod

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

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:

  1. The Pod is scheduled ("PodScheduled"" '.status.condition' is true).
  2. The Pod is initialized ("Initialized" '.status.condition' is true).
  3. The Pod is ready ("Ready" '.status.condition' is true) and the '.status.phase' is set to "Running". Or (for Jobs): The Pod succeeded ('.status.phase' set to "Succeeded").

If the Pod 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
Pod
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 Pod : KubernetesResource

Constructors

View Source

Pod(String, PodArgs, CustomResourceOptions)

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

Declaration
public Pod(string name, PodArgs args = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource

PodArgs 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

Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Declaration
public Output<PodSpec> Spec { get; }
Property Value
Type Description
Output<PodSpec>
View Source

Status

Most recently observed status of the pod. This data may not be up to date. 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<PodStatus> Status { get; }
Property Value
Type Description
Output<PodStatus>

Methods

View Source

Get(String, Input<String>, CustomResourceOptions)

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

Declaration
public static Pod 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
Pod
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.