80/TCP 6m47s
+```
+
+The assigned name for this particular nginx service is `nginx-9e5d5cd4`; yours will be different. In a new terminal window, run:
+
+```bash
+$ kubectl port-forward service/nginx-9e5d5cd4 8080:80
+Forwarding from 127.0.0.1:8080 -> 80
+Forwarding from [::1]:8080 -> 80
+```
+
+{{% /notes %}}
+
+You can curl NGINX to verify it is running:
+
+{{% choosable os "macos,linux" %}}
+
+```bash
+$ $(pulumi config get isMinikube) && curl "http://localhost:8080" || curl $(pulumi stack output ip)
+```
+
+{{% /choosable %}}
+
+{{% choosable os "windows" %}}
+
+```powershell
+> if (pulumi config get isMinikube) { curl "http://localhost:8080" } else { curl $(pulumi stack output ip) }
+```
+
+{{% /choosable %}}
+
+Expected output:
+
+```html
+
+
+
+Welcome to nginx!
+
+
+
+Welcome to nginx!
+If you see this page, the nginx web server is successfully installed and
+working. Further configuration is required.
+
+For online documentation and support please refer to
+nginx.org.
+Commercial support is available at
+nginx.com.
+
+Thank you for using nginx.
+
+
+```
+
+Once you are ready to move on, destroy everything you've provisioned in this tutorial.
+
+{{< get-started-stepper >}}
diff --git a/content/docs/iac/get-started/kubernetes/create-project.md b/content/docs/iac/get-started/kubernetes/create-project.md
index a10a8f541c45..33514cceb650 100644
--- a/content/docs/iac/get-started/kubernetes/create-project.md
+++ b/content/docs/iac/get-started/kubernetes/create-project.md
@@ -3,99 +3,173 @@ title_tag: Create a New Project | Kubernetes
meta_desc: This page provides an overview of how to create a new Kubernetes + Pulumi project.
title: Create project
h1: "Pulumi & Kubernetes: Create project"
-weight: 3
+weight: 4
menu:
iac:
name: Create project
identifier: kubernetes-get-started.create-project
parent: kubernetes-get-started
- weight: 3
+ weight: 4
aliases:
- /docs/quickstart/kubernetes/create-project/
+ - /docs/quickstart/kubernetes/review-project/
---
-Now that you have set up your environment let's create your first Pulumi program.
-{{< chooser language "typescript,python,go,csharp,java,yaml" / >}}
+## Create a new project
+
+A [**project**](/docs/iac/concepts/projects) is a program in your chosen language that defines a collection of related cloud resources. In this step, you will create a new project.
+
+### Initializing your project
+
+Each project lives in its own directory. Create a new one:
+
+{{% choosable os "linux,macos" %}}
+
+```bash
+$ mkdir quickstart
+```
+
+{{% /choosable %}}
+{{% choosable os "windows" %}}
+
+```powershell
+> mkdir quickstart
+```
+
+{{% /choosable %}}
+
+Change into the new directory:
+
+{{% choosable os "linux,macos" %}}
+
+```bash
+$ cd quickstart
+```
+
+{{% /choosable %}}
+{{% choosable os "windows" %}}
+
+```powershell
+> cd quickstart
+```
+
+{{% /choosable %}}
+
+Now initialize a new Pulumi project for Kubernetes using the `pulumi new` command:
{{% choosable language typescript %}}
+{{% choosable os "linux,macos" %}}
+
```bash
-$ mkdir quickstart && cd quickstart
$ pulumi new kubernetes-typescript
```
+{{% /choosable %}}
+{{% choosable os "windows" %}}
+
+```powershell
+> pulumi new kubernetes-typescript
+```
+
+{{% /choosable %}}
+
{{% /choosable %}}
{{% choosable language python %}}
+{{% choosable os "linux,macos" %}}
+
```bash
-$ mkdir quickstart && cd quickstart
$ pulumi new kubernetes-python
```
+{{% /choosable %}}
+{{% choosable os "windows" %}}
+
+```powershell
+> pulumi new kubernetes-python
+```
+
+{{% /choosable %}}
+
{{% /choosable %}}
{{% choosable language go %}}
+{{% choosable os "linux,macos" %}}
+
```bash
-$ mkdir quickstart && cd quickstart
$ pulumi new kubernetes-go
```
+{{% /choosable %}}
+{{% choosable os "windows" %}}
+
+```powershell
+> pulumi new kubernetes-go
+```
+
+{{% /choosable %}}
+
{{% /choosable %}}
{{% choosable language csharp %}}
+{{% choosable os "linux,macos" %}}
+
```bash
-$ mkdir quickstart && cd quickstart
$ pulumi new kubernetes-csharp
```
+{{% /choosable %}}
+{{% choosable os "windows" %}}
+
+```powershell
+> pulumi new kubernetes-csharp
+```
+
{{% /choosable %}}
+{{% /choosable %}}
{{% choosable language java %}}
+{{% choosable os "linux,macos" %}}
+
```bash
-$ mkdir quickstart && cd quickstart
$ pulumi new kubernetes-java
```
{{% /choosable %}}
+{{% choosable os "windows" %}}
-{{% choosable language yaml %}}
-
-```bash
-$ mkdir quickstart && cd quickstart
-$ pulumi new kubernetes-yaml
+```powershell
+> pulumi new kubernetes-java
```
{{% /choosable %}}
-{{< cli-note >}}
-
-After logging in, the CLI will proceed with walking you through creating a new project.
+{{% /choosable %}}
+{{% choosable language yaml %}}
-First, you will be asked for a **project name** and **project description**. Hit `ENTER` to accept the default values or specify new values.
+{{% choosable os "linux,macos" %}}
+```bash
+$ pulumi new kubernetes-yaml
```
-This command will walk you through creating a new Pulumi project.
-Enter a value or leave blank to accept the (default), and press .
-Press ^C at any time to quit.
+{{% /choosable %}}
+{{% choosable os "windows" %}}
-project name: (quickstart)
-project description: (A minimal Kubernetes Pulumi program)
-Created project 'quickstart'
+```powershell
+> pulumi new kubernetes-yaml
```
-Next, you will be asked for a **stack name**. You can hit `ENTER` to accept the default value of `dev`.
+{{% /choosable %}}
-```
-Please enter your desired stack name.
-To create a stack in an organization, use the format / (e.g. `acmecorp/dev`).
-stack name: (dev)
-Created stack 'dev'
-```
+{{% /choosable %}}
-> What are [projects](/docs/concepts/projects/) and [stacks](/docs/concepts/stack/)? Pulumi projects and stacks let you organize Pulumi code. Consider a Pulumi _project_ to be analogous to a GitHub repo---a single place for code---and a _stack_ to be an instance of that code with a separate configuration. For instance, _Project Foo_ may have multiple stacks for different development environments (Dev, Test, or Prod), or perhaps for different cloud configurations (geographic region for example). See [Organizing Projects and Stacks](/docs/using-pulumi/organizing-projects-stacks/) for some best practices on organizing your Pulumi projects and stacks.
+The `pulumi new` command interactively walks through initializing a new project, as well as creating a [**stack**](/docs/iac/concepts/stacks) and [**configuring**](/docs/iac/concepts/config) it. A stack is an instance of your project and you may have many of them -- like `dev`, `staging`, and `prod` -- each with different configuration settings.
+
+{{< cli-note >}}
{{% choosable language "typescript" %}}
@@ -133,6 +207,299 @@ After the command completes, the project and stack will be ready.
{{% /choosable %}}
-Next, we'll review the generated project files.
+### Review your new project's contents
+
+Review some of the generated project files:
+
+{{% choosable language "typescript,python,go,csharp,java" %}}
+
+- `Pulumi.yaml` defines the [project](/docs/concepts/projects/).
+
+{{% /choosable %}}
+
+{{% choosable language yaml %}}
+
+- `Pulumi.yaml` defines both the [project](/docs/concepts/projects/) and the program that manages your stack resources.
+
+{{% /choosable %}}
+
+- If present, `Pulumi.dev.yaml` would contain [configuration](/docs/concepts/config/) values for the [stack](/docs/concepts/stack/) we initialized. However, it's empty since this project doesn't require any configuration.
+
+{{% choosable language java %}}
+
+- `src/main/java/myproject` defines the project's Java package root.
+
+{{% /choosable %}}
+
+{{% choosable language python %}}
+
+- `__main__.py` is the Pulumi program that defines your stack resources.
+
+{{% /choosable %}}
+
+{{% choosable language "typescript,go,csharp,java" %}}
+
+- {{< langfile >}} is the Pulumi program that defines your stack resources.
+
+{{% /choosable %}}
+
+Examine {{< langfile >}}:
+
+{{< chooser language "typescript,python,go,csharp,java,yaml" / >}}
+
+{{% choosable language typescript %}}
+
+```typescript
+import * as k8s from "@pulumi/kubernetes";
+
+const appLabels = { app: "nginx" };
+const deployment = new k8s.apps.v1.Deployment("nginx", {
+ spec: {
+ selector: { matchLabels: appLabels },
+ replicas: 1,
+ template: {
+ metadata: { labels: appLabels },
+ spec: { containers: [{ name: "nginx", image: "nginx" }] }
+ }
+ }
+});
+export const name = deployment.metadata.name;
+```
+
+{{% /choosable %}}
+{{% choosable language python %}}
+
+```python
+"""A Kubernetes Python Pulumi program"""
+
+import pulumi
+from pulumi_kubernetes.apps.v1 import Deployment, DeploymentSpecArgs
+from pulumi_kubernetes.meta.v1 import LabelSelectorArgs, ObjectMetaArgs
+from pulumi_kubernetes.core.v1 import ContainerArgs, PodSpecArgs, PodTemplateSpecArgs
+
+app_labels = { "app": "nginx" }
+
+deployment = Deployment(
+ "nginx",
+ spec={
+ "selector": { "match_labels": app_labels },
+ "replicas": 1,
+ "template": {
+ "metadata": { "labels": app_labels },
+ "spec": { "containers": [{ "name": "nginx", "image": "nginx" }] }
+ },
+ })
+
+pulumi.export("name", deployment.metadata["name"])
+```
+
+{{% /choosable %}}
+{{% choosable language go %}}
+
+```go
+package main
+
+import (
+ appsv1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/apps/v1"
+ corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/core/v1"
+ metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/meta/v1"
+ "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
+)
+
+func main() {
+ pulumi.Run(func(ctx *pulumi.Context) error {
+
+ appLabels := pulumi.StringMap{
+ "app": pulumi.String("nginx"),
+ }
+ deployment, err := appsv1.NewDeployment(ctx, "app-dep", &appsv1.DeploymentArgs{
+ Spec: appsv1.DeploymentSpecArgs{
+ Selector: &metav1.LabelSelectorArgs{
+ MatchLabels: appLabels,
+ },
+ Replicas: pulumi.Int(1),
+ Template: &corev1.PodTemplateSpecArgs{
+ Metadata: &metav1.ObjectMetaArgs{
+ Labels: appLabels,
+ },
+ Spec: &corev1.PodSpecArgs{
+ Containers: corev1.ContainerArray{
+ corev1.ContainerArgs{
+ Name: pulumi.String("nginx"),
+ Image: pulumi.String("nginx"),
+ }},
+ },
+ },
+ },
+ })
+ if err != nil {
+ return err
+ }
+
+ ctx.Export("name", deployment.Metadata.Name())
+
+ return nil
+ })
+}
+
+```
+
+{{% /choosable %}}
+{{% choosable language csharp %}}
+
+```csharp
+using Pulumi;
+using Pulumi.Kubernetes.Types.Inputs.Core.V1;
+using Pulumi.Kubernetes.Types.Inputs.Apps.V1;
+using Pulumi.Kubernetes.Types.Inputs.Meta.V1;
+using System.Collections.Generic;
+
+return await Deployment.RunAsync(() =>
+{
+ var appLabels = new InputMap
+ {
+ { "app", "nginx" }
+ };
+
+ var deployment = new Pulumi.Kubernetes.Apps.V1.Deployment("nginx", new DeploymentArgs
+ {
+ Spec = new DeploymentSpecArgs
+ {
+ Selector = new LabelSelectorArgs
+ {
+ MatchLabels = appLabels
+ },
+ Replicas = 1,
+ Template = new PodTemplateSpecArgs
+ {
+ Metadata = new ObjectMetaArgs
+ {
+ Labels = appLabels
+ },
+ Spec = new PodSpecArgs
+ {
+ Containers =
+ {
+ new ContainerArgs
+ {
+ Name = "nginx",
+ Image = "nginx",
+ Ports =
+ {
+ new ContainerPortArgs
+ {
+ ContainerPortValue = 80
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ });
+
+ // export the deployment name
+ return new Dictionary
+ {
+ ["name"] = deployment.Metadata.Apply(m => m.Name)
+ };
+});
+```
+
+{{% /choosable %}}
+
+{{% choosable language java %}}
+
+```java
+package myproject;
+
+import com.pulumi.Pulumi;
+import com.pulumi.kubernetes.apps.v1.Deployment;
+import com.pulumi.kubernetes.apps.v1.DeploymentArgs;
+import com.pulumi.kubernetes.apps.v1.inputs.DeploymentSpecArgs;
+import com.pulumi.kubernetes.core.v1.inputs.ContainerArgs;
+import com.pulumi.kubernetes.core.v1.inputs.ContainerPortArgs;
+import com.pulumi.kubernetes.core.v1.inputs.PodSpecArgs;
+import com.pulumi.kubernetes.core.v1.inputs.PodTemplateSpecArgs;
+import com.pulumi.kubernetes.meta.v1.inputs.LabelSelectorArgs;
+import com.pulumi.kubernetes.meta.v1.inputs.ObjectMetaArgs;
+
+import java.util.Map;
+
+public class App {
+ public static void main(String[] args) {
+ Pulumi.run(ctx -> {
+ var labels = Map.of("app", "nginx");
+
+ var deployment = new Deployment("nginx", DeploymentArgs.builder()
+ .spec(DeploymentSpecArgs.builder()
+ .selector(LabelSelectorArgs.builder()
+ .matchLabels(labels)
+ .build())
+ .replicas(1)
+ .template(PodTemplateSpecArgs.builder()
+ .metadata(ObjectMetaArgs.builder()
+ .labels(labels)
+ .build())
+ .spec(PodSpecArgs.builder()
+ .containers(ContainerArgs.builder()
+ .name("nginx")
+ .image("nginx")
+ .ports(ContainerPortArgs.builder()
+ .containerPort(80)
+ .build())
+ .build())
+ .build())
+ .build())
+
+ .build())
+ .build());
+
+ var name = deployment.metadata()
+ .applyValue(m -> m.orElseThrow().name().orElse(""));
+
+ ctx.export("name", name);
+ });
+ }
+}
+```
+
+{{% /choosable %}}
+
+{{% choosable language yaml %}}
+
+```yaml
+name: quickstart
+runtime: yaml
+description: A minimal Kubernetes Pulumi YAML program
+
+variables:
+ appLabels:
+ app: nginx
+
+resources:
+ deployment:
+ name: nginx
+ type: kubernetes:apps/v1:Deployment
+ properties:
+ spec:
+ selector:
+ matchLabels: ${appLabels}
+ replicas: 1
+ template:
+ metadata:
+ labels: ${appLabels}
+ spec:
+ containers:
+ - name: nginx
+ image: nginx
+
+outputs:
+ name: ${deployment.metadata.name}
+```
+
+{{% /choosable %}}
+
+This Pulumi program creates an NGINX deployment and exports the name of the deployment.
{{< get-started-stepper >}}
diff --git a/content/docs/iac/get-started/kubernetes/deploy-changes.md b/content/docs/iac/get-started/kubernetes/deploy-changes.md
deleted file mode 100644
index 73e191004351..000000000000
--- a/content/docs/iac/get-started/kubernetes/deploy-changes.md
+++ /dev/null
@@ -1,122 +0,0 @@
----
-title_tag: Deploy the Changes | Kubernetes
-meta_desc: This page provides an overview of how deploy changes to a Kubernetes project.
-title: Deploy changes
-h1: "Pulumi & Kubernetes: Deploy changes"
-weight: 7
-menu:
- iac:
- name: Deploy changes
- identifier: kubernetes-get-started.deploy-changes
- parent: kubernetes-get-started
- weight: 7
-
-aliases:
- - /docs/quickstart/kubernetes/deploy-changes/
----
-
-Deploy the stack changes.
-
-```bash
-$ pulumi up
-```
-
-Pulumi computes the minimally disruptive change to achieve the desired state described by the program.
-
-```
-Previewing update (dev):
- Type Name Plan
- pulumi:pulumi:Stack quickstart-dev
- + └─ kubernetes:core/v1:Service nginx create
-
-Outputs:
- + ip : "10.96.0.0"
- - name: "nginx-bec13562"
-
-Resources:
- + 1 to create
- 2 unchanged
-
-Do you want to perform this update? [Use arrows to move, type to filter]
-> yes
- no
- details
-```
-
-Select `yes` using the arrows and hit enter to update the resources in Kubernetes.
-
-Pulumi will create the service since it is now defined in the program.
-
-```
-Do you want to perform this update? yes
-Updating (dev):
- Type Name Status
- pulumi:pulumi:Stack quickstart-dev
- + └─ kubernetes:core/v1:Service nginx created (10s)
-
-Outputs:
- + ip : "10.110.183.208"
- - name: "nginx-bec13562"
-
-Resources:
- + 1 created
- 2 unchanged
-
-Duration: 12s
-```
-
-View the `ip` [stack output](/docs/concepts/stack#outputs) from the nginx service.
-
-```bash
-$ pulumi stack output ip
-```
-
-> **If using Minikube:** Minikube does not support type `LoadBalancer`. Instead, forward the nginx service:
->
-> ```bash
-> $ kubectl get service
-> NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
-> kubernetes ClusterIP 10.96.0.1 443/TCP 44h
-> nginx-9e5d5cd4 ClusterIP 10.103.199.118 80/TCP 6m47s
-> ```
->
-> Note: The assigned name for this particular nginx service is `nginx-9e5d5cd4`; yours will be different. In a new terminal window, run:
->
-> ```bash
-> $ kubectl port-forward service/nginx-9e5d5cd4 8080:80
-> Forwarding from 127.0.0.1:8080 -> 80
-> Forwarding from [::1]:8080 -> 80
-> ```
-
-Curl nginx to verify it is running.
-
-```bash
-$ $(pulumi config get isMinikube) && curl "http://localhost:8080" || curl $(pulumi stack output ip)
-
-
-
-Welcome to nginx!
-
-
-
-Welcome to nginx!
-If you see this page, the nginx web server is successfully installed and
-working. Further configuration is required.
-
-For online documentation and support please refer to
-nginx.org.
-Commercial support is available at
-nginx.com.
-
-Thank you for using nginx.
-
-
-```
-
-Next, we'll destroy the stack.
-
-{{< get-started-stepper >}}
diff --git a/content/docs/iac/get-started/kubernetes/deploy-stack.md b/content/docs/iac/get-started/kubernetes/deploy-stack.md
index 289e273bb99f..4ece3588e0d1 100644
--- a/content/docs/iac/get-started/kubernetes/deploy-stack.md
+++ b/content/docs/iac/get-started/kubernetes/deploy-stack.md
@@ -1,12 +1,12 @@
---
title_tag: Deploy the Stack | Kubernetes
-meta_desc: This page provides an overview of how to deploy a Kubernetes project as a Pulumi Stack.
-title: Deploy stack
-h1: "Pulumi & Kubernetes: Deploy stack"
+meta_desc: Learn how to deploy your stack to a Kubernetes project in this guide.
+title: Deploy to Kubernetes
+h1: "Get started with Pulumi and Kubernetes"
weight: 5
menu:
iac:
- name: Deploy stack
+ name: Deploy
identifier: kubernetes-get-started.deploy-stack
parent: kubernetes-get-started
weight: 5
@@ -15,38 +15,53 @@ aliases:
- /docs/quickstart/kubernetes/deploy-stack/
---
-Deploy the stack:
+## Deploy to Kubernetes
+
+Now run `pulumi up` to start deploying your NGINX deployment:
+
+{{% choosable "os" "macos,linux" %}}
```bash
$ pulumi up
```
-This command instructs Pulumi to determine the resources needed to create the stack. A preview is shown of the changes that will be made:
+{{% /choosable %}}
+{{% choosable "os" "windows" %}}
-```bash
-Previewing update (dev)
+```powershell
+> pulumi up
+```
+
+{{% /choosable %}}
+
+This command first shows you a **preview** of the changes that will be made:
+
+```
+Previewing update (dev):
Type Name Plan
+ pulumi:pulumi:Stack quickstart-dev create
+ └─ kubernetes:apps/v1:Deployment nginx create
-Outputs:
- name: "nginx-516e16fd"
-
Resources:
+ 2 to create
-Do you want to perform this update? [Use arrows to move, type to filter]
+Do you want to perform this update?
> yes
no
details
```
-Select `yes` using the arrows and hit enter to create the resources in Kubernetes.
+No changes have been made yet. You may decline to proceed by selecting `no` or choose `details` to see more information about the proposed update like your deployment's properties.
-```bash
+### Performing the update
+
+To proceed and deploy your NGINX deployment, select `yes`. This begins an **update**:
+
+```
Do you want to perform this update? yes
Updating (dev):
+
Type Name Status
+ pulumi:pulumi:Stack quickstart-dev created (3s)
+ └─ kubernetes:apps/v1:Deployment nginx created (2s)
@@ -60,16 +75,30 @@ Resources:
Duration: 4s
```
-The `name` of the deployment that we exported is shown as a [stack output](/docs/concepts/stack#outputs).
+Updates can take some time since they wait for the Kubernetes resources to finish being created. The deployment will finish in just a few seconds.
{{< auto-naming-note resource="deployment" suffix="bec13562" >}}
-{{< console-note >}}
+{{% notes type="warning" %}}
+If you get the error `configured Kubernetes cluster is unreachable` or
+`unable to load schema information from the API server`, verify your cluster access:
-{{% notes type="info" %}}
-If you get the error `configured Kubernetes cluster is unreachable: unable to load schema information from the API server: the server has asked for the client to provide credentials`, you may need to configure valid AWS credentials.
+1. Check your kubeconfig: `kubectl config view`
+2. Test cluster connectivity: `kubectl cluster-info`
+3. Verify authentication: `kubectl auth can-i get pods`
+
+If these commands fail, return to the [Configure access](/docs/iac/get-started/kubernetes/configure/)
+step to set up your Kubernetes cluster and kubectl.
{{% /notes %}}
-Next, we'll make some modifications to the program.
+### View your update on Pulumi Cloud
+
+If you are logged into [Pulumi Cloud](/docs/pulumi-cloud), you'll see "View Live" hyperlinks in the CLI output during your update. These go to [a page](https://app.pulumi.com) with detailed information about your stack including resources, configuration, a full history of updates, and more. Navigate to it to review the details of your update:
+
+
+ 
+
+
+Now that the NGINX deployment has been provisioned, you'll update it to do something more interesting.
{{< get-started-stepper >}}
diff --git a/content/docs/iac/get-started/kubernetes/destroy-stack.md b/content/docs/iac/get-started/kubernetes/destroy-stack.md
index c936bb638226..b331a6802e76 100644
--- a/content/docs/iac/get-started/kubernetes/destroy-stack.md
+++ b/content/docs/iac/get-started/kubernetes/destroy-stack.md
@@ -2,11 +2,11 @@
title_tag: Destroy the Stack | Kubernetes
meta_desc: This page provides an overview of how to destroy a Pulumi stack of a Kubernetes project.
title: Destroy stack
-h1: "Pulumi & Kubernetes: Destroy stack"
+h1: "Get started with Pulumi and Kubernetes"
weight: 8
menu:
iac:
- name: Destroy stack
+ name: Cleanup & destroy
identifier: kubernetes-get-started.destroy-stack
parent: kubernetes-get-started
weight: 8
@@ -15,28 +15,44 @@ aliases:
- /docs/quickstart/kubernetes/destroy-stack/
---
-Now that we've seen how to deploy changes to our program, let's clean up and tear down the resources that are part of our stack.
+## Cleanup & destroy the stack
-To destroy resources, run the following:
+Our final step is to clean up all of the resources we've allocated in this tutorial.
+
+Run the `pulumi destroy` command to delete all cloud resources in this project/stack:
+
+{{% choosable os "linux,macos" %}}
```bash
$ pulumi destroy
```
-You'll be prompted to make sure you really want to delete these resources.
+{{% /choosable %}}
+
+{{% choosable os "windows" %}}
+
+```powershell
+> pulumi destroy
+```
+
+{{% /choosable %}}
+
+Just like `pulumi up`, you'll be shown a preview to ensure that you want to proceed:
```bash
Previewing destroy (dev):
- Type Name Plan
- - pulumi:pulumi:Stack quickstart-dev delete
- - ├─ kubernetes:core/v1:Service nginx delete
- - └─ kubernetes:apps/v1:Deployment nginx delete
+
+ Type Name Plan
+ - pulumi:pulumi:Stack quickstart-dev delete
+ - └─ quickstart:index:KubernetesNginxService my-nginx delete
+ - ├─ kubernetes:core/v1:Service nginx delete
+ - └─ kubernetes:apps/v1:Deployment nginx delete
Outputs:
- - ip: "10.110.183.208"
+ - ip: "172.183.217.156"
Resources:
- - 3 to delete
+ - 4 to delete
Do you want to perform this destroy? [Use arrows to move, type to filter]
> yes
@@ -44,44 +60,50 @@ Do you want to perform this destroy? [Use arrows to move, type to filter]
details
```
-Select `yes` using the arrows and hit enter to delete the resources in Kubernetes.
+As with an update, we can choose `no` or `details`; select `yes` to proceed:
-```bash
+```
Do you want to perform this destroy? yes
-Destroying (dev):
- Type Name Status
- - pulumi:pulumi:Stack quickstart-dev deleted (0.00s)
- - ├─ kubernetes:core/v1:Service nginx deleted (0.94s)
- - └─ kubernetes:apps/v1:Deployment nginx deleted (4s)
+Destroying (dev)
+
+ Type Name Status
+ - pulumi:pulumi:Stack quickstart-dev deleted (0.08s)
+ - └─ quickstart:index:KubernetesNginxService my-nginx deleted (0.08s)
+ - ├─ kubernetes:core/v1:Service nginx deleted (16s)
+ - └─ kubernetes:apps/v1:Deployment nginx deleted (0.59s)
Outputs:
- - ip: "10.110.183.208"
+ - ip: "172.183.217.156"
Resources:
- - 3 deleted
+ - 4 deleted
-Duration: 6s
-
-The resources in the stack have been deleted, but the history and configuration associated with the stack are still maintained.
-If you want to remove the stack completely, run `pulumi stack rm dev`.
+Duration: 18s
```
-To delete the stack itself, run [`pulumi stack rm`](/docs/cli/commands/pulumi_stack_rm). Note that this removes the stack
-entirely from Pulumi Cloud, along with all of its update history.
+At this stage, your stack still exists, but all cloud resources have been deleted from it.
+
+## Remove the stack
+
+The final step is to remove the stack itself. Destroy keeps the stack around so that you still have the full
+history of what happened to the stack. Running [`pulumi stack rm`](/docs/cli/commands/pulumi_stack_rm) will
+delete it entirely, including all history and state snapshots. Be careful, this step cannot be undone!
+
+{{% choosable "os" "macos,linux" %}}
```bash
$ pulumi stack rm
-This will permanently remove the 'dev' stack!
-Please confirm that this is what you`d like to do by typing `dev`:
```
-Type `dev` and hit enter to remove the stack.
+{{% /choosable %}}
+{{% choosable "os" "windows" %}}
-```bash
-Please confirm that this is what you`d like to do by typing `dev`: dev
-Stack 'dev' has been removed!
+```powershell
+> pulumi stack rm
```
-Next, we'll look at some next steps.
+{{% /choosable %}}
+
+You'll be prompted to confirm the removal. Confirm it to successfully complete this tutorial.
{{< get-started-stepper >}}
diff --git a/content/docs/iac/get-started/kubernetes/modify-program.md b/content/docs/iac/get-started/kubernetes/modify-program.md
index 3e2b5a2955fd..fe4c54c80e9c 100644
--- a/content/docs/iac/get-started/kubernetes/modify-program.md
+++ b/content/docs/iac/get-started/kubernetes/modify-program.md
@@ -1,21 +1,22 @@
---
-title_tag: Modify the Program | Kubernetes
-meta_desc: This page provides an overview on how to update Kubernetes project from a Pulumi program.
-title: Modify program
-h1: "Pulumi & Kubernetes: Modify program"
+title_tag: Make an Update | Kubernetes
+meta_desc: This page provides an overview on how to update a Kubernetes project from a Pulumi program.
+title: Make an update
+h1: "Get started with Pulumi and Kubernetes"
weight: 6
menu:
iac:
- name: Modify program
+ name: Make an update
identifier: kubernetes-get-started.modify-program
parent: kubernetes-get-started
weight: 6
aliases:
- /docs/quickstart/kubernetes/modify-program/
+ - /docs/quickstart/kubernetes/deploy-changes/
---
-Now that we have an instance of our Pulumi program deployed, let's update it to do something a little more interesting.
+Now that you have an instance of your Pulumi program deployed, update it to do something a little more interesting.
Replace the entire contents of {{< langfile >}} with the following:
@@ -328,15 +329,15 @@ package myproject;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
-import com.pulumi.kubernetes.apps_v1.Deployment;
-import com.pulumi.kubernetes.apps_v1.DeploymentArgs;
-import com.pulumi.kubernetes.apps_v1.inputs.DeploymentSpecArgs;
-import com.pulumi.kubernetes.core_v1.*;
-import com.pulumi.kubernetes.core_v1.ServiceArgs;
-import com.pulumi.kubernetes.core_v1.enums.ServiceSpecType;
-import com.pulumi.kubernetes.core_v1.inputs.*;
-import com.pulumi.kubernetes.meta_v1.inputs.LabelSelectorArgs;
-import com.pulumi.kubernetes.meta_v1.inputs.ObjectMetaArgs;
+import com.pulumi.kubernetes.apps.v1.Deployment;
+import com.pulumi.kubernetes.apps.v1.DeploymentArgs;
+import com.pulumi.kubernetes.apps.v1.inputs.DeploymentSpecArgs;
+import com.pulumi.kubernetes.core.v1.*;
+import com.pulumi.kubernetes.core.v1.ServiceArgs;
+import com.pulumi.kubernetes.core.v1.enums.ServiceSpecType;
+import com.pulumi.kubernetes.core.v1.inputs.*;
+import com.pulumi.kubernetes.meta.v1.inputs.LabelSelectorArgs;
+import com.pulumi.kubernetes.meta.v1.inputs.ObjectMetaArgs;
import java.util.Map;
public class App {
@@ -369,12 +370,9 @@ public class App {
.build())
.build());
- var name = deployment.metadata()
- .applyValue(m -> m.orElseThrow().name().orElse(""));
-
var frontend = new Service("nginx", ServiceArgs.builder()
.metadata(ObjectMetaArgs.builder()
- .labels(deployment.spec().applyValue(spec -> spec.get().template().metadata().get().labels()))
+ .labels(labels)
.build())
.spec(ServiceSpecArgs.builder()
.type(isMinikube ? ServiceSpecType.ClusterIP : ServiceSpecType.LoadBalancer)
@@ -387,15 +385,8 @@ public class App {
.build())
.build());
- ctx.export("ip", isMinikube
- ? frontend.spec().applyValue(spec -> spec.get().clusterIP())
- : Output.tuple(frontend.status(), frontend.spec()).applyValue(t -> {
- var status = t.t1;
- var spec = t.t2;
- var ingress = status.get().loadBalancer().get().ingress().get(0);
- return ingress.ip().orElse(ingress.hostname().orElse(spec.get().clusterIP().get()));
- })
- );
+ // Export the service cluster IP (available for both ClusterIP and LoadBalancer types)
+ ctx.export("ip", frontend.spec().applyValue(spec -> spec.clusterIP().orElse("pending")));
});
}
}
@@ -458,6 +449,151 @@ If you are currently using Minikube, set `isMinikube` to `true`, otherwise, set
$ pulumi config set isMinikube false
```
-Next, we'll deploy the changes.
+### Deploy the changes
+
+To deploy the changes, run `pulumi up` again:
+
+{{% choosable "os" "macos,linux" %}}
+
+```bash
+$ pulumi up
+```
+
+{{% /choosable %}}
+{{% choosable "os" "windows" %}}
+
+```powershell
+> pulumi up
+```
+
+{{% /choosable %}}
+
+Pulumi computes the minimally disruptive change to achieve the desired state described by the program.
+
+```
+Previewing update (dev):
+ Type Name Plan
+ pulumi:pulumi:Stack quickstart-dev
+ + └─ kubernetes:core/v1:Service nginx create
+
+Outputs:
+ + ip : "10.96.0.0"
+ - name: "nginx-bec13562"
+
+Resources:
+ + 1 to create
+ 2 unchanged
+
+Do you want to perform this update?
+> yes
+ no
+ details
+```
+
+Select `yes` to proceed. Pulumi will create the new service resource:
+
+```
+Do you want to perform this update? yes
+Updating (dev):
+ Type Name Status
+ pulumi:pulumi:Stack quickstart-dev
+ + └─ kubernetes:core/v1:Service nginx created (10s)
+
+Outputs:
+ + ip : "10.110.183.208"
+ - name: "nginx-bec13562"
+
+Resources:
+ + 1 created
+ 2 unchanged
+
+Duration: 12s
+```
+
+### Verify the deployment
+
+View the `ip` [stack output](/docs/concepts/stack#outputs) from the NGINX service:
+
+{{% choosable "os" "macos,linux" %}}
+
+```bash
+$ pulumi stack output ip
+```
+
+{{% /choosable %}}
+{{% choosable "os" "windows" %}}
+
+```powershell
+> pulumi stack output ip
+```
+
+{{% /choosable %}}
+
+{{% notes type="info" %}}
+**If using Minikube:** Minikube does not support type `LoadBalancer`. Instead, forward the NGINX service:
+
+```bash
+$ kubectl get service
+NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
+kubernetes ClusterIP 10.96.0.1 443/TCP 44h
+nginx-9e5d5cd4 ClusterIP 10.103.199.118 80/TCP 6m47s
+```
+
+The assigned name for this particular nginx service is `nginx-9e5d5cd4`; yours will be different. In a new terminal window, run:
+
+```bash
+$ kubectl port-forward service/nginx-9e5d5cd4 8080:80
+Forwarding from 127.0.0.1:8080 -> 80
+Forwarding from [::1]:8080 -> 80
+```
+
+{{% /notes %}}
+
+You can curl NGINX to verify it is running:
+
+{{% choosable "os" "macos,linux" %}}
+
+```bash
+$ $(pulumi config get isMinikube) && curl "http://localhost:8080" || curl $(pulumi stack output ip)
+```
+
+{{% /choosable %}}
+{{% choosable "os" "windows" %}}
+
+```powershell
+> if (pulumi config get isMinikube) { curl "http://localhost:8080" } else { curl $(pulumi stack output ip) }
+```
+
+{{% /choosable %}}
+
+Expected output:
+
+```html
+
+
+
+Welcome to nginx!
+
+
+
+Welcome to nginx!
+If you see this page, the nginx web server is successfully installed and
+working. Further configuration is required.
+
+For online documentation and support please refer to
+nginx.org.
+Commercial support is available at
+nginx.com.
+
+Thank you for using nginx.
+
+
+```
+
+Now that you have successfully updated your stack, you'll destroy the resources.
{{< get-started-stepper >}}
diff --git a/content/docs/iac/get-started/kubernetes/review-project.md b/content/docs/iac/get-started/kubernetes/review-project.md
deleted file mode 100644
index 60e73ad5cd54..000000000000
--- a/content/docs/iac/get-started/kubernetes/review-project.md
+++ /dev/null
@@ -1,313 +0,0 @@
----
-title_tag: Review the New Project | Kubernetes
-meta_desc: This page provides an overview on how to review a new Kubernetes project.
-title: Review project
-h1: "Pulumi & Kubernetes: Review project"
-weight: 4
-menu:
- iac:
- name: Review project
- identifier: kubernetes-get-started.review-project
- parent: kubernetes-get-started
- weight: 4
-
-aliases:
- - /docs/quickstart/kubernetes/review-project/
----
-
-Let's review some of the generated project files:
-
-{{% choosable language "typescript,python,go,csharp,java" %}}
-
-- `Pulumi.yaml` defines the [project](/docs/concepts/projects/).
-
-{{% /choosable %}}
-
-{{% choosable language yaml %}}
-
-- `Pulumi.yaml` defines both the [project](/docs/concepts/projects/) and the program that manages your stack resources.
-
-{{% /choosable %}}
-
-- `Pulumi.dev.yaml` contains [configuration](/docs/concepts/config/) values for the [stack](/docs/concepts/stack/) we initialized.
-
-{{% choosable language java %}}
-
-- `src/main/java/myproject` defines the project's Java package root.
-
-{{% /choosable %}}
-
-{{% choosable language python %}}
-
-- `__main__.py` is the Pulumi program that defines your stack resources.
-
-{{% /choosable %}}
-
-{{% choosable language "typescript,go,csharp,java" %}}
-
-- {{< langfile >}} is the Pulumi program that defines your stack resources.
-
-{{% /choosable %}}
-
-Let's examine {{< langfile >}}.
-
-{{< chooser language "typescript,python,go,csharp,java,yaml" / >}}
-
-{{% choosable language typescript %}}
-
-```typescript
-import * as k8s from "@pulumi/kubernetes";
-
-const appLabels = { app: "nginx" };
-const deployment = new k8s.apps.v1.Deployment("nginx", {
- spec: {
- selector: { matchLabels: appLabels },
- replicas: 1,
- template: {
- metadata: { labels: appLabels },
- spec: { containers: [{ name: "nginx", image: "nginx" }] }
- }
- }
-});
-export const name = deployment.metadata.name;
-```
-
-{{% /choosable %}}
-{{% choosable language python %}}
-
-```python
-"""A Kubernetes Python Pulumi program"""
-
-import pulumi
-from pulumi_kubernetes.apps.v1 import Deployment, DeploymentSpecArgs
-from pulumi_kubernetes.meta.v1 import LabelSelectorArgs, ObjectMetaArgs
-from pulumi_kubernetes.core.v1 import ContainerArgs, PodSpecArgs, PodTemplateSpecArgs
-
-app_labels = { "app": "nginx" }
-
-deployment = Deployment(
- "nginx",
- spec={
- "selector": { "match_labels": app_labels },
- "replicas": 1,
- "template": {
- "metadata": { "labels": app_labels },
- "spec": { "containers": [{ "name": "nginx", "image": "nginx" }] }
- },
- })
-
-pulumi.export("name", deployment.metadata["name"])
-```
-
-{{% /choosable %}}
-{{% choosable language go %}}
-
-```go
-package main
-
-import (
- appsv1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/apps/v1"
- corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/core/v1"
- metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/meta/v1"
- "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
-)
-
-func main() {
- pulumi.Run(func(ctx *pulumi.Context) error {
-
- appLabels := pulumi.StringMap{
- "app": pulumi.String("nginx"),
- }
- deployment, err := appsv1.NewDeployment(ctx, "app-dep", &appsv1.DeploymentArgs{
- Spec: appsv1.DeploymentSpecArgs{
- Selector: &metav1.LabelSelectorArgs{
- MatchLabels: appLabels,
- },
- Replicas: pulumi.Int(1),
- Template: &corev1.PodTemplateSpecArgs{
- Metadata: &metav1.ObjectMetaArgs{
- Labels: appLabels,
- },
- Spec: &corev1.PodSpecArgs{
- Containers: corev1.ContainerArray{
- corev1.ContainerArgs{
- Name: pulumi.String("nginx"),
- Image: pulumi.String("nginx"),
- }},
- },
- },
- },
- })
- if err != nil {
- return err
- }
-
- ctx.Export("name", deployment.Metadata.Name())
-
- return nil
- })
-}
-
-```
-
-{{% /choosable %}}
-{{% choosable language csharp %}}
-
-```csharp
-using Pulumi;
-using Pulumi.Kubernetes.Types.Inputs.Core.V1;
-using Pulumi.Kubernetes.Types.Inputs.Apps.V1;
-using Pulumi.Kubernetes.Types.Inputs.Meta.V1;
-using System.Collections.Generic;
-
-return await Deployment.RunAsync(() =>
-{
- var appLabels = new InputMap
- {
- { "app", "nginx" }
- };
-
- var deployment = new Pulumi.Kubernetes.Apps.V1.Deployment("nginx", new DeploymentArgs
- {
- Spec = new DeploymentSpecArgs
- {
- Selector = new LabelSelectorArgs
- {
- MatchLabels = appLabels
- },
- Replicas = 1,
- Template = new PodTemplateSpecArgs
- {
- Metadata = new ObjectMetaArgs
- {
- Labels = appLabels
- },
- Spec = new PodSpecArgs
- {
- Containers =
- {
- new ContainerArgs
- {
- Name = "nginx",
- Image = "nginx",
- Ports =
- {
- new ContainerPortArgs
- {
- ContainerPortValue = 80
- }
- }
- }
- }
- }
- }
- }
- });
-
- // export the deployment name
- return new Dictionary
- {
- ["name"] = deployment.Metadata.Apply(m => m.Name)
- };
-});
-```
-
-{{% /choosable %}}
-
-{{% choosable language java %}}
-
-```java
-package myproject;
-
-import com.pulumi.Pulumi;
-import com.pulumi.kubernetes.apps_v1.Deployment;
-import com.pulumi.kubernetes.apps_v1.DeploymentArgs;
-import com.pulumi.kubernetes.apps_v1.inputs.DeploymentSpecArgs;
-import com.pulumi.kubernetes.core_v1.inputs.ContainerArgs;
-import com.pulumi.kubernetes.core_v1.inputs.ContainerPortArgs;
-import com.pulumi.kubernetes.core_v1.inputs.PodSpecArgs;
-import com.pulumi.kubernetes.core_v1.inputs.PodTemplateSpecArgs;
-import com.pulumi.kubernetes.meta_v1.inputs.LabelSelectorArgs;
-import com.pulumi.kubernetes.meta_v1.inputs.ObjectMetaArgs;
-
-import java.util.Map;
-
-public class App {
- public static void main(String[] args) {
- Pulumi.run(ctx -> {
- var labels = Map.of("app", "nginx");
-
- var deployment = new Deployment("nginx", DeploymentArgs.builder()
- .spec(DeploymentSpecArgs.builder()
- .selector(LabelSelectorArgs.builder()
- .matchLabels(labels)
- .build())
- .replicas(1)
- .template(PodTemplateSpecArgs.builder()
- .metadata(ObjectMetaArgs.builder()
- .labels(labels)
- .build())
- .spec(PodSpecArgs.builder()
- .containers(ContainerArgs.builder()
- .name("nginx")
- .image("nginx")
- .ports(ContainerPortArgs.builder()
- .containerPort(80)
- .build())
- .build())
- .build())
- .build())
-
- .build())
- .build());
-
- var name = deployment.metadata()
- .applyValue(m -> m.orElseThrow().name().orElse(""));
-
- ctx.export("name", name);
- });
- }
-}
-```
-
-{{% /choosable %}}
-
-{{% choosable language yaml %}}
-
-```yaml
-name: quickstart
-runtime: yaml
-description: A minimal Kubernetes Pulumi YAML program
-
-variables:
- appLabels:
- app: nginx
-
-resources:
- deployment:
- name: nginx
- type: kubernetes:apps/v1:Deployment
- properties:
- spec:
- selector:
- matchLabels: ${appLabels}
- replicas: 1
- template:
- metadata:
- labels: ${appLabels}
- spec:
- containers:
- - name: nginx
- image: nginx
-
-outputs:
- name: ${deployment.metadata.name}
-```
-
-{{% /choosable %}}
-
-This Pulumi program creates an NGINX deployment and exports the name of the deployment.
-
-Next, we'll deploy the stack.
-
-{{< get-started-stepper >}}
diff --git a/layouts/shortcodes/get-started-install-body.html b/layouts/shortcodes/get-started-install-body.html
new file mode 100644
index 000000000000..11bff9d7ac37
--- /dev/null
+++ b/layouts/shortcodes/get-started-install-body.html
@@ -0,0 +1,5 @@
+Install Pulumi
+
+Download and install Pulumi for your platform:
+
+{{ .Page.RenderString "{{< install-pulumi >}}\n{{% notes info %}}\nAll Windows examples in this tutorial assume you are running in PowerShell.\n{{% /notes %}}\n{{< /install-pulumi >}}" }}
diff --git a/static/images/getting-started/console-update.png b/static/images/getting-started/console-update.png
index 3cd4b0c6a4bc..00ecfde1d68c 100644
Binary files a/static/images/getting-started/console-update.png and b/static/images/getting-started/console-update.png differ