README
¶
Codeinfra Golang SDK
This directory contains support for writing Codeinfra programs in the Go language. There are two aspects to this:
codeinfra/contains the client language bindings Codeinfra program's code directly against;codeinfra-language-go/contains the language host plugin that the Codeinfra engine uses to orchestrate updates.
To author a Codeinfra program in Go, simply say so in your Codeinfra.yaml
name: <my-project>
runtime: go
and ensure you have codeinfra-language-go on your path (it is distributed in the Codeinfra download automatically).
By default, the language plugin will use your project's name, <my-project>, as the executable that it loads. This too
must be on your path for the language provider to load it when you run codeinfra preview or codeinfra up.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auto contains the Codeinfra Automation API, the programmatic interface for driving Codeinfra programs without the CLI.
|
Package auto contains the Codeinfra Automation API, the programmatic interface for driving Codeinfra programs without the CLI. |
|
optdestroy
Package optdestroy contains functional options to be used with stack destroy operations github.com/sdk/v2/go/x/auto Stack.Destroy(...optdestroy.Option)
|
Package optdestroy contains functional options to be used with stack destroy operations github.com/sdk/v2/go/x/auto Stack.Destroy(...optdestroy.Option) |
|
opthistory
Package opthistory contains functional options to be used with stack history operations github.com/sdk/v3/go/x/auto Stack.History(ctx, pageSize, page, ...opthistory.Option)
|
Package opthistory contains functional options to be used with stack history operations github.com/sdk/v3/go/x/auto Stack.History(ctx, pageSize, page, ...opthistory.Option) |
|
optimport
Package optimport contains functional options to be used with workspace stack import operations github.com/sdk/v3/go/auto workspace.Import(context.Context, ...optimport.Option)
|
Package optimport contains functional options to be used with workspace stack import operations github.com/sdk/v3/go/auto workspace.Import(context.Context, ...optimport.Option) |
|
optlist
Package optlist contains functional options to be used with workspace stack list operations github.com/sdk/v3/go/auto workspace.ListStacks(context.Context, ...optlist.Option)
|
Package optlist contains functional options to be used with workspace stack list operations github.com/sdk/v3/go/auto workspace.ListStacks(context.Context, ...optlist.Option) |
|
optpreview
Package optpreview contains functional options to be used with stack preview operations github.com/sdk/v2/go/x/auto Stack.Preview(...optpreview.Option)
|
Package optpreview contains functional options to be used with stack preview operations github.com/sdk/v2/go/x/auto Stack.Preview(...optpreview.Option) |
|
optrefresh
Package optrefresh contains functional options to be used with stack refresh operations github.com/sdk/v2/go/x/auto Stack.Refresh(...optrefresh.Option)
|
Package optrefresh contains functional options to be used with stack refresh operations github.com/sdk/v2/go/x/auto Stack.Refresh(...optrefresh.Option) |
|
optremotedestroy
Package optremotedestroy contains functional options to be used with remote stack destroy operations github.com/sdk/v3/go/auto RemoteStack.Destroy(...optremotedestroy.Option)
|
Package optremotedestroy contains functional options to be used with remote stack destroy operations github.com/sdk/v3/go/auto RemoteStack.Destroy(...optremotedestroy.Option) |
|
optremotepreview
Package optremotepreview contains functional options to be used with remote stack preview operations github.com/sdk/v3/go/auto RemoteStack.Preview(...optremotepreview.Option)
|
Package optremotepreview contains functional options to be used with remote stack preview operations github.com/sdk/v3/go/auto RemoteStack.Preview(...optremotepreview.Option) |
|
optremoterefresh
Package optremoterefresh contains functional options to be used with remote stack refresh operations github.com/sdk/v3/go/auto RemoteStack.Refresh(...optremoterefresh.Option)
|
Package optremoterefresh contains functional options to be used with remote stack refresh operations github.com/sdk/v3/go/auto RemoteStack.Refresh(...optremoterefresh.Option) |
|
optremoteup
Package optremoteup contains functional options to be used with remote stack updates github.com/sdk/v3/go/auto RemoteStack.Up(...optremoteup.Option)
|
Package optremoteup contains functional options to be used with remote stack updates github.com/sdk/v3/go/auto RemoteStack.Up(...optremoteup.Option) |
|
optremove
Package optremove contains functional options to be used with workspace stack remove operations github.com/sdk/v2/go/x/auto workspace.RemoveStack(stackName, ...optremove.Option)
|
Package optremove contains functional options to be used with workspace stack remove operations github.com/sdk/v2/go/x/auto workspace.RemoveStack(stackName, ...optremove.Option) |
|
optup
Package optup contains functional options to be used with stack updates github.com/sdk/v2/go/x/auto Stack.Up(...optup.Option)
|
Package optup contains functional options to be used with stack updates github.com/sdk/v2/go/x/auto Stack.Up(...optup.Option) |
|
generate
command
|
|
|
codeinfra-internal
|
|
|
common
|
|
|
apitype
Package apitype contains the full set of "exchange types" that are serialized and sent across separately versionable boundaries, including service APIs, plugins, and file formats.
|
Package apitype contains the full set of "exchange types" that are serialized and sent across separately versionable boundaries, including service APIs, plugins, and file formats. |
|
apitype/migrate
Package migrate is responsible for converting to and from the various API type versions that are in use in Codeinfra.
|
Package migrate is responsible for converting to and from the various API type versions that are in use in Codeinfra. |
|
tail
tail provides a Go library that emulates the features of the BSD `tail` program.
|
tail provides a Go library that emulates the features of the BSD `tail` program. |
|
testing/diagtest
Package diagtest provides testing utilities for code that uses the common/diag package.
|
Package diagtest provides testing utilities for code that uses the common/diag package. |
|
testing/iotest
Package iotest provides testing utilities for code that uses the io package.
|
Package iotest provides testing utilities for code that uses the io package. |
|
tokens
Package tokens contains the core symbol and token types for referencing resources and related entities.
|
Package tokens contains the core symbol and token types for referencing resources and related entities. |
|
util/archive
Package archive provides support for creating .tar.gz/.tgz archives of local folders and returning the in-memory buffer.
|
Package archive provides support for creating .tar.gz/.tgz archives of local folders and returning the in-memory buffer. |
|
util/env
A small library for creating typed, consistent and documented environmental variable accesses.
|
A small library for creating typed, consistent and documented environmental variable accesses. |
|
util/rpcutil/rpcerror
Package rpcerror provides helper types and functions for dealing with errors that cross gRPC boundaries.
|
Package rpcerror provides helper types and functions for dealing with errors that cross gRPC boundaries. |
|
gen-pux-applyn
command
gen-pux-applyn generates Apply functions for the codeinfrax package.
|
gen-pux-applyn generates Apply functions for the codeinfrax package. |
|
The Codeinfra value system (formerly resource.PropertyValue)
|
The Codeinfra value system (formerly resource.PropertyValue) |
Click to show internal directories.
Click to hide internal directories.