README
¶
OTF is an open source alternative to Terraform Enterprise. Includes SSO, team management, agents, and no per-resource pricing.
Docs: https://docs.otf.ninja/
Looking for a TUI for terraform? Check out PUG.
Legal
OTF is in no way affiliated with Hashicorp. Terraform and Terraform Enterprise are trademarks of Hashicorp. Hashicorp have confirmed OTF is in compliance with their BSL license.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd provides CLI functionality.
|
Package cmd provides CLI functionality. |
|
otf
command
|
|
|
otf-agent
command
|
|
|
otfd
command
|
|
|
Package internal is code only for consumption from within the otf project.
|
Package internal is code only for consumption from within the otf project. |
|
api
Package api provides commmon functionality for the OTF API
|
Package api provides commmon functionality for the OTF API |
|
authenticator
Package authenticator is responsible for handling the authentication of users with third party identity providers.
|
Package authenticator is responsible for handling the authentication of users with third party identity providers. |
|
authz
Package authz handles all things authorization, policing who (subjects) can do what (actions) on what (resources).
|
Package authz handles all things authorization, policing who (subjects) can do what (actions) on what (resources). |
|
cli
Package cli provides the CLI client, i.e.
|
Package cli provides the CLI client, i.e. |
|
configversion
Package configversion handles terraform configurations.
|
Package configversion handles terraform configurations. |
|
configversion/source
templ: version: v0.3.943
|
templ: version: v0.3.943 |
|
connections
Package connections manages connections between VCS repositories and OTF resources, e.g.
|
Package connections manages connections between VCS repositories and OTF resources, e.g. |
|
daemon
Package daemon configures and starts the otfd daemon and its subsystems.
|
Package daemon configures and starts the otfd daemon and its subsystems. |
|
disco
Package disco implements terraform's "remote service discovery protocol":
|
Package disco implements terraform's "remote service discovery protocol": |
|
engine
Package engine manages the CLI engine binaries that carry out run operations.
|
Package engine manages the CLI engine binaries that carry out run operations. |
|
forgejo
templ: version: v0.3.943
|
templ: version: v0.3.943 |
|
github
Package github provides github related code
|
Package github provides github related code |
|
gitlab
Package gitlab provides gitlab related code
|
Package gitlab provides gitlab related code |
|
http
This succint etag middleware has been borrowed from:
|
This succint etag middleware has been borrowed from: |
|
http/decode
Package decode contains decoders for various HTTP artefacts
|
Package decode contains decoders for various HTTP artefacts |
|
http/html
Package html contains code relating specifically to the web UI.
|
Package html contains code relating specifically to the web UI. |
|
http/html/components
templ: version: v0.3.943
|
templ: version: v0.3.943 |
|
http/html/components/paths
Package paths are paths for use in templ templates.
|
Package paths are paths for use in templ templates. |
|
http/html/paths
Package paths provides rails-style path helpers for use with the web app.
|
Package paths provides rails-style path helpers for use with the web app. |
|
inmem
Package inmem implements a layer of services in memory using purely Go constructs.
|
Package inmem implements a layer of services in memory using purely Go constructs. |
|
integration
Package integration provides inter-service integration tests.
|
Package integration provides inter-service integration tests. |
|
json
Package json provides helpers for the JSON encoding.
|
Package json provides helpers for the JSON encoding. |
|
loginserver
Package loginserver implements a "terraform login protocol" server:
|
Package loginserver implements a "terraform login protocol" server: |
|
logr
Package logr provides a logger that implements the logr interface
|
Package logr provides a logger that implements the logr interface |
|
module
Package module is reponsible for registry modules
|
Package module is reponsible for registry modules |
|
notifications
Package notifications sends notifications for run state transitions and workspace events.
|
Package notifications sends notifications for run state transitions and workspace events. |
|
organization
Package organization is responsible for OTF organizations
|
Package organization is responsible for OTF organizations |
|
pubsub
Package pubsub provides cluster-wide publishing and subscribing of events
|
Package pubsub provides cluster-wide publishing and subscribing of events |
|
repohooks
Package repohooks manages webhooks for VCS events
|
Package repohooks manages webhooks for VCS events |
|
resource
Package resource contains code common to all resources (orgs, workspaces, runs, etc)
|
Package resource contains code common to all resources (orgs, workspaces, runs, etc) |
|
run
Package run is responsible for OTF runs, the primary mechanism for executing terraform
|
Package run is responsible for OTF runs, the primary mechanism for executing terraform |
|
runner
Package runner contains the runner, the component responsible for carrying out runs by executing terraform processes, either as part of the server or remotely via agents.
|
Package runner contains the runner, the component responsible for carrying out runs by executing terraform processes, either as part of the server or remotely via agents. |
|
runstatus
Package runstatus provides run statuses.
|
Package runstatus provides run statuses. |
|
semver
Package semver wraps golang.org/x/mod/semver, relaxing the requirement for semantic versions to be prefixed with "v".
|
Package semver wraps golang.org/x/mod/semver, relaxing the requirement for semantic versions to be prefixed with "v". |
|
sql
Package sql implements persistent storage using the postgres database.
|
Package sql implements persistent storage using the postgres database. |
|
state
Package state manages terraform state.
|
Package state manages terraform state. |
|
team
Package team manages teams, which are groups of users with shared privileges.
|
Package team manages teams, which are groups of users with shared privileges. |
|
testbrowser
Package testbrowser provides browsers for e2e tests
|
Package testbrowser provides browsers for e2e tests |
|
testcompose
Package testcompose provides interaction with a docker compose stack of services for testing purposes.
|
Package testcompose provides interaction with a docker compose stack of services for testing purposes. |
|
testutils
Package testutils provides test helpers.
|
Package testutils provides test helpers. |
|
tfeapi
Package tfeapi provides common functionality useful for implementation of the Hashicorp TFE/TFC API, which uses the json:api encoding
|
Package tfeapi provides common functionality useful for implementation of the Hashicorp TFE/TFC API, which uses the json:api encoding |
|
tfeapi/types
Package types provides structs suitable for marshaling to/from json:api
|
Package types provides structs suitable for marshaling to/from json:api |
|
tokens
Package tokens manages token authentication
|
Package tokens manages token authentication |
|
ui
templ: version: v0.3.943
|
templ: version: v0.3.943 |
|
user
Package user manages user accounts and their team membership.
|
Package user manages user accounts and their team membership. |
|
variable
Package variable manages terraform workspace variables
|
Package variable manages terraform workspace variables |
|
vcs
Package vcs handles version control system stuff.
|
Package vcs handles version control system stuff. |
|
workspace
Package workspace provides access to terraform workspaces
|
Package workspace provides access to terraform workspaces |
Click to show internal directories.
Click to hide internal directories.