Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/upbound/provider-terraform
A Crossplane provider for Terraform
https://github.com/upbound/provider-terraform
Last synced: 2 months ago
JSON representation
A Crossplane provider for Terraform
- Host: GitHub
- URL: https://github.com/upbound/provider-terraform
- Owner: upbound
- License: apache-2.0
- Created: 2022-10-05T21:03:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T20:27:12.000Z (3 months ago)
- Last Synced: 2024-10-24T08:08:44.787Z (3 months ago)
- Language: Go
- Homepage: https://marketplace.upbound.io/providers/upbound/provider-terraform/
- Size: 758 KB
- Stars: 143
- Watchers: 24
- Forks: 57
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-repositories - upbound/provider-terraform - A Crossplane provider for Terraform (Go)
README
# Official Terraform Provider
 [](https://github.com/upbound/provider-terraform/releases) [](https://goreportcard.com/report/github.com/upbound/provider-terraform) [](https://crossplane.slack.com/archives/C01TRKD4623) [](https://twitter.com/intent/follow?screen_name=upbound_io&user_id=788180534543339520)
Provider Terraform is a [Crossplane](https://crossplane.io/) provider that
can run Terraform code and enables defining new Crossplane Composite Resources (XRs)
that are composed of a mix of 'native' Crossplane managed resources and your
existing Terraform modules.
The Terraform provider adds support for a `Workspace` managed resource that
represents a Terraform workspace. The configuration of each workspace may be
either fetched from a remote source (e.g. git), or simply specified inline.
```yaml
apiVersion: tf.upbound.io/v1beta1
kind: Workspace
metadata:
name: example-inline
annotations:
# The terraform workspace will be named 'coolbucket'. If you omitted this
# annotation it would be derived from metadata.name - i.e. 'example-inline'.
crossplane.io/external-name: coolbucket
spec:
forProvider:
# For simple cases you can use an inline source to specify the content of
# main.tf as opaque, inline HCL.
source: Inline
module: |
// All outputs are written to the connection secret. Non-sensitive outputs
// are stored in the status.atProvider.outputs object.
output "url" {
value = google_storage_bucket.example.self_link
}
resource "random_id" "example" {
byte_length = 4
}
// The google provider and remote state are configured by the provider
// config - see examples/providerconfig.yaml.
resource "google_storage_bucket" "example" {
name = "crossplane-example-${terraform.workspace}-${random_id.example.hex}"
}
writeConnectionSecretToRef:
namespace: default
name: terraform-workspace-example-inline
```
```yaml
apiVersion: tf.upbound.io/v1beta1
kind: Workspace
metadata:
name: example-remote
annotations:
crossplane.io/external-name: myworkspace
spec:
forProvider:
# Use any module source supported by terraform init -from-module.
source: Remote
module: https://github.com/crossplane/tf
# Environment variables can be passed through
env:
- name: TF_VAR_varFromValue
value: 'value'
- name: ENV_FROM_CONFIGMAP
configMapKeyRef:
namespace: my-namespace
name: my-config-map
key: target-key
- name: ENV_FROM_SECRET
secretKeyRef:
namespace: my-namespace
name: my-secret
key: target-key
# Variables can be specified inline as a list of key-value pairs or as an json object, or loaded from a ConfigMap or Secret.
vars:
- key: region
value: us-west-1
varmap:
account:
region: us-west-1
owners:
- example-owner-1
- example-owner-2
varFiles:
- source: SecretKey
secretKeyRef:
namespace: default
name: terraform
key: example.tfvar.json
# All Terraform outputs are written to the connection secret.
writeConnectionSecretToRef:
namespace: default
name: terraform-workspace-example-inline
```
## Getting Started
Follow the quick start guide [here](https://marketplace.upbound.io/providers/upbound/provider-terraform/latest/docs/quickstart).
You can find a detailed API reference for all the managed resources with examples in the [Upbound Marketplace](https://marketplace.upbound.io/providers/upbound/provider-terraform/latest/managed-resources).
## Further Configuration
You can find more information about configuring the provider further [here](https://marketplace.upbound.io/providers/upbound/provider-terraform/latest/docs/configuration).
### Polling Interval
The default polling interval has been updated to 10 minutes from 1 minute.
This affects how often the provider will run `terraform plan` on existing
`Workspaces` to determine if there are any resources out of sync and whether
`terraform apply` needs to be re-executed to recover the desired state.
A 1 minute polling interval is often too short when the time required for
running `terrform init`, `terraform plan` and `terraform apply` is taken
into account. Workspaces with large numbers of resources can take longer
than 1 minute to run `terraform plan`. Changes to the `Workspace` object
`spec` will still be reconciled immediately. The poll interval is
configurable using `ControllerConfig`.
## Known limitations:
* You must either use remote state or ensure the provider container's `/tf`
directory is not lost. `provider-terraform` __does not persist state__;
consider using the [Kubernetes](https://www.terraform.io/docs/language/settings/backends/kubernetes.html) remote state backend.
* If the module takes longer than the value of `--timeout` (default is 20m) to apply the
underlying `terraform` process will be killed. You will potentially lose state
and leak resources. The workspace lock will also likely be left in place and need to be manually removed
before the Workspace can be reconciled again.
* The provider won't emit an event until _after_ it has successfully applied the
Terraform module, which can take a long time.
* Setting `--max-reconcile-rate` to a value greater than 1 will potentially cause the provider
to use up to the same number of CPUs. Add a resources section to the ControllerConfig to restrict
CPU usage as needed.
## Report a Bug
For filing bugs, suggesting improvements, or requesting new features, please
open an [issue](https://github.com/upbound/provider-terraform/issues).
## Contact
Please open a Github issue for all requests. If you need to reach out to Upbound,
you can do so via the following channels:
* Slack: [#upbound](https://crossplane.slack.com/archives/C01TRKD4623) channel in [Crossplane Slack](https://slack.crossplane.io)
* Twitter: [@upbound_io](https://twitter.com/upbound_io)
* Email: [[email protected]](mailto:[email protected])
## Licensing
Provider Terraform is under [the Apache 2.0 license](LICENSE) with [notice](NOTICE).