Skip to content

[doc issue] Terraforming Kyma Runtimes - Procedure Setup of Terraform Configuration #32

@lechnerc77

Description

@lechnerc77

Issue description

The description of setting up the Terraform configuration is not correct and does not correspond to the good practices of Terraform:

  • Putting the complete configuration in a main.tf file is not recommended. It should be split at least into different files namely main.tf, variables.tf, provider.tf and outputs.tf. Even in case of a quick start guide this should be considered
  • The variables should be put in a terraform.tfvars file. A file called .tfvars is nothing I have ever seen
  • A definition of the variables is completely missing
  • There are no version constraints for the providers which can lead to unintended updates of provider versions
  • The statement that the .tfvars contains the required parameters is wrong. It contains the required parameters and the optional parameters that should be set based on the users requirements.
  • The service_instance_id parameter is semantically wrong, it is the environment instance ID
  • The "Run Terraform in your root (tf) module folder:" the first command is misleading as it cds into the folder
  • Executing the script without a terraform plan -out=plan.out is not recommended
  • The -auto-approve is valid in a CI/CD pipeline, however it sould be mentioned that when locally trying the setup this should be omitted

Feedback Type (Optional)

incorrect statement

Page Title on SAP Help Portal (prefilled)

Terraforming Kyma Runtimes

Page URL on SAP Help Portal (prefilled)

https://help.sap.com/docs/btp/btp-developers-guide/terraforming-kyma-runtimes?version=LATEST

Metadata

Metadata

Assignees

No one assigned

    Labels

    contributionValuable Contributionua-reviewUnder review by the UA team.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions