dynamicparameters
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Index¶
- Variables
- func ProvisionerVersionSupportsDynamicParameters(version string) bool
- func ResolveParameters(ctx context.Context, ownerID uuid.UUID, renderer Renderer, firstBuild bool, ...) (map[string]string, error)
- func TemplateVersionParameter(it database.TemplateVersionParameter) previewtypes.Parameter
- func WithProvisionerJob(job database.ProvisionerJob) func(r *loader)
- func WithTemplateVersion(tv database.TemplateVersion) func(r *loader)
- func WithTerraformValues(values database.TemplateVersionTerraformValue) func(r *loader)
- type Renderer
- type ResolverError
Constants¶
This section is empty.
Variables¶
var ErrTemplateVersionNotReady =xerrors.New("template version job not finished")Functions¶
funcResolveParameters¶
func ResolveParameters(ctxcontext.Context,ownerIDuuid.UUID,rendererRenderer,firstBuildbool,previousValues []database.WorkspaceBuildParameter,buildValues []codersdk.WorkspaceBuildParameter,presetValues []database.TemplateVersionPresetParameter,) (map[string]string,error)
funcTemplateVersionParameter¶
func TemplateVersionParameter(itdatabase.TemplateVersionParameter)previewtypes.Parameter
funcWithProvisionerJob¶
func WithProvisionerJob(jobdatabase.ProvisionerJob) func(r *loader)
funcWithTemplateVersion¶
func WithTemplateVersion(tvdatabase.TemplateVersion) func(r *loader)
funcWithTerraformValues¶
func WithTerraformValues(valuesdatabase.TemplateVersionTerraformValue) func(r *loader)
Types¶
typeRenderer¶
type Renderer interface {Render(ctxcontext.Context, ownerIDuuid.UUID, values map[string]string) (*preview.Output, hcl.Diagnostics)Close()}Renderer is able to execute and evaluate terraform with the given inputs.It may use the database to fetch additional state, such as a user's groups,roles, etc. Therefore, it requires an authenticated `ctx`.
'Close()' **must** be called once the renderer is no longer needed.Forgetting to do so will result in a memory leak.
funcPrepare¶
func Prepare(ctxcontext.Context, dbdatabase.Store, cachefiles.FileAcquirer, versionIDuuid.UUID, options ...func(r *loader)) (Renderer,error)
Prepare is the entrypoint for this package. It loads the necessary objects &files from the database and returns a Renderer that can be used to render thetemplate version's parameters.
typeResolverError¶
type ResolverError struct {Diagnostics hcl.DiagnosticsParameter map[string]hcl.Diagnostics}func (*ResolverError)Error¶
func (e *ResolverError) Error()string
Error is a pretty bad format for these errors. Try to avoid using this.
func (*ResolverError)Extend¶
func (e *ResolverError) Extend(parameterNamestring, diag hcl.Diagnostics)
func (*ResolverError)HasError¶
func (e *ResolverError) HasError()bool
Source Files
Directories¶
| Path | Synopsis |
|---|---|
Package rendermock is a generated GoMock package. | Package rendermock is a generated GoMock package. |