Skip to content
This repository has been archived by the owner on Jul 1, 2024. It is now read-only.

Commit

Permalink
Updating docs for 3.0 release (#57)
Browse files Browse the repository at this point in the history
Co-authored-by: Dave Wrede <[email protected]>
  • Loading branch information
stack72 and Dave Wrede authored Apr 19, 2021
1 parent d95e762 commit 3431f32
Show file tree
Hide file tree
Showing 90 changed files with 289 additions and 280 deletions.
4 changes: 2 additions & 2 deletions themes/default/content/docs/get-started/aws/review-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ pulumi.export('bucket_name', bucket.id)
package main

import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ package main
import (
"github.com/pulumi/pulumi-azure-native/sdk/go/azure/resources"
"github.com/pulumi/pulumi-azure-native/sdk/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions themes/default/content/docs/get-started/gcp/review-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ pulumi.export('bucket_name', bucket.url)
package main

import (
"github.com/pulumi/pulumi-gcp/sdk/v4/go/gcp/storage"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
Expand Down
41 changes: 24 additions & 17 deletions themes/default/content/docs/get-started/install/migrating-3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ meta_desc: This page provides instructions for upgrading to Pulumi 3.0
no_on_this_page: true
---

Pulumi 3.0 is currently in rc. If you'd like to try the rc and provide feedback, it's simple to upgrade:
Pulumi 3.0 is generally available. It’s simple to upgrade:

1. [Install the 3.0 CLI]({{< relref "/docs/get-started/install#installing-betas-and-previous-versions" >}})
2. Take note of the updated CLI behaviors listed below
3. Update each of your Pulumi programs to utilize the new version of the SDK
1. [Install or upgrade to the 3.0 CLI]({{< relref "/docs/get-started/install" >}}).
2. Review the updated CLI behaviors listed below.
3. Update each of your Pulumi programs to utilize the new version of the SDK.

## Updated CLI behavior in Pulumi 3.0

Expand All @@ -35,7 +35,7 @@ Previously, when using the `--stack` option on CLI commands, Pulumi would incons
### Update to the new SDK version

```bash
npm install @pulumi/pulumi@^3.0.0-rc
npm install @pulumi/pulumi@^3.0.0
```

### Changes to pulumi.runtime.Mocks
Expand Down Expand Up @@ -153,8 +153,8 @@ pulumi.runtime.setMocks({
Modify your `requirements.txt` file to update the Pulumi SDK and any providers you use, like this:

```
pulumi>=3.0.0rc,<4.0.0
pulumi-aws>=4.0.0rc,<5.0.0
pulumi>=3.0.0,<4.0.0
pulumi-aws>=4.0.0,<5.0.0
```

Then run `pip install`:
Expand Down Expand Up @@ -185,7 +185,7 @@ export("ip", instance.network_interfaces[0].access_configs[0].nat_ip)

### Changes to pulumi.runtime.Mocks

The signature of the `setMocks` function has changed with the introduction of the `pulumi.runtime.MockResourceArgs` and `pulumi.runtime.MockCallArgs` types. If you use `setMocks` in your code, you'll need to update to these new types.
The signatures of the `new_resource` and `call` methods have changed with the introduction of the `pulumi.runtime.MockResourceArgs` and `pulumi.runtime.MockCallArgs` types. If you use `new_resource` and `call` in your code, you'll need to update to these new types.

```python
# before
Expand Down Expand Up @@ -240,8 +240,8 @@ Modify your `go.mod` file to update the Pulumi SDK and any providers you use, li

```
require (
github.com/pulumi/pulumi/sdk/v3 v3.0.0-rc.1
github.com/pulumi/pulumi-aws/sdk/v4 v4.0.0-rc.1
github.com/pulumi/pulumi/sdk/v3 v3.0.0
github.com/pulumi/pulumi-aws/sdk/v4 v4.0.0
)
```

Expand Down Expand Up @@ -276,7 +276,7 @@ containerDef := image.ImageName.ApplyT(func(name string) (string, error) {

### Changes to pulumi.runtime.Mocks

The signature of the `setMocks` function has changed with the introduction of the `pulumi.runtime.MockResourceArgs` and `pulumi.runtime.MockCallArgs` types. If you use `setMocks` in your code, you'll need to update to these new types.
The signatures of the `NewResource` and `Call` functions have changed with the introduction of the `pulumi.runtime.MockResourceArgs` and `pulumi.runtime.MockCallArgs` types. If you use `setMocks` in your code, you'll need to update to these new types.

```go
//before
Expand Down Expand Up @@ -326,12 +326,12 @@ func (mocks) Call(args MockCallArgs) (resource.PropertyMap, error) {
Modify your project file to update the Pulumi SDK and any providers you use, like this:

```csharp
<PackageReference Include="Pulumi" Version="3.0.*-*" />
<PackageReference Include="Pulumi" Version="3.0.*" />
```

### Changes to pulumi.runtime.Mocks

The signature of the `setMocks` function has changed with the introduction of the `pulumi.runtime.MockResourceArgs` and `pulumi.runtime.MockCallArgs` types. If you use `setMocks` in your code, you'll need to update to these new types.
The signatures of the `NewResourceAsync` and `CallAsync` methods have changed with the introduction of the `pulumi.runtime.MockResourceArgs` and `pulumi.runtime.MockCallArgs` types. If you use `setMocks` in your code, you'll need to update to these new types.

```csharp
// before
Expand Down Expand Up @@ -407,7 +407,7 @@ public Task<object> CallAsync(MockCallArgs args)

## Required updates for automation API users

The Pulumi 3.0 rc includes the final preview of the Automation API, which standardizes the namespace requirements for Automation API. You need to update programs that use automation API to use the following namespaces:
If you used a pre-GA release of Automation API, you need to update programs that use automation API to use the following namespaces:

{{< chooser language "javascript,typescript,python,go,csharp" >}}

Expand Down Expand Up @@ -472,7 +472,14 @@ using Pulumi.Automation;

{{< /chooser >}}

## When you should upgrade to Pulumi 3.0
## Remaining on Pulumi 2.0

We recommend switching to Pulumi 3.0 if possible. We will only push critical security and bug fixes into the 2.x branch.
Other fixes, feature enhancements, and new functionality will not be supported in the 2.x branch. In addition, provider
updates will only be built against Pulumi 3.0.

If you wish to remain on the 2.x CLI, you can continue to download the CLI by referring to the manual installation
instructions and choosing a specific version.

Pulumi 3.0 is currently in rc and not recommended for existing production workloads. Once it is made generally available (GA), we will recommend switching to Pulumi 3.0 in the docs and in the CLI via the normal upgrade prompts.
`pulumi new` will continue to use the stable versions of the templates. You can use the `3.x` version of the templates, which will use the 3.0 SDK, by running `pulumi new https://github.com/pulumi/templates/tree/3.x`.
Running `pulumi new` will attempt to use the latest versions of the project templates, which pull in the 3.0 SDK. You can continue to
use the 2.x templates by running `pulumi new https://github.com/pulumi/templates/tree/2.x`.
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,11 @@ pulumi.export("ip", result)
package main

import (
appsv1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/apps/v1"
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/core/v1"
metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/meta/v1"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi/config"
appsv1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/apps/v1"
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/core/v1"
metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/meta/v1"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
Expand Down Expand Up @@ -232,16 +232,16 @@ func main() {
var ip pulumi.StringOutput

if isMinikube {
ip = frontend.Spec.ApplyString(func(val *corev1.ServiceSpec) string {
ip = frontend.Spec.ApplyT(func(val *corev1.ServiceSpec) string {
return *val.ClusterIP
})
}).(pulumi.StringOutput)
} else {
ip = frontend.Status.ApplyString(func(val *corev1.ServiceStatus) string {
ip = frontend.Status.ApplyT(func(val *corev1.ServiceStatus) string {
if val.LoadBalancer.Ingress[0].Ip != nil {
return *val.LoadBalancer.Ingress[0].Ip
}
return *val.LoadBalancer.Ingress[0].Hostname
})
}).(pulumi.StringOutput)
}

ctx.Export("ip", ip)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,10 @@ pulumi.export("name", deployment.metadata["name"])
package main

import (
appsv1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/apps/v1"
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/core/v1"
metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/meta/v1"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
appsv1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/apps/v1"
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/core/v1"
metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/meta/v1"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
Expand Down
14 changes: 7 additions & 7 deletions themes/default/content/docs/guides/adopting/from_aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,9 @@ web = aws.ec2.Instance('web',
package main

import (
"github.com/pulumi/pulumi-aws/sdk/go/aws/cloudformation"
"github.com/pulumi/pulumi-aws/sdk/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/go/pulumi"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/cloudformation"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
Expand Down Expand Up @@ -319,8 +319,8 @@ pulumi.export('vpc_id', network.outputs["VpcId"])
package main

import (
"github.com/pulumi/pulumi-aws/sdk/go/aws/cloudformation"
"github.com/pulumi/pulumi/sdk/go/pulumi"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/cloudformation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

const (
Expand Down Expand Up @@ -550,8 +550,8 @@ pulumi.export('vpc_id', vpc.id)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/go/pulumi"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
Expand Down
10 changes: 5 additions & 5 deletions themes/default/content/docs/guides/adopting/from_azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ package main
import (
resources "github.com/pulumi/pulumi-azure-native/sdk/go/azure/resources"
storage "github.com/pulumi/pulumi-azure-native/sdk/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
Expand Down Expand Up @@ -265,8 +265,8 @@ package main

import (
"github.com/pulumi/pulumi-azure-native/sdk/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi/config"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
Expand Down Expand Up @@ -377,8 +377,8 @@ package main

import (
"github.com/pulumi/pulumi-azure-native/sdk/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi/config"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
Expand Down
28 changes: 14 additions & 14 deletions themes/default/content/docs/guides/adopting/from_kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ pulumi.export('private_ip', frontend.spec['cluster_ip'])
package main

import (
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/core/v1"
"github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/yaml"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/core/v1"
"github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/yaml"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
Expand Down Expand Up @@ -261,9 +261,9 @@ package main
import (
"path/filepath"

corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/core/v1"
"github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/yaml"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/core/v1"
"github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/yaml"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
Expand Down Expand Up @@ -448,9 +448,9 @@ pulumi.export('frontend_ip', frontend.status.load_balancer.ingress[0].ip)
package main

import (
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/core/v1"
helmv2 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/helm/v2"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/core/v1"
helmv2 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/helm/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
Expand Down Expand Up @@ -676,11 +676,11 @@ svc = Service('nginx-svc',
package main
import (
"github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes"
appsv1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/apps/v1"
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/core/v1"
metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/meta/v1"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes"
appsv1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/apps/v1"
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/core/v1"
metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/meta/v1"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
Expand Down
12 changes: 6 additions & 6 deletions themes/default/content/docs/guides/adopting/from_terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ $ pip3 install pulumi_terraform
{{% choosable language go %}}

```bash
$ go get github.com/pulumi/pulumi-terraform/sdk/v2
$ go get github.com/pulumi/pulumi-terraform/sdk/v4
```

{{% /choosable %}}
Expand Down Expand Up @@ -153,8 +153,8 @@ package main
import (
"os"

"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi-terraform/sdk/v2/go/state"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi-terraform/sdk/v4/go/state"
)

func main() {
Expand Down Expand Up @@ -330,10 +330,10 @@ network_state = terraform.state.RemoteStateReference('network',
package main

import (
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi/config"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

"github.com/pulumi/pulumi-terraform/sdk/v2/go/state"
"github.com/pulumi/pulumi-terraform/sdk/v4/go/state"
)

func main() {
Expand Down
8 changes: 4 additions & 4 deletions themes/default/content/docs/guides/adopting/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ demo = aws.s3.Bucket("infra-logs",
package main

import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
Expand Down Expand Up @@ -471,8 +471,8 @@ private_1 = aws.ec2.Subnet("private-1",
package main

import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -220,12 +220,12 @@ class MyStack : Stack
package main

import (
"github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes"
apiextensions "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/apiextensions"
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/core/v1"
metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/meta/v1"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi/config"
"github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes"
apiextensions "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/apiextensions"
corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/core/v1"
metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v3/go/kubernetes/meta/v1"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
Expand Down
Loading

0 comments on commit 3431f32

Please sign in to comment.