README
¶
PulumiYAML
A YAML (and JSON) language provider for Pulumi.
Preview
To use YAML language support in Pulumi, either:
-
Clone this repo and run
make installto build from source. -
Download the latest release for your platform and place
pulumi-language-yamlon your PATH. This can be in ~/.pulumi/bin or any other location. -
(Requires Pulumi 3.27.0) Configure a GitHub personal access token with the "repo" scope and set the GITHUB_TOKEN environment variable to your token before running:
pulumi plugin install language yaml
Examples
See examples dir for tested examples.
The Pulumi Getting Started:
name: simple-yaml
runtime: yaml
resources:
my-bucket:
type: aws:s3:Bucket
properties:
website:
indexDocument: index.html
index.html:
type: aws:s3:BucketObject
properties:
bucket: ${my-bucket}
source:
Fn::StringAsset: <h1>Hello, world!</h1>
acl: public-read
contentType: text/html
outputs:
bucketEndpoint: http://${my-bucket.websiteEndpoint}
Webserver + kitchen sink (providers, config, resource options, invokes, interpolations):
name: webserver
runtime: yaml
description: Basic example of an AWS web server accessible over HTTP
configuration:
InstanceType:
default: t3.micro
variables:
AmazonLinuxAmi:
Fn::Invoke:
Function: aws:getAmi
Arguments:
filters:
- name: name
values: ["amzn-ami-hvm-*-x86_64-ebs"]
owners: ["137112412989"]
mostRecent: true
Return: id
resources:
WebSecGrp:
type: aws:ec2:SecurityGroup
properties:
ingress:
- protocol: tcp
fromPort: 80
toPort: 80
cidrBlocks: ["0.0.0.0/0"]
protect: true
WebServer:
type: aws:ec2:Instance
properties:
instanceType: ${InstanceType}
ami: ${AmazonLinuxAmi}
userData: |-
#!/bin/bash
echo 'Hello, World from ${WebSecGrp.arn}!' > index.html
nohup python -m SimpleHTTPServer 80 &
vpcSecurityGroupIds:
- ${WebSecGrp}
UsEast2Provider:
type: pulumi:providers:aws
properties:
region: us-east-2
MyBucket:
type: aws:s3:Bucket
options:
provider: ${UsEast2Provider}
outputs:
InstanceId: ${WebServer.id}
PublicIp: ${WebServer.publicIp}
PublicHostName: ${WebServer.publicDns}
Spec
Pulumi programs can be defined in many languages, and the Pulumi YAML dialect offers an additional language for authoring Pulumi programs.
The Pulumi YAML provider supports programs written in YAML or JSON. In both cases, the programs (.yaml or .json files) follow a simple schema, including four top level sections:
| Property | Type | Required | Expression | Description |
|---|---|---|---|---|
configuration |
map[string]Configuration | No | No | Configuration specifies the Pulumi config inputs to the deployment. |
resources |
map[string]Resource | No | No | Resources declares the Pulumi resources that will be deployed and managed by the program |
variables |
map[string]Expression | No | Yes | Variables specifies intermediate values of the program, the values of variables are expressions that can be re-used. |
outputs |
map[string]Expression | No | Yes | Outputs specifies the Pulumi stack outputs of the program and how they are computed from the resources is a value of the appropriate type for the template to use if no value is specified. |
In many locations within this schema, values may be expressions which computed a value based on the configuration, variables, or outputs of resources. These expressions can be provided in two ways:
- If an object is provided as a value, and has a key that has the prefix
Fn::, the object is treated as an expression, and the expression will be resolved to a new value that will be used in place of the object. - Any string value is interpreted as an interpolation, with
${...}being replaced by evaluating the expression in the....
The supported expression forms for each of these is detailed below.
Configuration
The value of configuration is an object whose keys are logical names by which the config input will be referenced in expressions within the program, and whose values are elements of the schema below. Each item in this object represents an independent config input. Either type or default is required.
| Property | Type | Required | Expression | Description |
|---|---|---|---|---|
type |
string | No | No | Type is the (required) data type for the parameter. It can be one of: String, Number, List<Number>, or List<String>. |
default |
any | No | No | Default is a value of the appropriate type for the template to use if no value is specified. |
Resources
The value of resources is an object whose keys are logical resource names by which the resource will be referenced in expressions within the program, and whose values which are elements of the schema below. Each item in this object represents a resource which will be managed by the Pulumi program.
| Property | Type | Required | Expressions | Description |
|---|---|---|---|---|
type |
string | Yes | No | Type is the Pulumi type token for this resource. |
properties |
map[string]Expression | No | Yes | Properties contains the primary resource-specific keys and values to initialize the resource state. |
options |
Resource Options | No | No | Options contains all resource options supported by Pulumi. |
Resource Options
The value of the options property of a Resource is an object whose keys are resource option names and whose values are elements of the schema below.
To specify resources in dependsOn, parent, provider, and providers, use
| Property | Type | Required | Expressions | Description |
|---|---|---|---|---|
additionalSecretOutputs |
string[] | No | No | AdditionalSecretOutputs specifies properties that must be encrypted as secrets |
aliases |
string[] | No | No | Aliases specifies names that this resource used to have, so that renaming or refactoring doesn’t replace it |
customTimeouts |
Custom Timeout | No | No | CustomTimeouts overrides the default retry/timeout behavior for resource provisioning |
deleteBeforeReplace |
bool | No | No | DeleteBeforeReplace overrides the default create-before-delete behavior when replacing |
dependsOn |
Expression[] | No | Yes | DependsOn makes this resource explicitly depend on another resource, by name, so that it won't be created before the dependent finishes being created (and the reverse for destruction). Normally, Pulumi automatically tracks implicit dependencies through inputs/outputs, but this can be used when dependencies aren't captured purely from input/output edges. |
ignoreChanges |
string[] | No | No | IgnoreChanges declares that changes to certain properties should be ignored during diffing |
import |
string | No | No | Import adopts an existing resource from your cloud account under the control of Pulumi |
parent |
Expression | No | Yes | Parent specifies a parent for the resource |
protect |
bool | No | No | Protect prevents accidental deletion of a resource |
provider |
Expression | No | Yes | Provider specifies an explicitly configured provider, instead of using the default global provider |
providers |
map[string]Expression | No | Yes | Map of providers for a resource and its children. |
version |
string | No | No | Version specifies a provider plugin version that should be used when operating on a resource |
Custom Timeout
The optional customTimeouts property of a resource is an object of the following schema:
| Property | Type | Required | Expression | Description |
|---|---|---|---|---|
create |
string | No | No | Create is the custom timeout for create operations. |
delete |
string | No | No | Delete is the custom timeout for delete operations. |
update |
string | No | No | Update is the custom timeout for update operations. |
Outputs
The value of outputs is an object whose keys are the logical names of the outputs that are available from outside the Pulumi stack (via pulumi stack output), and whose values are potentially computed expressions the resolve to the values of the desired outputs.
Expressions
Expressions can be used in several contexts:
- the properties of
propertiesofresources - the properties of
optionsofresourcesthat take references to other resources:parent,dependsOn,provider, andproviders - the values of
variablesandoutputs - some or all values provided to built-in functions, as specified below
Generally speaking, most values permit an expression and exceptions will be documented as not permitting an expression, as above.
In these contexts, any JSON/YAML value may be provided. If that value is a string, it is interpolated. If that value is an object, and the object has a key with a prefix of Fn::, it is evaluated as an expression.
Interpolation
In expression locations, strings are evaluated as interpolations and any nested ${...} expressions within the string value are replaced by the value of the expression .... The syntax of expressions within interpolations permits property access only.
To use ${} in a string literal, escape $ with $$ like so:
variables:
plainString: $${value}
A string like Hello, ${foo} will convert the expression foo to a string.
If a string contains only an ${...} expression, it's considered a substitution.
Property Access
Within an expression denoted by ${...} property access is permitted according to the forms below. Config, variables, and resource keys all exist in a single namespace, and in the examples, root or equivalent must be the name of one of these items, and it must be valid to access the foo property of that item if it's a map or object, or if it's an array, the index must be valid.
${root}${root.foo}${root["foo"]}${root.bar.quux}${root["bar"].quux}${root["bar"]["quux"]}${root[0]}${root[100]}${root[0].foo}${root[0][1].foo}${root.foo.items[0].bar[1]}${root["key with \"escaped\" quotes"]}${root["key with a ."]}${["root key with \"escaped\" quotes"].foo}${["root key with a ."][100]}
We have not discussed types until now, but implicitly every expression has a type, such as number, string, map, array, or even resource. When interpolated, these values must become strings, otherwise they are substituted in. Additionally:
- maps must have string keys and expression values
- arrays have non-negative integer indices and expression values
- property access on a Resource retrieves outputs
Substitution
Expressions denoted by ${...} are only converted to strings when interpolated into a string with surrounding text. If a resource property takes a list or a map for example, that can be provided by a variable whose value can be substituted in. In the example below, the httpPort variable is used to reduce repetition in the two Kubernetes Service resources.
name: kubernetes-port-example
variables:
httpPort:
protocol: TCP
port: 80
targetPort: 8000
resources:
serviceOne:
type: kubernetes:core/v1:Service
properties:
spec:
selector:
app: "MyApp"
ports:
- ${httpPort}
serviceTwo:
type: kubernetes:core/v1:Service
properties:
spec:
selector:
app: "OtherApp"
ports:
- ${httpPort}
The last two lines are equivalent as if the variable were substituted for its value:
ports:
- protocol: TCP
port: 80
targetPort: 8000
Built-in Functions
In any expression location, an object containing a single key beginning with Fn:: calls a built-in function.
Fn::ToBase64Converts a UTF-8 string into a Base64 encoded string using the standard encoding.
variables:
greeting:
Fn::ToBase64: "Hello, world!"
The expression ${greeting} will return SGVsbG8sIHdvcmxkIQ==
Fn::FromBase64Converts a Base64 encoded string into a UTF-8 string. This will fail if the result is not a valid UTF-8 string
variables:
greeting:
Fn::FromBase64: SGVsbG8sIFdvcmxkIQ==
The expression ${greeting} will return Hello, World!
Fn::ToJSONConverts a value into its JSON representation.
variables:
item:
Fn::ToJSON:
key1: value1
key2: 123
The expression ${item} will return a JSON value { "key1": "value1", "key2": 123 }.
Fn::InvokeCalls a function from a package and returns either the whole object or a single key if given the "Return" property. The schema is:
| Property | Type | Required | Expression | Description |
|---|---|---|---|---|
Function |
string | Yes | No | Name of a function to call. |
Arguments |
map[string]Expression | Yes | Yes | Arguments to pass to the expression, each key is a named argument. |
Return |
string | No | No | If the function returns an object, a single key may be selected and returned instead with its name. |
variables:
AmazonLinuxAmi:
Fn::Invoke:
Function: aws:getAmi
Arguments:
filters:
- name: name
values: ["amzn-ami-hvm-*-x86_64-ebs"]
owners: ["137112412989"]
mostRecent: true
Return: id
The expression ${AmazonLinuxAmi} will return the AMI ID returned from the aws:getAmi function.
Fn::JoinJoins strings together separated by a delimiter. Arguments are passed as a list, with the first item being the delimiter, and the second item a list of expressions to concatenate.
variables:
banana:
Fn::Join:
- 'NaN'
- - Ba
- a
The expression ${banana} will have the value "BaNaNa".
Fn::SelectSelects one of several options given an index. Arguments are passed as a list, with the first item being the index, 0-based, and the second item a list of expressions to select from.
variables:
policyVersion:
Fn::Select:
- 1
- - v1
- v1.1
- v2.0
The expression ${policyVersion} will have the value v1.1.
Fn::*Asset and Fn::*ArchiveAssets and Archives are intrinsic types to Pulumi, like strings and numbers, and some resources may take these as inputs or return them as outputs. The built-ins create each kind of asset or archive. Each takes all take a single string value.
| Built-In | Argument Type | Description |
|---|---|---|
Fn::FileAsset |
string | The contents of the asset are read from a file on disk. |
Fn::StringAsset |
string | The contents of the asset are read from a string in memory. |
Fn::RemoteAsset |
string | The contents of the asset are read from an http, https or file URI. |
Fn::FileArchive |
string | The contents of the archive are read from either a folder on disk or a file on disk in one of the supported formats: .tar, .tgz, .tar.gz, .zip or .jar. |
Fn::RemoteArchive |
string | The contents of the asset are read from an http, https or file URI, which must produce an archive of one of the same supported types as FileArchive. |
Fn::AssetArchive |
map | The contents of the archive are read from a map of either Asset or Archive objects, one file or folder respectively per entry in the map. |
variables:
aFile:
Fn::FileAsset: ./file.txt
aString:
Fn::StringAsset: Hello, world!
aRemoteAsset:
Fn::RemoteAsset: http://worldclockapi.com/api/json/est/now
aFileArchive:
Fn::FileArchive: ./file.zip
aRemoteArchive:
Fn::RemoteArchive: http://example.com/file.zip
anAssetArchive:
Fn::AssetArchive:
file:
Fn::StringAsset: Hello, world!
folder:
Fn::FileArchive: ./folder
Fn::StackReferenceStack References allow accessing the outputs of a stack from a YAML program. Arguments are passed as a list, with the first item being the stack name and the second argument the name of an output to reference:
variables:
reference:
Fn::StackReference:
- org/project/stack
- outputName
The expression ${reference} will have the value of the outputName output from the stack org/project/stack.
Fn::SecretConstructs a Secret from an existing value.
variables:
secret:
Fn::Secret:
Fn::Invoke:
Function: my:pkg:GetSecretValue
Fn::ReadFileReads a file from disk and returns the contents as a string, must be utf-8. This function has special rules for its behavior.
variables:
someText:
Fn::ReadFile: ./README.md
Any subpath of the Pulumi project directory is allowed, whether it is absolute, relative, constant, or an expression:
Fn::ReadFile: ./README.md, a relative subpathFn::ReadFile: ${pulumi.cwd}/example.txt, an absolute subpathFn::ReadFile: /opt/project-dir/example.json, an absolute subpath if the program is in /opt/project-dir
Absolute paths to any location are allowed if they are constants:
Fn::ReadFile: /etc/lsb-releaseFn::ReadFile: /usr/share/nginx/htmlFn::ReadFile: /var/run/secrets/kubernetes.io/serviceaccount/token
Relative paths that escape the project directory and absolute paths that are non-constant are forbidden to prevent path traversals.
Fn::ReadFile: ../../etc/shadow, a relative path that escapes the projectFn::ReadFile: ${pulumi.cwd}/../../.ssh/id_rsa.pub, an expression that returns an absolute path that escapes the project
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pulumi-language-yaml
command
pulumi-language-yaml is the "language host" for Pulumi programs written in YAML or JSON.
|
pulumi-language-yaml is the "language host" for Pulumi programs written in YAML or JSON. |
|
pkg
|
|
|
pulumiyaml/codegen
The codegen package provides utilities for converting Pulumi YAML templates to other forms (e.g.
|
The codegen package provides utilities for converting Pulumi YAML templates to other forms (e.g. |
|
server
pulumi-language-yaml is the "language host" for Pulumi programs written in YAML or JSON.
|
pulumi-language-yaml is the "language host" for Pulumi programs written in YAML or JSON. |