@pulumi/kubernetes
Version:
[](https://travis-ci.com/pulumi/pulumi-kubernetes) [](https://slack.pulumi.com) [![NPM
153 lines (152 loc) • 6.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../../types/input";
import * as outputs from "../../types/output";
/**
* Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
*
* 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. Ingress object exists.
* 2. Endpoint objects exist with matching names for each Ingress path (except when Service
* type is ExternalName).
* 3. Ingress entry exists for '.status.loadBalancer.ingress'.
*
* If the Ingress 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.
*
* ## Example Usage
* ### Create an Ingress with auto-naming
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as kubernetes from "@pulumi/kubernetes";
*
* const ingress = new kubernetes.networking.v1.Ingress("ingress", {
* metadata: {
* annotations: {
* "nginx.ingress.kubernetes.io/rewrite-target": "/",
* },
* },
* spec: {
* rules: [{
* http: {
* paths: [{
* backend: {
* service: {
* name: "test",
* port: {
* number: 80,
* },
* },
* },
* path: "/testpath",
* pathType: "Prefix",
* }],
* },
* }],
* },
* });
* ```
* ### Create an Ingress with a user-specified name
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as kubernetes from "@pulumi/kubernetes";
*
* const ingress = new kubernetes.networking.v1.Ingress("ingress", {
* metadata: {
* annotations: {
* "nginx.ingress.kubernetes.io/rewrite-target": "/",
* },
* name: "minimal-ingress",
* },
* spec: {
* rules: [{
* http: {
* paths: [{
* backend: {
* service: {
* name: "test",
* port: {
* number: 80,
* },
* },
* },
* path: "/testpath",
* pathType: "Prefix",
* }],
* },
* }],
* },
* });
* ```
*/
export declare class Ingress extends pulumi.CustomResource {
/**
* Get an existing Ingress resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Ingress;
/**
* Returns true if the given object is an instance of Ingress. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Ingress;
/**
* 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
*/
readonly apiVersion: pulumi.Output<"networking.k8s.io/v1">;
/**
* 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
*/
readonly kind: pulumi.Output<"Ingress">;
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
readonly metadata: pulumi.Output<outputs.meta.v1.ObjectMeta>;
/**
* 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
*/
readonly spec: pulumi.Output<outputs.networking.v1.IngressSpec>;
/**
* 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
*/
readonly status: pulumi.Output<outputs.networking.v1.IngressStatus>;
/**
* Create a Ingress resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: IngressArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Ingress resource.
*/
export interface IngressArgs {
/**
* 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
*/
apiVersion?: pulumi.Input<"networking.k8s.io/v1">;
/**
* 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
*/
kind?: pulumi.Input<"Ingress">;
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
metadata?: pulumi.Input<inputs.meta.v1.ObjectMeta>;
/**
* 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
*/
spec?: pulumi.Input<inputs.networking.v1.IngressSpec>;
}