A spring-boot-based project which aims to provide a RESTful API for Terraform CLI.

Pass the terraform root folder name in the request and terraform-boot will execute the requested Terraform method on this directory.

If we intend to use this mode of script execution, then we must ensure the scripts root directory is accessible to terraform-boot runtime.

The terraform-boot application must have access to the root module folder under which each sub-folder is a module used per API request.

The default root folder where all module sub-folders will exist is the temp folder of the user running the server.

This configuration can be changed by updating the terraform.root.module.directory property.

All files needed for terraform execution can be passed as strings to API and terraform-boot will automatically execute the files and return terraform execution result.

• deploy - This wraps the Terraform plan and apply methods.
• destroy - This wraps the Terraform destroy method.
• validate - This wraps the Terraform validate method.
• plan - This wraps the Terraform 'plan' method.
• healthCheck - This method returns the status of the terraform-boot application

1. None - By default the API methods can be accessed without any authentication.
2. oauth - This can be enabled by activating spring profile - oauth

The below property names can be changed in the following ways

1. passing the property values to the server startup command as --${property-name}=${property-value}
2. Setting corresponding environment variables before starting the server.

Server can be compiled and started as below

If you have a fully configured OAuth instance running on your local system, then you can use the below way to start the application. The variables and their descriptions that need to be passed during oauth startup are recorded in the Available Configurations table.

1.Start with oauth

./mvmw clean install -DskipTests
$ java -jar target/terraform-boot-*.jar\
--spring.profiles.active=oauth \
--authorization.token.type=${token-type} \
--authorization.server.endpoint=${server-endpoint} \
--authorization.api.client.id=${client-id} \
--authorization.api.client.secret=${client-secret} \
--authorization.swagger.ui.client.id=${swagger-ui-cleint-id}

2.Start without oauth

./mvmw clean install -DskipTests
$ java -jar target/terraform-boot-*.jar

1.Start with oauth

1.Set values for the authorization related variables in the application-oauth-properties configuration file, 
  and specify the configuration file for loading oauth in the application-properties configuration file, 
  start the main application.
2.Or the oauth related variables configuration can be added to IDE and the main application can be executed directly
  to launch the application.

2.Start without oauth

Simply start the main application.

API can be accessed using the following URLs

http://localhost:9090
http://localhost:9090/swagger-ui/index.html

This is the recommended way. Docker images can be pulled from GitHub Packages as mentioned here. All configuration parameters can be passed as environment variables to the container.

We also deliver a jar for each release and can be found in the asests list of each release here. The jar can be started as mentioned in the same way we do for local development.

terraform-boot provides an option to enable observability using openTelemetry. This can be enabled by starting the runtime with profile opentelemetry.

By enabling this profile, the application forwards metrics, traces and logs to the otel-collector.

By default, the application sends all telemetry data to http://localhost:4317 and this can be changed by updating the value of otel.exporter.otlp.endpoint configuration property.

All third-party related content is listed in the DEPENDENCIES file.