workspace

package
Version: v2.25.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 17, 2021 License: Apache-2.0 Imports: 40 Imported by: 16

Documentation

Index

Constants

View Source
const (
	// BackupDir is the name of the folder where backup stack information is stored.
	BackupDir = "backups"
	// BookkeepingDir is the name of our bookkeeping folder, we store state here (like .git for git).
	BookkeepingDir = ".pulumi"
	// ConfigDir is the name of the folder that holds local configuration information.
	ConfigDir = "config"
	// GitDir is the name of the folder git uses to store information.
	GitDir = ".git"
	// HistoryDir is the name of the directory that holds historical information for projects.
	HistoryDir = "history"
	// PluginDir is the name of the directory containing plugins.
	PluginDir = "plugins"
	// PolicyDir is the name of the directory that holds policy packs.
	PolicyDir = "policies"
	// StackDir is the name of the directory that holds stack information for projects.
	StackDir = "stacks"
	// LockDir is the name of the directory that holds locking information for projects.
	LockDir = "locks"
	// TemplateDir is the name of the directory containing templates.
	TemplateDir = "templates"
	// TemplatePolicyDir is the name of the directory containing templates for Policy Packs.
	TemplatePolicyDir = "templates-policy"
	// WorkspaceDir is the name of the directory that holds workspace information for projects.
	WorkspaceDir = "workspaces"

	// IgnoreFile is the name of the file that we use to control what to upload to the service.
	IgnoreFile = ".pulumiignore"

	// ProjectFile is the base name of a project file.
	ProjectFile = "Pulumi"
	// RepoFile is the name of the file that holds information specific to the entire repository.
	RepoFile = "settings.json"
	// WorkspaceFile is the name of the file that holds workspace information.
	WorkspaceFile = "workspace.json"
	// CachedVersionFile is the name of the file we use to store when we last checked if the CLI was out of date
	CachedVersionFile = ".cachedVersionInfo"

	// PulumiHomeEnvVar is a path to the '.pulumi' folder with plugins, access token, etc.
	// The folder can have any name, not necessarily '.pulumi'.
	// It defaults to the '<user's home>/.pulumi' if not specified.
	PulumiHomeEnvVar = "PULUMI_HOME"

	// PolicyPackFile is the base name of a Pulumi policy pack file.
	PolicyPackFile = "PulumiPolicy"
)
View Source
const PulumiBackendURLEnvVar = "PULUMI_BACKEND_URL"

PulumiBackendURLEnvVar is an environment variable which can be used to set the backend that will be used instead of the currently logged in backend or the current projects backend.

View Source
const PulumiCredentialsPathEnvVar = "PULUMI_CREDENTIALS_PATH"

PulumiCredentialsPathEnvVar is a path to the folder where credentials are stored. We use this in testing so that tests which log in and out do not impact the local developer's credentials or tests interacting with one another

Variables

This section is empty.

Functions

func CopyTemplateFiles

func CopyTemplateFiles(
	sourceDir, destDir string, force bool, projectName string, projectDescription string) error

CopyTemplateFiles does the actual copy operation to a destination directory.

func CopyTemplateFilesDryRun

func CopyTemplateFilesDryRun(sourceDir, destDir, projectName string) error

CopyTemplateFilesDryRun does a dry run of copying a template to a destination directory, to ensure it won't overwrite any files.

func DeleteAccount

func DeleteAccount(key string) error

DeleteAccount deletes an account underneath the given key.

func DeleteAllAccounts added in v2.18.0

func DeleteAllAccounts() error

func DetectPolicyPackPathFrom

func DetectPolicyPackPathFrom(path string) (string, error)

DetectPolicyPackPathFrom locates the closest Pulumi policy project from the given path, searching "upwards" in the directory hierarchy. If no project is found, an empty path is returned.

func DetectProjectPath

func DetectProjectPath() (string, error)

DetectProjectPath locates the closest project from the current working directory, or an error if not found.

func DetectProjectPathFrom

func DetectProjectPathFrom(path string) (string, error)

DetectProjectPathFrom locates the closest project from the given path, searching "upwards" in the directory hierarchy. If no project is found, an empty path is returned.

func DetectProjectStackPath

func DetectProjectStackPath(stackName tokens.QName) (string, error)

DetectProjectStackPath returns the name of the file to store stack specific project settings in. We place stack specific settings next to the Pulumi.yaml file, named like: Pulumi.<stack-name>.yaml

func GetCachedVersionFilePath

func GetCachedVersionFilePath() (string, error)

GetCachedVersionFilePath returns the location where the CLI caches information from pulumi.com on the newest available version of the CLI

func GetCurrentCloudURL

func GetCurrentCloudURL() (string, error)

GetCurrentCloudURL returns the URL of the cloud we are currently connected to. This may be empty if we have not logged in. Note if PULUMI_BACKEND_URL is set, the corresponding value is returned instead irrespective of the backend for current project or stored credentials.

func GetPluginDir

func GetPluginDir() (string, error)

GetPluginDir returns the directory in which plugins on the current machine are managed.

func GetPluginPath

func GetPluginPath(kind PluginKind, name string, version *semver.Version) (string, string, error)

GetPluginPath finds a plugin's path by its kind, name, and optional version. It will match the latest version that is >= the version specified. If no version is supplied, the latest plugin for that given kind/name pair is loaded, using standard semver sorting rules. A plugin may be overridden entirely by placing it on your $PATH.

func GetPolicyDir

func GetPolicyDir(orgName string) (string, error)

GetPolicyDir returns the directory in which an organization's Policy Packs on the current machine are managed.

func GetPolicyPath

func GetPolicyPath(orgName, name, version string) (string, bool, error)

GetPolicyPath finds a PolicyPack by its name version, as well as a bool marked true if the path already exists and is a directory.

func GetPulumiHomeDir

func GetPulumiHomeDir() (string, error)

GetPulumiHomeDir returns the path of the '.pulumi' folder where Pulumi puts its artifacts.

func GetPulumiPath

func GetPulumiPath(elem ...string) (string, error)

GetPulumiPath returns the path to a file or directory under the '.pulumi' folder. It joins the path of the '.pulumi' folder with elements passed as arguments.

func GetTemplateDir

func GetTemplateDir(templateKind TemplateKind) (string, error)

GetTemplateDir returns the directory in which templates on the current machine are stored.

func HasPlugin

func HasPlugin(plug PluginInfo) bool

HasPlugin returns true if the given plugin exists.

func HasPluginGTE

func HasPluginGTE(plug PluginInfo) (bool, error)

HasPluginGTE returns true if the given plugin exists at the given version number or greater.

func IsPluginKind

func IsPluginKind(k string) bool

IsPluginKind returns true if k is a valid plugin kind, and false otherwise.

func IsTemplateURL

func IsTemplateURL(templateNamePathOrURL string) bool

IsTemplateURL returns true if templateNamePathOrURL starts with "https://".

func NewMissingError

func NewMissingError(info PluginInfo) error

NewMissingError allocates a new error indicating the given plugin info was not found.

func ReadCloserProgressBar

func ReadCloserProgressBar(
	closer io.ReadCloser, size int64, message string, colorization colors.Colorization) io.ReadCloser

ReadCloserProgressBar displays a progress bar for the given closer and returns a wrapper closer to manipulate it.

func RetrieveGitFolder added in v2.6.0

func RetrieveGitFolder(rawurl string, path string) (string, error)

RetrieveGitFolder downloads the repo to path and returns the full path on disk.

func SaveProject

func SaveProject(proj *Project) error

SaveProject saves the project file on top of the existing one, using the standard location.

func SaveProjectStack

func SaveProjectStack(stackName tokens.QName, stack *ProjectStack) error

func StoreAccount

func StoreAccount(key string, account Account, current bool) error

StoreAccount saves the given account underneath the given key.

func StoreCredentials

func StoreCredentials(creds Credentials) error

StoreCredentials updates the stored credentials on the machine, replacing the existing set. If the credentials are empty, the auth file will be deleted rather than just serializing an empty map.

func ValidateProjectDescription

func ValidateProjectDescription(s string) error

ValidateProjectDescription ensures a project description name is valid, if it is not it returns an error with a message suitable for display to an end user.

func ValidateProjectName

func ValidateProjectName(s string) error

ValidateProjectName ensures a project name is valid, if it is not it returns an error with a message suitable for display to an end user.

func ValueOrDefaultProjectDescription

func ValueOrDefaultProjectDescription(
	description string, projectDescription string, defaultDescription string) string

ValueOrDefaultProjectDescription returns the value or defaultDescription.

func ValueOrSanitizedDefaultProjectName

func ValueOrSanitizedDefaultProjectName(name string, projectName string, defaultNameToSanitize string) string

ValueOrSanitizedDefaultProjectName returns the value or a sanitized valid project name based on defaultNameToSanitize.

Types

type Account

type Account struct {
	AccessToken     string    `json:"accessToken,omitempty"`     // The access token for this account.
	Username        string    `json:"username,omitempty"`        // The username for this account.
	LastValidatedAt time.Time `json:"lastValidatedAt,omitempty"` // The last time this token was validated.
}

Account holds the information associated with a Pulumi account.

func GetAccount

func GetAccount(key string) (Account, error)

GetAccount returns an account underneath a given key.

Note that the account may not be fully populated: it may only have a valid AccessToken. In that case, it is up to the caller to fill in the username and last validation time.

type Analyzers

type Analyzers []tokens.QName

Analyzers is a list of analyzers to run on this project.

type Credentials

type Credentials struct {
	Current      string             `json:"current,omitempty"`      // the currently selected key.
	AccessTokens map[string]string  `json:"accessTokens,omitempty"` // a map of arbitrary key strings to tokens.
	Accounts     map[string]Account `json:"accounts,omitempty"`     // a map of arbitrary keys to account info.
}

Credentials hold the information necessary for authenticating Pulumi Cloud API requests. It contains a map from the cloud API URL to the associated access token.

func GetStoredCredentials

func GetStoredCredentials() (Credentials, error)

GetStoredCredentials returns any credentials stored on the local machine.

type MissingError

type MissingError struct {
	// Info contains information about the plugin that was not found.
	Info PluginInfo
}

MissingError is returned by functions that attempt to load plugins if a plugin can't be located.

func (*MissingError) Error

func (err *MissingError) Error() string

type PluginInfo

type PluginInfo struct {
	Name         string          // the simple name of the plugin.
	Path         string          // the path that a plugin was loaded from.
	Kind         PluginKind      // the kind of the plugin (language, resource, etc).
	Version      *semver.Version // the plugin's semantic version, if present.
	Size         int64           // the size of the plugin, in bytes.
	InstallTime  time.Time       // the time the plugin was installed.
	LastUsedTime time.Time       // the last time the plugin was used.
	ServerURL    string          // an optional server to use when downloading this plugin.
	PluginDir    string          // if set, will be used as the root plugin dir instead of ~/.pulumi/plugins.
}

PluginInfo provides basic information about a plugin. Each plugin gets installed into a system-wide location, by default `~/.pulumi/plugins/<kind>-<name>-<version>/`. A plugin may contain multiple files, however the primary loadable executable must be named `pulumi-<kind>-<name>`.

func GetPlugins

func GetPlugins() ([]PluginInfo, error)

GetPlugins returns a list of installed plugins.

func SelectCompatiblePlugin

func SelectCompatiblePlugin(
	plugins []PluginInfo, kind PluginKind, name string, requested semver.Range) (PluginInfo, error)

SelectCompatiblePlugin selects a plugin from the list of plugins with the given kind and name that sastisfies the requested semver range. It returns the highest version plugin that satisfies the requested constraints, or an error if no such plugin could be found.

If there exist plugins in the plugin list that don't have a version, SelectCompatiblePlugin will select them if there are no other compatible plugins available.

func (PluginInfo) Delete

func (info PluginInfo) Delete() error

Delete removes the plugin from the cache. It also deletes any supporting files in the cache, which includes any files that contain the same prefix as the plugin itself.

func (PluginInfo) Dir

func (info PluginInfo) Dir() string

Dir gets the expected plugin directory for this plugin.

func (PluginInfo) DirPath

func (info PluginInfo) DirPath() (string, error)

DirPath returns the directory where this plugin should be installed.

func (PluginInfo) Download

func (info PluginInfo) Download() (io.ReadCloser, int64, error)

Download fetches an io.ReadCloser for this plugin and also returns the size of the response (if known).

func (PluginInfo) File

func (info PluginInfo) File() string

File gets the expected filename for this plugin.

func (PluginInfo) FilePath

func (info PluginInfo) FilePath() (string, error)

FilePath returns the full path where this plugin's primary executable should be installed.

func (PluginInfo) FilePrefix

func (info PluginInfo) FilePrefix() string

FilePrefix gets the expected default file prefix for the plugin.

func (PluginInfo) FileSuffix

func (info PluginInfo) FileSuffix() string

FileSuffix returns the suffix for the plugin (if any).

func (PluginInfo) Install

func (info PluginInfo) Install(tgz io.ReadCloser) error

Install installs a plugin's tarball into the cache. It validates that plugin names are in the expected format. Previous versions of Pulumi extracted the tarball to a temp directory first, and then renamed the temp directory to the final directory. The rename operation fails often enough on Windows due to aggressive virus scanners opening files in the temp directory. To address this, we now extract the tarball directly into the final directory, and use file locks to prevent concurrent installs. Each plugin has its own file lock, with the same name as the plugin directory, with a `.lock` suffix. During installation an empty file with a `.partial` suffix is created, indicating that installation is in-progress. The `.partial` file is deleted when installation is complete, indicating that the plugin has finished installing. If a failure occurs during installation, the `.partial` file will remain, indicating the plugin wasn't fully installed. The next time the plugin is installed, the old installation directory will be removed and replaced with a fresh install.

func (PluginInfo) LockFilePath added in v2.14.0

func (info PluginInfo) LockFilePath() (string, error)

LockFilePath returns the full path to the plugin's lock file used during installation to prevent concurrent installs.

func (PluginInfo) PartialFilePath added in v2.14.0

func (info PluginInfo) PartialFilePath() (string, error)

PartialFilePath returns the full path to the plugin's partial file used during installation to indicate installation of the plugin hasn't completed yet.

func (*PluginInfo) SetFileMetadata

func (info *PluginInfo) SetFileMetadata(path string) error

SetFileMetadata adds extra metadata from the given file, representing this plugin's directory.

func (PluginInfo) String

func (info PluginInfo) String() string

type PluginKind

type PluginKind string

PluginKind represents a kind of a plugin that may be dynamically loaded and used by Pulumi.

const (
	// AnalyzerPlugin is a plugin that can be used as a resource analyzer.
	AnalyzerPlugin PluginKind = "analyzer"
	// LanguagePlugin is a plugin that can be used as a language host.
	LanguagePlugin PluginKind = "language"
	// ResourcePlugin is a plugin that can be used as a resource provider for custom CRUD operations.
	ResourcePlugin PluginKind = "resource"
)

type PluginProject added in v2.10.1

type PluginProject struct {
	// Runtime is a required runtime that executes code.
	Runtime ProjectRuntimeInfo `json:"runtime" yaml:"runtime"`
}

func LoadPluginProject added in v2.10.1

func LoadPluginProject(path string) (*PluginProject, error)

LoadPluginProject reads a plugin project definition from a file.

func (*PluginProject) Validate added in v2.10.1

func (proj *PluginProject) Validate() error

type PolicyPackProject

type PolicyPackProject struct {
	// Runtime is a required runtime that executes code.
	Runtime ProjectRuntimeInfo `json:"runtime" yaml:"runtime"`
	// Version specifies the version of the policy pack. If set, it will override the
	// version specified in `package.json` for Node.js policy packs.
	Version string `json:"version,omitempty" yaml:"version,omitempty"`

	// Main is an optional override for the program's main entry-point location.
	Main string `json:"main,omitempty" yaml:"main,omitempty"`

	// Description is an optional informational description.
	Description *string `json:"description,omitempty" yaml:"description,omitempty"`
	// Author is an optional author that created this project.
	Author *string `json:"author,omitempty" yaml:"author,omitempty"`
	// Website is an optional website for additional info about this project.
	Website *string `json:"website,omitempty" yaml:"website,omitempty"`
	// License is the optional license governing this project's usage.
	License *string `json:"license,omitempty" yaml:"license,omitempty"`
}

func LoadPolicyPack

func LoadPolicyPack(path string) (*PolicyPackProject, error)

LoadPolicyPack reads a policy pack definition from a file.

func (*PolicyPackProject) Save added in v2.3.0

func (proj *PolicyPackProject) Save(path string) error

Save writes a project definition to a file.

func (*PolicyPackProject) Validate

func (proj *PolicyPackProject) Validate() error

type PolicyPackTemplate

type PolicyPackTemplate struct {
	Dir         string // The directory containing PulumiPolicy.yaml.
	Name        string // The name of the template.
	Description string // Description of the template.
}

PolicyPackTemplate represents a Policy Pack template.

func LoadPolicyPackTemplate

func LoadPolicyPackTemplate(path string) (PolicyPackTemplate, error)

LoadPolicyPackTemplate returns a Policy Pack template from a path.

type Project

type Project struct {
	// Name is a required fully qualified name.
	Name tokens.PackageName `json:"name" yaml:"name"`
	// Runtime is a required runtime that executes code.
	Runtime ProjectRuntimeInfo `json:"runtime" yaml:"runtime"`
	// Main is an optional override for the program's main entry-point location.
	Main string `json:"main,omitempty" yaml:"main,omitempty"`

	// Description is an optional informational description.
	Description *string `json:"description,omitempty" yaml:"description,omitempty"`
	// Author is an optional author that created this project.
	Author *string `json:"author,omitempty" yaml:"author,omitempty"`
	// Website is an optional website for additional info about this project.
	Website *string `json:"website,omitempty" yaml:"website,omitempty"`
	// License is the optional license governing this project's usage.
	License *string `json:"license,omitempty" yaml:"license,omitempty"`

	// Config indicates where to store the Pulumi.<stack-name>.yaml files, combined with the folder Pulumi.yaml is in.
	Config string `json:"config,omitempty" yaml:"config,omitempty"`

	// Template is an optional template manifest, if this project is a template.
	Template *ProjectTemplate `json:"template,omitempty" yaml:"template,omitempty"`

	// Backend is an optional backend configuration
	Backend *ProjectBackend `json:"backend,omitempty" yaml:"backend,omitempty"`
}

Project is a Pulumi project manifest.

We explicitly add yaml tags (instead of using the default behavior from https://github.com/ghodss/yaml which works in terms of the JSON tags) so we can directly marshall and unmarshall this struct using go-yaml an have the fields in the serialized object match the order they are defined in this struct.

TODO[pulumi/pulumi#423]: use DOM based marshalling so we can roundtrip the seralized structure perfectly.

func DetectProject

func DetectProject() (*Project, error)

DetectProject loads the closest project from the current working directory, or an error if not found.

func DetectProjectAndPath

func DetectProjectAndPath() (*Project, string, error)

DetectProjectAndPath loads the closest package from the current working directory, or an error if not found. It also returns the path where the package was found.

func LoadProject

func LoadProject(path string) (*Project, error)

LoadProject reads a project definition from a file.

func (*Project) Save

func (proj *Project) Save(path string) error

Save writes a project definition to a file.

func (*Project) TrustResourceDependencies

func (proj *Project) TrustResourceDependencies() bool

TrustResourceDependencies returns whether or not this project's runtime can be trusted to accurately report dependencies. All languages supported by Pulumi today do this correctly. This option remains useful when bringing up new Pulumi languages.

func (*Project) Validate

func (proj *Project) Validate() error

type ProjectBackend

type ProjectBackend struct {
	// URL is optional field to explicitly set backend url
	URL string `json:"url,omitempty" yaml:"url,omitempty"`
}

ProjectBackend is a configuration for backend used by project

type ProjectRuntimeInfo

type ProjectRuntimeInfo struct {
	// contains filtered or unexported fields
}

func NewProjectRuntimeInfo

func NewProjectRuntimeInfo(name string, options map[string]interface{}) ProjectRuntimeInfo

func (ProjectRuntimeInfo) MarshalJSON

func (info ProjectRuntimeInfo) MarshalJSON() ([]byte, error)

func (ProjectRuntimeInfo) MarshalYAML

func (info ProjectRuntimeInfo) MarshalYAML() (interface{}, error)

func (*ProjectRuntimeInfo) Name

func (info *ProjectRuntimeInfo) Name() string

func (*ProjectRuntimeInfo) Options

func (info *ProjectRuntimeInfo) Options() map[string]interface{}

func (*ProjectRuntimeInfo) SetOption added in v2.3.0

func (info *ProjectRuntimeInfo) SetOption(key string, value interface{})

func (*ProjectRuntimeInfo) UnmarshalJSON

func (info *ProjectRuntimeInfo) UnmarshalJSON(data []byte) error

func (*ProjectRuntimeInfo) UnmarshalYAML

func (info *ProjectRuntimeInfo) UnmarshalYAML(unmarshal func(interface{}) error) error

type ProjectStack

type ProjectStack struct {
	// SecretsProvider is this stack's secrets provider.
	SecretsProvider string `json:"secretsprovider,omitempty" yaml:"secretsprovider,omitempty"`
	// EncryptedKey is the KMS-encrypted ciphertext for the data key used for secrets encryption.
	// Only used for cloud-based secrets providers.
	EncryptedKey string `json:"encryptedkey,omitempty" yaml:"encryptedkey,omitempty"`
	// EncryptionSalt is this stack's base64 encoded encryption salt.  Only used for
	// passphrase-based secrets providers.
	EncryptionSalt string `json:"encryptionsalt,omitempty" yaml:"encryptionsalt,omitempty"`
	// Config is an optional config bag.
	Config config.Map `json:"config,omitempty" yaml:"config,omitempty"`
}

ProjectStack holds stack specific information about a project.

func DetectProjectStack

func DetectProjectStack(stackName tokens.QName) (*ProjectStack, error)

func LoadProjectStack

func LoadProjectStack(path string) (*ProjectStack, error)

LoadProjectStack reads a stack definition from a file.

func (*ProjectStack) Save

func (ps *ProjectStack) Save(path string) error

Save writes a project definition to a file.

type ProjectTemplate

type ProjectTemplate struct {
	// Description is an optional description of the template.
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	// Quickstart contains optional text to be displayed after template creation.
	Quickstart string `json:"quickstart,omitempty" yaml:"quickstart,omitempty"`
	// Config is an optional template config.
	Config map[string]ProjectTemplateConfigValue `json:"config,omitempty" yaml:"config,omitempty"`
	// Important indicates the template is important and should be listed by default.
	Important bool `json:"important,omitempty" yaml:"important,omitempty"`
}

ProjectTemplate is a Pulumi project template manifest.

type ProjectTemplateConfigValue

type ProjectTemplateConfigValue struct {
	// Description is an optional description for the config value.
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	// Default is an optional default value for the config value.
	Default string `json:"default,omitempty" yaml:"default,omitempty"`
	// Secret may be set to true to indicate that the config value should be encrypted.
	Secret bool `json:"secret,omitempty" yaml:"secret,omitempty"`
}

ProjectTemplateConfigValue is a config value included in the project template manifest.

type Settings

type Settings struct {
	// Stack is an optional default stack to use.
	Stack string `json:"stack,omitempty" yaml:"env,omitempty"`
}

Settings defines workspace settings shared amongst many related projects.

func (*Settings) IsEmpty

func (s *Settings) IsEmpty() bool

IsEmpty returns true when the settings object is logically empty (no selected stack and nothing in the deprecated configuration bag).

type SortedPluginInfo

type SortedPluginInfo []PluginInfo

SortedPluginInfo is a wrapper around PluginInfo that allows for sorting by version.

func (SortedPluginInfo) Len

func (sp SortedPluginInfo) Len() int

func (SortedPluginInfo) Less

func (sp SortedPluginInfo) Less(i, j int) bool

func (SortedPluginInfo) Swap

func (sp SortedPluginInfo) Swap(i, j int)

type Template

type Template struct {
	Dir         string                                // The directory containing Pulumi.yaml.
	Name        string                                // The name of the template.
	Description string                                // Description of the template.
	Quickstart  string                                // Optional text to be displayed after template creation.
	Config      map[string]ProjectTemplateConfigValue // Optional template config.
	Important   bool                                  // Indicates whether the template should be listed by default.

	ProjectName        string // Name of the project.
	ProjectDescription string // Optional description of the project.
}

Template represents a project template.

func LoadTemplate

func LoadTemplate(path string) (Template, error)

LoadTemplate returns a template from a path.

type TemplateKind

type TemplateKind int

TemplateKind describes the form of a template.

const (
	// TemplateKindPulumiProject is a template for a Pulumi stack.
	TemplateKindPulumiProject TemplateKind = 0

	// TemplateKindPolicyPack is a template for a Policy Pack.
	TemplateKindPolicyPack TemplateKind = 1
)

type TemplateRepository

type TemplateRepository struct {
	Root         string // The full path to the root directory of the repository.
	SubDirectory string // The full path to the sub directory within the repository.
	ShouldDelete bool   // Whether the root directory should be deleted.
}

TemplateRepository represents a repository of templates.

func RetrieveTemplates

func RetrieveTemplates(templateNamePathOrURL string, offline bool,
	templateKind TemplateKind) (TemplateRepository, error)

RetrieveTemplates retrieves a "template repository" based on the specified name, path, or URL.

func (TemplateRepository) Delete

func (repo TemplateRepository) Delete() error

Delete deletes the template repository.

func (TemplateRepository) PolicyTemplates

func (repo TemplateRepository) PolicyTemplates() ([]PolicyPackTemplate, error)

PolicyTemplates lists the policy templates in the repository.

func (TemplateRepository) Templates

func (repo TemplateRepository) Templates() ([]Template, error)

Templates lists the templates in the repository.

type W

type W interface {
	Settings() *Settings // returns a mutable pointer to the optional workspace settings info.
	Save() error         // saves any modifications to the workspace.
}

W offers functionality for interacting with Pulumi workspaces.

func New

func New() (W, error)

New creates a new workspace using the current working directory.

func NewFrom

func NewFrom(dir string) (W, error)

NewFrom creates a new Pulumi workspace in the given directory. Requires a Pulumi.yaml file be present in the folder hierarchy between dir and the .pulumi folder.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL