pulumi-kubernetes 4.23.0a1746131759__tar.gz → 4.23.0a1746153578__tar.gz

pulumi_kubernetes-4.23.0a1746153578/PKG-INFO

@@ -0,0 +1,247 @@
+Metadata-Version: 2.4
+Name: pulumi_kubernetes
+Version: 4.23.0a1746153578
+Summary: A Pulumi package for creating and managing Kubernetes resources.
+License: Apache-2.0
+Project-URL: Homepage, https://pulumi.com
+Project-URL: Repository, https://github.com/pulumi/pulumi-kubernetes
+Keywords: pulumi,kubernetes,category/cloud,kind/native
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: parver>=0.2.1
+Requires-Dist: pulumi<4.0.0,>=3.165.0
+Requires-Dist: requests<3.0,>=2.21
+Requires-Dist: semver>=2.8.1
+Requires-Dist: typing-extensions<5,>=4.11; python_version < "3.11"
+
+[![Build Status](https://travis-ci.com/pulumi/pulumi-kubernetes.svg?token=eHg7Zp5zdDDJfTjY8ejq&branch=master)](https://travis-ci.com/pulumi/pulumi-kubernetes)
+[![Slack](http://www.pulumi.com/images/docs/badges/slack.svg)](https://slack.pulumi.com)
+[![NPM version](https://badge.fury.io/js/%40pulumi%2Fkubernetes.svg)](https://www.npmjs.com/package/@pulumi/kubernetes)
+[![Python version](https://badge.fury.io/py/pulumi-kubernetes.svg)](https://pypi.org/project/pulumi-kubernetes/)
+[![GoDoc](https://godoc.org/github.com/pulumi/pulumi-kubernetes/sdk/v4?status.svg)](https://pkg.go.dev/github.com/pulumi/pulumi-kubernetes/sdk/v4)
+[![License](https://img.shields.io/github/license/pulumi/pulumi-kubernetes)](https://github.com/pulumi/pulumi-kubernetes/blob/master/LICENSE)
+
+# Pulumi Kubernetes Resource Provider
+
+The Kubernetes resource provider for Pulumi lets you create, deploy, and manage Kubernetes API resources and workloads in a running cluster. For a streamlined Pulumi walkthrough, including language runtime installation and Kubernetes configuration, select "Get Started" below.
+<div>
+    <p>
+        <a href="https://www.pulumi.com/docs/get-started/kubernetes" title="Get Started">
+            <img src="https://www.pulumi.com/images/get-started.svg?" width="120">
+        </a>
+    </p>  
+</div>
+
+* [Introduction](#introduction)
+  * [Kubernetes API Version Support](#kubernetes-api-version-support)
+  * [How does API support for Kubernetes work?](#how-does-api-support-for-kubernetes-work)
+* [References](#references)
+* [Prerequisites](#prerequisites)
+* [Installing](#installing)
+* [Quick Examples](#quick-examples)
+  * [Deploying a YAML Manifest](#deploying-a-yaml-manifest)
+  * [Deploying a Helm Chart](#deploying-a-helm-chart)
+  * [Deploying a Workload using the Resource API](#deploying-a-workload-using-the-resource-api)
+* [Contributing](#contributing)
+* [Code of Conduct](#code-of-conduct)
+
+## Introduction
+
+`pulumi-kubernetes` provides an SDK to create any of the API resources
+available in Kubernetes.
+
+This includes the resources you know and love, such as:
+- Deployments
+- ReplicaSets
+- ConfigMaps
+- Secrets
+- Jobs etc.
+
+#### Kubernetes API Version Support
+
+The `pulumi-kubernetes` SDK closely tracks the latest upstream release, and provides access
+to the full API surface, including deprecated endpoints.
+The SDK API is 100% compatible with the Kubernetes API, and is
+schematically identical to what Kubernetes users expect.
+
+We support Kubernetes clusters with version >=1.9.0.
+
+#### How does API support for Kubernetes work?
+
+Pulumi’s Kubernetes SDK is manufactured by automatically wrapping our
+library functionality around the Kubernetes resource [OpenAPI
+spec](https://github.com/kubernetes/kubernetes/tree/master/api/openapi-spec) as soon as a
+new version is released! Ultimately, this means that Pulumi users do not have
+to learn a new Kubernetes API model, nor wait long to work with the latest
+available versions.
+
+> Note: Pulumi also supports alpha and beta APIs.
+
+Visit the [FAQ](https://www.pulumi.com/docs/reference/clouds/kubernetes/faq/)
+for more details.
+
+## References
+
+* [Reference Documentation](https://www.pulumi.com/registry/packages/kubernetes/)
+* API Documentation
+    * [Node.js API](https://pulumi.io/reference/pkg/nodejs/@pulumi/kubernetes)
+    * [Python API](https://www.pulumi.com/docs/reference/pkg/python/pulumi_kubernetes/)
+* [All Examples](./examples)
+* [How-to Guides](https://www.pulumi.com/registry/packages/kubernetes/how-to-guides/)
+
+## Prerequisites
+
+1. [Install Pulumi](https://www.pulumi.com/docs/get-started/kubernetes/install-pulumi/).
+1. Install a language runtime such as [Node.js](https://nodejs.org/en/download), [Python](https://www.python.org/downloads/) or [.NET](https://dotnet.microsoft.com/download/dotnet-core/3.1).
+1. Install a package manager
+    * For Node.js, use [NPM](https://www.npmjs.com/get-npm) or [Yarn](https://yarnpkg.com/lang/en/docs/install).
+    * For Python, use [pip](https://pip.pypa.io/en/stable/installing/).
+    * For .NET, use Nuget which is integrated with the `dotnet` CLI.
+1. Have access to a running Kubernetes cluster
+    * If `kubectl` already works for your running cluster, Pulumi respects and uses this configuration.
+    * If you do not have a cluster already running and available, we encourage you to
+      explore Pulumi's SDKs for AWS EKS, Azure AKS, and GCP GKE. Visit the 
+      [API reference docs in the Pulumi Registry](https://www.pulumi.com/registry/packages/kubernetes/api-docs/) for more details.
+1. [Install `kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl).
+
+## Installing
+
+This package is available in many languages in the standard packaging formats.
+
+For Node.js use either `npm` or `yarn`:
+
+`npm`:
+
+```bash
+npm install @pulumi/kubernetes
+```
+
+`yarn`:
+
+```bash
+yarn add @pulumi/kubernetes
+```
+
+For Python use `pip`:
+
+```bash
+pip install pulumi-kubernetes
+```
+
+For .NET, dependencies will be automatically installed as part of your Pulumi deployments using `dotnet build`.
+
+To use from Go, use `go install` to grab the latest version of the library
+
+    $ go install github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes@latest
+
+## Quick Examples
+
+The following examples demonstrate how to work with `pulumi-kubernetes` in
+a couple of ways.
+
+Examples may include the creation of an AWS EKS cluster, although an EKS cluster
+is **not** required to use `pulumi/kubernetes`. It is simply used to ensure
+we have access to a running Kubernetes cluster to deploy resources and workloads into.
+
+### Deploying a YAML Manifest
+
+This example deploys resources from a YAML manifest file path, using the
+transient, default `kubeconfig` credentials on the local machine, just as `kubectl` does.
+
+```typescript
+import * as k8s from "@pulumi/kubernetes";
+
+const myApp = new k8s.yaml.ConfigFile("app", {
+    file: "app.yaml"
+});
+```
+
+### Deploying a Helm Chart
+
+This example creates an EKS cluster with [`pulumi/eks`](https://github.com/pulumi/pulumi-eks),
+and then deploys a Helm chart from the stable repo using the 
+`kubeconfig` credentials from the cluster's [Pulumi provider](https://www.pulumi.com/docs/intro/concepts/resources/providers/).
+
+```typescript
+import * as eks from "@pulumi/eks";
+import * as k8s from "@pulumi/kubernetes";
+
+// Create an EKS cluster.
+const cluster = new eks.Cluster("my-cluster");
+
+// Deploy Wordpress into our cluster.
+const wordpress = new k8s.helm.v3.Chart("wordpress", {
+    repo: "stable",
+    chart: "wordpress",
+    values: {
+        wordpressBlogName: "My Cool Kubernetes Blog!",
+    },
+}, { providers: { "kubernetes": cluster.provider } });
+
+// Export the cluster's kubeconfig.
+export const kubeconfig = cluster.kubeconfig;
+```
+
+### Deploying a Workload using the Resource API
+
+This example creates a EKS cluster with [`pulumi/eks`](https://github.com/pulumi/pulumi-eks),
+and then deploys an NGINX Deployment and Service using the SDK resource API, and the 
+`kubeconfig` credentials from the cluster's [Pulumi provider](https://www.pulumi.com/docs/intro/concepts/resources/providers/).
+
+```typescript
+import * as eks from "@pulumi/eks";
+import * as k8s from "@pulumi/kubernetes";
+
+// Create an EKS cluster with the default configuration.
+const cluster = new eks.Cluster("my-cluster");
+
+// Create a NGINX Deployment and Service.
+const appName = "my-app";
+const appLabels = { appClass: appName };
+const deployment = new k8s.apps.v1.Deployment(`${appName}-dep`, {
+    metadata: { labels: appLabels },
+    spec: {
+        replicas: 2,
+        selector: { matchLabels: appLabels },
+        template: {
+            metadata: { labels: appLabels },
+            spec: {
+                containers: [{
+                    name: appName,
+                    image: "nginx",
+                    ports: [{ name: "http", containerPort: 80 }]
+                }],
+            }
+        }
+    },
+}, { provider: cluster.provider });
+
+const service = new k8s.core.v1.Service(`${appName}-svc`, {
+    metadata: { labels: appLabels },
+    spec: {
+        type: "LoadBalancer",
+        ports: [{ port: 80, targetPort: "http" }],
+        selector: appLabels,
+    },
+}, { provider: cluster.provider });
+
+// Export the URL for the load balanced service.
+export const url = service.status.loadBalancer.ingress[0].hostname;
+
+// Export the cluster's kubeconfig.
+export const kubeconfig = cluster.kubeconfig;
+```
+
+## Contributing
+
+If you are interested in contributing, please see the [contributing docs][contributing].
+
+## Code of Conduct
+
+You can read the code of conduct [here][code-of-conduct].
+
+[pulumi-kubernetes]: https://github.com/pulumi/pulumi-kubernetes
+[contributing]: CONTRIBUTING.md
+[code-of-conduct]: CODE-OF-CONDUCT.md
+[workload-example]: #deploying-a-workload-on-aws-eks
+[how-pulumi-works]: https://www.pulumi.com/docs/intro/concepts/how-pulumi-works