Remove the Terraform CLI from the provider package and deprecate the relevant provider command-line flags #434
Conversation
deprecate the relevant provider command-line flags. - Increase the default value `--max-reconcile-rate` from 10 to 100 - Deprecate the following provider command-line flags: - terraform-version - terraform-provider-version - terraform-native-provider-path - terraform-provider-source - provider-ttl Signed-off-by: Alper Rifat Ulucinar <[email protected]>
|
/test-examples="examples/cloudplatform/serviceaccountkey.yaml" |
|
/test-examples="examples/storage/bucketacl.yaml" |
|
/test-examples="examples/sql/instance.yaml" |
|
/test-examples="examples/cloudplatform/serviceaccount.yaml" |
|
I've also verified the |
There was a problem hiding this comment.
Thanks @ulucinar LGTM! I left a few comments to document some points.
| export TERRAFORM_PROVIDER_VERSION := 4.77.0 | ||
| export TERRAFORM_PROVIDER_DOWNLOAD_NAME := terraform-provider-google | ||
| export TERRAFORM_PROVIDER_DOWNLOAD_URL_PREFIX := https://releases.hashicorp.com/terraform-provider-google/$(TERRAFORM_PROVIDER_VERSION) | ||
| export TERRAFORM_PROVIDER_SOURCE := hashicorp/google |
There was a problem hiding this comment.
Do we still need this variable?
There was a problem hiding this comment.
Hi @sergenyalcin,
We now use TERRAFORM_PROVIDER_SOURCE and the like while extracting the Terraform provider metadata and for generating the schema.json. However, it's no longer used at runtime or for downloading the Terraform provider image while building the provider package.
| return func(ctx context.Context, client client.Client, mg resource.Managed) (terraform.Setup, error) { | ||
| ps := terraform.Setup{ |
There was a problem hiding this comment.
When we leave the TF CLI base reconciliations for every upjet-based provider, do we consider deprecating and removing these setup fields: Version, Requirement, Scheduler?
There was a problem hiding this comment.
I think we may keep them for the other community upjet-based providers. Maintainers of those providers may prefer to integrate via the CLI because that integration happens at a higher layer.
Description of your changes
With #424, we have switched to the Terraform plugin SDK-based reconciliation for all the available managed resources in this provider. This PR removes the Terraform CLI and the Terraform Google provider binaries from the built provider package. We still need to generate the
config/schema.jsonfor diff detection purposes and for the code generation pipeline, and we are planning to address the issue of generating theschema.jsonwithout the TF CLI in a follow-up PR.We are also deprecating the following process-forking related command-line arguments:
terraform-versionterraform-provider-versionterraform-native-provider-pathterraform-provider-sourceprovider-ttlWhat the user will see in the provider logs if she uses any of these flags is something like the following:
These logs will be available even if the
debuglogging is not enabled for the provider.This PR also bumps the
--max-reconcile-ratecommand-line option's default to 100 to leverage the SDK-based reconciliation runtime's performance improvements.I have:
make reviewable testto ensure this PR is ready for review.How has this code been tested
Via uptest runs and manually with
index.docker.io/ulucinar/provider-gcp-cloudplatform:v0.40.0-208a3a3a33d002c712baed74f23805b25d64805c.