Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix various typos #13527

Merged
merged 3 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Make sure to replace `<org>`, `<project>`, and `<environment>` with the values o
|----------|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `region` | string | The AWS region to use. |
| `login` | [AWSParameterStoreLogin](#awsparameterstorelogin) | Credentials to use to log in to AWS. |
| `get` | map[string][AWSParameterStoreGet](#awsparameterstoreget) | A map from names to parameters to read from AWS Parameter Store. The outputs will map each name to the parameters's data. |
| `get` | map[string][AWSParameterStoreGet](#awsparameterstoreget) | A map from names to parameters to read from AWS Parameter Store. The outputs will map each name to the parameter's data. |

### AWSParameterStoreLogin

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If your team has already provisioned infrastructure using Azure Resource Manager

## Referencing Stack Outputs

It is possible to reference existing Azure Resource Manager (ARM) template deployments from your program. It doesn't mattter how these templates and deployments were created. This lets you read properties of a deployment for use within your Pulumi program. This includes output values computed from resources provisioned that stack.
It is possible to reference existing Azure Resource Manager (ARM) template deployments from your program. It doesn't matter how these templates and deployments were created. This lets you read properties of a deployment for use within your Pulumi program. This includes output values computed from resources provisioned that stack.

For instance, let's say your infrastructure team has provisioned your Azure storage account using ARM and you need to use the Storage Account name to provision something new from your Pulumi program. One approach is to hardcode the name but this is brittle and, if it ever changes, you'd need to go and manually update the hardcoded value.

Expand Down Expand Up @@ -462,6 +462,6 @@ Diagnostics:
warning: inputs to import do not match the existing resource; importing this resource will fail
```

This is because the import operation requires explicit definitions for all properties that may have been auto-populated by Azure during the resource creation. You can supress the warning by setting the [`ignoreChanges`](/docs/concepts/resources/#ignorechanges) option to `["accessTier","enableHttpsTrafficOnly","encryption","networkRuleSet"]`.
This is because the import operation requires explicit definitions for all properties that may have been auto-populated by Azure during the resource creation. You can suppress the warning by setting the [`ignoreChanges`](/docs/concepts/resources/#ignorechanges) option to `["accessTier","enableHttpsTrafficOnly","encryption","networkRuleSet"]`.

After running `pulumi up` again, your storage account will become under the control of Pulumi without any disruption. All subsequent infrastructure changes you'd like to be made can happen within Pulumi instead of ARM template deployments.
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ Resources:

The `ConfigGroup` resource type is similar to `ConfigFile`. Instead of a single file, it accepts a `files` parameter that contains a list of file paths, file globs, and/or URLs from which to read the YAML configuration from. By default, names are used as-is, however you can specify a `resourcePrefix` to rewrite the names. One or more `transformations` callbacks can be supplied to arbitrarily rewrite resource configurations on-the-fly before deploying them.

To deploy the Kubernetes Guestbook Application using a colllection of YAML files, first create a `yaml` directory and download them into it:
To deploy the Kubernetes Guestbook Application using a collection of YAML files, first create a `yaml` directory and download them into it:

```bash
$ mkdir yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,7 @@ Call `pulumi import --from terraform ./terraform.tfstate` ensuring a valid locat

This will read the resources and their ID's out of the terraform state file and run a standard Pulumi import deployment to read them into the Pulumi state.

Before running the deployment the import file generated will be writen out to the current directory, if there are issues importing you can manually edit this file and try again with `pulumi import --file`.
Before running the deployment the import file generated will be written out to the current directory, if there are issues importing you can manually edit this file and try again with `pulumi import --file`.

### Example Conversion

Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/cli/commands/pulumi_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ must be provided. For example:

The type token and property used for resource lookup are available in the Import section of
the resource's API documentation in the Pulumi Registry (https://www.pulumi.com/registry/).
To fully specify parent and/or provider, subsitute the <urn> for each into the following:
To fully specify parent and/or provider, substitute the <urn> for each into the following:

pulumi import 'aws:iam/user:User' name id --parent 'parent=<urn>' --provider 'admin=<urn>'

Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/clouds/aws/guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ const vpc = new awsx.ec2.Vpc("classic-vpc", {});
```

Any resource that you use from the existing library can continue to be used from that `classic` namespace. All of the classic
functionality is available in that namesoace.
functionality is available in that namespace.

### Is Support or Training Available for Pulumi Crosswalk for AWS?

Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/clouds/aws/guides/eks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2565,7 +2565,7 @@ var guestbook = new K8sYaml.ConfigGroup("guestbook",
if (state["kind"] != null && state["kind"].Equals("Service") &&
state["apiVersion"] != null && state["apiVersion"].Equals("v1")) {
var spec = (ImmutableDictionary<string, object>)state["spec"];
return state.SetItem("spec", spec.SetItem("type", "ClustertIP"));
return state.SetItem("spec", spec.SetItem("type", "ClusterIP"));
}
return state;
},
Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/clouds/kubernetes/guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Kubernetes offerings such as [Amazon Elastic Kubernetes Service (EKS)][eks], [Az
Kubernetes Service (AKS)][aks], or [Google Kubernetes Engine (GKE)][gke].

Discover solutions to the hardest Kubernetes problems to avoid mitigating
pitfalls around infrastructure, security, governance, reliablity, and
pitfalls around infrastructure, security, governance, reliability, and
maintainability of the cluster, it's workloads, and underlying resources.

[Get started][cw-playbooks] with the playbooks to manage Kubernetes in production with your team.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ Enable logging for the control plane, and monitoring of all metrics in the
```ts
import * as azure from "@pulumi/azure";

// Enable the Monitoring Diagonostic control plane component logs and AllMetrics
// Enable the Monitoring Diagnostic control plane component logs and AllMetrics
const azMonitoringDiagnostic = new azure.monitoring.DiagnosticSetting(name, {
logAnalyticsWorkspaceId: config.logAnalyticsWorkspaceId,
targetResourceId: config.clusterId,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ $ kubectl run --namespace=`pulumi stack output appsNamespaceName` --generator=ru
Error from server (Forbidden): pods is forbidden: User "pulumi:alice" cannot create resource "pods" in API group "" in the namespace "apps-x1z818eg"
```

Below is an example of how to create a Kubernetes Role and RoleBiding for the `devs` to **only** deploy common
Below is an example of how to create a Kubernetes Role and RoleBinding for the `devs` to **only** deploy common
workloads in the `apps` namespace (created in [cluster defaults][crosswalk-configure-defaults]).

Assume the `admin` user.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/concepts/inputs-outputs/all.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title_tag: "Accessing Multple Outputs with All | Inputs and Outputs"
title_tag: "Accessing Multiple Outputs with All | Inputs and Outputs"
meta_desc: "Learn how to access multiple output values using the All method in Pulumi."
title: Accessing multiple outputs with All
h1: Accessing multiple outputs with All
Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/concepts/inputs-outputs/apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,7 @@ vpc.vpc_id.apply(lambda id: print('VPC ID:', id))
```

{{% notes %}}
**A note on error handling** The function `ApplyT` spawns a Goroutine to await the availability of the implicated dependencies. This function accepts a `T` or `(T, error)` signature; the latter accomodates for error handling. Alternatively, one may use the `ApplyTWithContext` function in which the provided context can be used to reject the output as canceled. Error handling may also be achieved using an `error` `chan`.
**A note on error handling** The function `ApplyT` spawns a Goroutine to await the availability of the implicated dependencies. This function accepts a `T` or `(T, error)` signature; the latter accommodates for error handling. Alternatively, one may use the `ApplyTWithContext` function in which the provided context can be used to reject the output as canceled. Error handling may also be achieved using an `error` `chan`.
{{% /notes %}}

{{% /choosable %}}
Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/concepts/options/deletedwith.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The `deletedWith` resource option allows you to skip resource deletion if a anot

Pulumi will normally call the provider's delete action for every resource during a delete operation. Sometimes, this is redundant if another resource is also deleted, such as a parent container resource, and can cause your delete or destroy operations to take longer than needed.

For example, if you are deleting a Kubernetes cluster or Kubernetes namespace, you might want to speed up deletion by skipping delete on any Pulumi managed resources created in that Kubernetes cluster or namespace since they will be deleted implicitely.
For example, if you are deleting a Kubernetes cluster or Kubernetes namespace, you might want to speed up deletion by skipping delete on any Pulumi managed resources created in that Kubernetes cluster or namespace since they will be deleted implicitly.

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

Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/concepts/options/replaceonchanges.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ widget = apiextensions.CustomResource("widget",
{{% choosable language go %}}

```go
widget, err = apiextensions.NewCustomResource(ctx, "widgt", &apiextensions.CustomResourceArgs{
widget, err = apiextensions.NewCustomResource(ctx, "widget", &apiextensions.CustomResourceArgs{
ApiVersion: pulumi.String("acmecorp.com/v1alpha1"),
Kind: pulumi.String("Widget"),
OtherFields: kubernetes.UntypedArgs{
Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/concepts/options/transforms.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,4 +258,4 @@ While the Transforms APIs are similar to Transformations, there are some differe

## Transforms for Packaged Component Resources

Note that a transform will be called twice for packaged component resources (such as those in [awsx](/registry/packages/awsx) and [eks](/registry/packages/eks)). The transform will be called before the component resource is constructed, providing an opportunity to modify inputs and resource options before being passed to the provider that implements the component, and then again when the component resource is actually created in the provider, providing an opportunity to modify any resource options that were configured inside the implemenation of the component.
Note that a transform will be called twice for packaged component resources (such as those in [awsx](/registry/packages/awsx) and [eks](/registry/packages/eks)). The transform will be called before the component resource is constructed, providing an opportunity to modify inputs and resource options before being passed to the provider that implements the component, and then again when the component resource is actually created in the provider, providing an opportunity to modify any resource options that were configured inside the implementation of the component.
2 changes: 1 addition & 1 deletion content/docs/iac/concepts/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ Password: [secret]

### Explicitly denote unencrypted values

By default, configuration values are saved in plain text. Given this, there may be times where you need to explictly denote a value as plain text or unencrypted. For example, for security purposes, the Pulumi CLI tries to detect when something that looks like an API token or password is supplied to as a Pulumi configuration value. There are some scenarios where it will incorrectly assume a string is a secret and will alert you in the command line while aborting the task.
By default, configuration values are saved in plain text. Given this, there may be times where you need to explicitly denote a value as plain text or unencrypted. For example, for security purposes, the Pulumi CLI tries to detect when something that looks like an API token or password is supplied to as a Pulumi configuration value. There are some scenarios where it will incorrectly assume a string is a secret and will alert you in the command line while aborting the task.

To avoid this, you can pass the `--plaintext` flag when creating your configuration value. This flag can be used to indicate that you did not want an encrypted secret.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/concepts/state-and-backends.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ Versions of Pulumi prior to v3.61.0 placed stacks in a global namespace in self-
Existing self-managed backends will continue to use the global namespace for stacks. You can upgrade an existing self-managed backend to use project-scoped stacks using the `pulumi state upgrade` command. This command will upgrade all stacks in the backend to be scoped by project.

{{% notes type="info"%}}
`pulumi state upgrade` will make upgraded stacks inaccesible to older versions of Pulumi. This is a one-way operation. Once you have upgraded your backend, you cannot downgrade to the previous version.
`pulumi state upgrade` will make upgraded stacks inaccessible to older versions of Pulumi. This is a one-way operation. Once you have upgraded your backend, you cannot downgrade to the previous version.
{{% /notes %}}

## Migrating Between State Backends
Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/concepts/vs/terraform/opentofu.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Terraform and OpenTofu are both infrastructure as code technologies that have si

## Terraform vs. OpenTofu: Similarities {#similarities}

OpenTofu is a fork of Terraform 1.6.x so there are many similiarities for now. They both have the ability to create, deploy, and manage infrastructure as code on any cloud. Both Terraform and OpenTofu follow a desired state infrastructure as code model, where the IaC code represents the desired state of the infrastructure. The deployment engine compares this desired state with the current state of the stack and determines the necessary actions, such as creating, updating, or deleting resources. Both Terraform and OpenTofu support many cloud providers, including [AWS](/aws/), [Azure](/azure/), and [Google Cloud](/gcp/), plus other services like CloudFlare, Digital Ocean, and more. They also both require the use of a domain-specific language: HashiCorp Configuration Language (HCL).
OpenTofu is a fork of Terraform 1.6.x so there are many similarities for now. They both have the ability to create, deploy, and manage infrastructure as code on any cloud. Both Terraform and OpenTofu follow a desired state infrastructure as code model, where the IaC code represents the desired state of the infrastructure. The deployment engine compares this desired state with the current state of the stack and determines the necessary actions, such as creating, updating, or deleting resources. Both Terraform and OpenTofu support many cloud providers, including [AWS](/aws/), [Azure](/azure/), and [Google Cloud](/gcp/), plus other services like CloudFlare, Digital Ocean, and more. They also both require the use of a domain-specific language: HashiCorp Configuration Language (HCL).

## Terraform vs. OpenTofu: Key Differences {#differences}

Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/get-started/kubernetes/begin.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Next, we'll configure Kubernetes.

### Configure Kubernetes

<a href="/registry/packages/kubernetes/installation-configuration" target="_blank">Configure Kubernetes</a> so the Pulumi CLI can connect to a Kubernetes cluster. If you have previously configured the <a href="https://kubernetes.io/docs/reference/kubectl/overview/" target="_blank">kubectl CLI</a>, `kubectl`, Pulumi will respect and use your configuration settings. Depending on the approach you choose, you may need to apply some of the configuation after creating your project and stack in the next step.
<a href="/registry/packages/kubernetes/installation-configuration" target="_blank">Configure Kubernetes</a> so the Pulumi CLI can connect to a Kubernetes cluster. If you have previously configured the <a href="https://kubernetes.io/docs/reference/kubectl/overview/" target="_blank">kubectl CLI</a>, `kubectl`, Pulumi will respect and use your configuration settings. Depending on the approach you choose, you may need to apply some of the configuration after creating your project and stack in the next step.

Next, we'll create a new Pulumi project.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/iac/languages-sdks/python/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ $ uv add ${PACKAGE_NAME}

### Dev Versions

Pulumi SDKs also publish pre-release versions that include all the latest changes from the main development branch. If you would like to install a pre-release version, you can use the `--pre` flag with `pip` or the `--allow-prereleaases` flag with `poetry`. For example:
Pulumi SDKs also publish pre-release versions that include all the latest changes from the main development branch. If you would like to install a pre-release version, you can use the `--pre` flag with `pip` or the `--allow-prereleases` flag with `poetry`. For example:

```bash
pip install --pre -r requirements.txt
Expand Down
4 changes: 2 additions & 2 deletions content/docs/iac/support/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -539,8 +539,8 @@ The possible fields of a resource are:
| `protect` | A boolean indicating whether or not this resource is protected. Protected resources can not be deleted. |
| `external` | A boolean indicating whether or not this resource is external to Pulumi. If a resource is external, Pulumi does not own its life cycle and it will not ever delete or update the resource. Resources that are read using the `get` function are external. |
| `dependencies` | A list of URNs indicating the resources that this resource depends on. Pulumi tracks dependencies between resources. It is important that this list be the full list of resources upon which this resource depends. |
| `initErrors` | A list of errors that occured that prevented the resource from initializing. Some resource providers (most notably Kubernetes) populate this field to indicate that a resource was created but failed to initialize. |
| `provider` | Reference to the provider esponsible for the resource. |
| `initErrors` | A list of errors that occurred that prevented the resource from initializing. Some resource providers (most notably Kubernetes) populate this field to indicate that a resource was created but failed to initialize. |
| `provider` | Reference to the provider responsible for the resource. |

The `resources` field is a list, not a set. The order of resources in the list is important and is enforced by
the Pulumi engine. Resources in a deployment must be in *dependency order* - if resource A depends on resource B,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ A project represents the application being deployed and uses versioned packages

### Packages

Packages can be your source code bundled-up in one of the [supported formats](https://octopus.com/docs/packaging-applications#supported-formats). They can also just be a handlful of scripts that you may want to use during your deployment process.
Packages can be your source code bundled-up in one of the [supported formats](https://octopus.com/docs/packaging-applications#supported-formats). They can also just be a handful of scripts that you may want to use during your deployment process.

In order to create a package, Octopus offers several ways that you can integrate into your existing build (CI) system. [Learn more](https://octopus.com/docs/packaging-applications/create-packages) about the options available to you for packaging your apps.

Expand Down
Loading