Workspace Parameters sourced from Terraform

Coder Repo |Docs |Why Coder |Premium

This repository contains a component of Coder, currently called Preview, that extracts and managesworkspace parametersfrom Terraform configurations.

It provides real-time validation to verify user selections and compatibility while presenting dynamic form controls thatadapt based on previous choices.

As users select parameters from the template, Preview validates the selection for compatibility and user entitlements.The form updates other fields based on the selections and only shows relevant and compatible options.

Once Preview is incorporated in Coder, it will allow template admins to use a variety of form controls with dependenciesfrom which users can deploy their ideal workspaces.

Support

Do you have a workspace template that has incorrect parameters? Please openworkspace template behavior issue.

For other bugs, feature requests, etc, feel free toopen an issue.

Join our Discord to provide feedback on in-progressfeatures and chat with the community using Coder!

Constants¶

Variables¶

Functions¶

Types¶

type Input struct {// PlanJSONPath is an optional path to a plan file. If PlanJSON isn't// specified, and PlanJSONPath is, then the file will be read and treated// as if the contents were passed in directly.PlanJSONPathstringPlanJSONjson.RawMessageParameterValues map[string]stringOwnertypes.WorkspaceOwner}

func (iInput) RichParameterValue(keystring) (string,bool)

type Output struct {// ModuleOutput is any 'output' values from the terraform files. This has 0// effect on the parameters, tags, etc. It can be helpful for debugging, as it// allows exporting some terraform values to the caller to review.ModuleOutputcty.ValueParameters    []types.ParameterWorkspaceTagstypes.TagBlocks// Files is included for printing diagnostics.// TODO: Is the memory impact of this too much? Should we render diagnostic source code// into the diagnostics up front? and remove this?Files map[string]*hcl.File}

func Preview(ctxcontext.Context, inputInput, dirfs.FS) (output *Output, diagnostics hcl.Diagnostics)