Pulumi.yaml: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 36: Line 36:
Required attribute that specifies the [[Pulumi_Concepts#Project_Name|project name]].
Required attribute that specifies the [[Pulumi_Concepts#Project_Name|project name]].
==<tt>runtime</tt>==
==<tt>runtime</tt>==
A required key that specifies the language runtime configuration to use for the program. Possible values: "python", "nodjs", "go" and "dotnet". Pulumi doesn’t depend on specific versions of these runtimes, and will simply use whatever version you have installed on your machine.
A required map that specifies the language runtime configuration to use for the program. Possible values for <code>name</code>: "python", "nodjs", "go" and "dotnet". Pulumi doesn’t depend on specific versions of these runtimes, and will simply use whatever version you have installed on your machine.


==<tt>description</tt>==
==<tt>description</tt>==
==<tt>template</tt>==
==<tt>template</tt>==
This section of the configuration file is relevant when a new project is initialized with <code>[[Pulumi_Operations#new|pulumi new]]</code>. The initialization code processes the the configuration key listed under <code>template.config</code> and queries for values, interactively. Each configuration key can get a <code>description</code> which will be displayed during the configuration process, a <code>default</code> value and whether it is security sensitive or not, by setting <code>secret</code> to <code>true</code>.
This section of the configuration file is relevant when a new project is initialized with <code>[[Pulumi_Operations#new|pulumi new]]</code>. The initialization code processes the the configuration key listed under <code>template.config</code> and queries for values, interactively. Each configuration key can get a <code>description</code> which will be displayed during the configuration process, a <code>default</code> value and whether it is security sensitive or not, by setting <code>secret</code> to <code>true</code>.

Revision as of 23:23, 19 January 2022

External

Internal

Overview

Pulumi.yaml contains the project definition. The name must begin with a capital "P", and both "yaml" and "yaml" extensions are valid.

Example

name: datadog-example
runtime:
  name: python
  options:
    virtualenv: venv
description: An experimental Datadog Pulumi project.
template:
  description: Minimal structure for a Datadog automation infrastructure project.
    config:
      datadog:apiKey:
        description:
        secret: true
      datadog:appKey:
        description:
        secret: true

What does this mean, seems to be related to pulumi new:

name: ${PROJECT}
description: ${DESCRIPTION}

Elements

name

Required attribute that specifies the project name.

runtime

A required map that specifies the language runtime configuration to use for the program. Possible values for name: "python", "nodjs", "go" and "dotnet". Pulumi doesn’t depend on specific versions of these runtimes, and will simply use whatever version you have installed on your machine.

description

template

This section of the configuration file is relevant when a new project is initialized with pulumi new. The initialization code processes the the configuration key listed under template.config and queries for values, interactively. Each configuration key can get a description which will be displayed during the configuration process, a default value and whether it is security sensitive or not, by setting secret to true.