rename terraform-boot project to terra-boot (#199)

Author: baixinsui

.github/workflows/ci.yml

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0
 # SPDX-FileCopyrightText: Huawei Inc.
 #
-name: terraform-boot-ci
+name: terra-boot-ci
 
 # Run this workflow every time a new commit push to the repository
 on:

.github/workflows/release.yml

@@ -3,7 +3,7 @@
 # SPDX-FileCopyrightText: Huawei Inc.
 #
 ---
-name: terraform-boot-cd
+name: terra-boot-cd
 
 on:
   workflow_dispatch:
@@ -34,7 +34,7 @@ env:
 jobs:
   release:
     runs-on: ubuntu-latest
-    if: github.repository == 'eclipse-xpanse/terraform-boot'
+    if: github.repository == 'eclipse-xpanse/terra-boot'
     outputs:
       next-version: ${{ steps.new_version.outputs.next-version }}
     permissions:
@@ -146,7 +146,7 @@ jobs:
 
   prepare-for-next-development-cycle:
     runs-on: ubuntu-latest
-    if: github.repository == 'eclipse-xpanse/terraform-boot'
+    if: github.repository == 'eclipse-xpanse/terra-boot'
     needs: release
     permissions:
       contents: write

Dockerfile

@@ -1,6 +1,6 @@
 FROM eclipse-temurin:21-jre-alpine
 
-RUN addgroup -S terraform-boot && adduser -S -G terraform-boot terraform-boot
+RUN addgroup -S terra-boot && adduser -S -G terra-boot terra-boot
 RUN apk update && \
     apk add --no-cache unzip wget
 
@@ -12,6 +12,6 @@ RUN chmod +x /install_terraform.sh
 RUN echo "Downloading and installing Terraform with multiple versions $TERRAFORM_VERSIONS into path $TERRAFORM_INSTALL_PATH"; \
     /install_terraform.sh "$TERRAFORM_INSTALL_PATH" "$DEFAULT_TERRAFORM_VERSION" "$TERRAFORM_VERSIONS"
 
-COPY target/terraform-boot-*.jar terraform-boot.jar
-USER terraform-boot
-ENTRYPOINT ["java", "-Dterraform.install.dir=${TERRAFORM_INSTALL_PATH}", "-Dterraform.default.supported.versions=${TERRAFORM_VERSIONS}", "-jar", "terraform-boot.jar"]
+COPY target/terra-boot-*.jar terra-boot.jar
+USER terra-boot
+ENTRYPOINT ["java", "-Dterraform.install.dir=${TERRAFORM_INSTALL_PATH}", "-Dterraform.default.supported.versions=${TERRAFORM_VERSIONS}", "-jar", "terra-boot.jar"]

README.md

@@ -1,13 +1,13 @@
 <p align='center'>
-<a href="https://github.com/eclipse-xpanse/terraform-boot/actions/workflows/ci.yml" target="_blank">
-	<img src="https://github.com/eclipse-xpanse/terraform-boot/actions/workflows/ci.yml/badge.svg" alt="build">
+<a href="https://github.com/eclipse-xpanse/terra-boot/actions/workflows/ci.yml" target="_blank">
+	<img src="https://github.com/eclipse-xpanse/terra-boot/actions/workflows/ci.yml/badge.svg" alt="build">
 </a>
 <a href="https://opensource.org/licenses/Apache-2.0" target="_blank">
 	<img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="coverage">
 </a>
 </p>
 
-# terraform-boot
+# terra-boot
 
 A spring-boot-based project which aims to provide a RESTful API for Terraform CLI. It provides three different modes of
 execution
@@ -20,15 +20,15 @@ execution
 
 ### Scripts in a Directory
 
-Pass the terraform root folder name in the request and terraform-boot will execute the requested Terraform method on
+Pass the terraform root folder name in the request and terra-boot will execute the requested Terraform method on
 this directory.
 
 #### Terraform Root module Folder
 
 If we intend to use this mode of script execution, then we must ensure the scripts root directory is
-accessible to terraform-boot runtime.
+accessible to terra-boot runtime.
 
-The `terraform-boot` application must have access to the root module folder under which each sub-folder is a module
+The `terra-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.
@@ -37,12 +37,12 @@ This configuration can be changed by updating the `terraform.root.module.directo
 
 ### Scripts in the Request Body
 
-All files needed for terraform execution can be passed as strings to API and terraform-boot will automatically execute
+All files needed for terraform execution can be passed as strings to API and terra-boot will automatically execute
 the files and return terraform execution result.
 
 ### Scripts in GIT Repo
 
-If the scripts are present in a GIT repo, then we can directly pass the details of the GIT repo. Terraform-boot will
+If the scripts are present in a GIT repo, then we can directly pass the details of the GIT repo. Terra-boot will
 clone the repo and execute the scripts and then return the result.
 
 > [!NOTE]
@@ -55,7 +55,7 @@ clone the repo and execute the scripts and then return the result.
 * 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
+* healthCheck - This method returns the status of the terra-boot application
 
 > [!NOTE]
 > All terraform related methods above support both modes of operation mentioned in
@@ -73,20 +73,20 @@ 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.
 
-| property name                                 | environment variable                          | default value                                    | description                                                                                                                                    |
-|-----------------------------------------------|-----------------------------------------------|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
-| terraform_binary_path                         | TERRAFORM_BINARY_PATH                         | Terraform available on syspath                   | The path to the terraform binary                                                                                                               |
-| terraform.root.module.directory               | TERRAFORM_ROOT_MODULE_DIRECTORY               | /tmp on Linux<br/>\AppData\Local\Temp on Windows | The path to the parent directory where all terraform module directories will be stored at as subdirs                                           |
-| log.terraform.stdout.stderr                   | LOG_TERRAFORM_STDOUT_STDERR                   | true                                             | Controls if the command execution output must be logged. If disabled, the output is only returned in the API response                          |
-| terraform.log.level                           | TERRAFORM_LOG_LEVEL                           | INFO                                             | Controls the log level of the terraform binary. Allowed values are INFO, DEBUG, TRACE, WARN and ERROR                                          |
-| authorization.token.type                      | AUTHORIZATION_TOKEN_TYPE                      | JWT                                              | Authorization server authentication Type, allowed values: OpaqueToken or JWT                                                                   |
-| authorization.server.endpoint                 | AUTHORIZATION_SERVER_ENDPOINT                 |                                                  | The endpoint value of the authorization server                                                                                                 |
-| authorization.api.client.id                   | AUTHORIZATION_API_CLIENT_ID                   |                                                  | The ID value of the authorization server API client                                                                                            |
-| authorization.api.client.secret               | AUTHORIZATION_API_CLIENT_SECRET               |                                                  | The secret value of the authorization server API client                                                                                        |
-| authorization.swagger.ui.client.id            | AUTHORIZATION_SWAGGER_UI_CLIENT_ID            |                                                  | The ID value of the authorization server swagger-ui client                                                                                     |
-| otel.exporter.otlp.endpoint                   | OTEL_EXPORTER_OTLP_ENDPOINT                   | http://localhost:4317                            | URL of the OTEL collector                                                                                                                      |
-| clean.workspace.after.deployment.enabled      | CLEAN_WORKSPACE_AFTER_DEPLOYMENT_ENABLED      | true                                             | Whether to clean up the workspace after deployment is done,allowed values: true or false. Default value is true                                |
-| terraformboot.webhook.request.signing.enabled | TERRAFORMBOOT_WEBHOOK_REQUEST_SIGNING_ENABLED | true                                             | Whether to sign webhook requests initiated from terraform-boot. The values must be agreed with the consumer application. Default value is true |
+| property name                              | environment variable                       | default value                                    | description                                                                                                                                   |
+|--------------------------------------------|--------------------------------------------|--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| terraform_binary_path                      | TERRAFORM_BINARY_PATH                      | Terraform available on syspath                   | The path to the terraform binary                                                                                                              |
+| terraform.root.module.directory            | TERRAFORM_ROOT_MODULE_DIRECTORY            | /tmp on Linux<br/>\AppData\Local\Temp on Windows | The path to the parent directory where all terraform module directories will be stored at as subdirs                                          |
+| log.terraform.stdout.stderr                | LOG_TERRAFORM_STDOUT_STDERR                | true                                             | Controls if the command execution output must be logged. If disabled, the output is only returned in the API response                         |
+| terraform.log.level                        | TERRAFORM_LOG_LEVEL                        | INFO                                             | Controls the log level of the terraform binary. Allowed values are INFO, DEBUG, TRACE, WARN and ERROR                                         |
+| authorization.token.type                   | AUTHORIZATION_TOKEN_TYPE                   | JWT                                              | Authorization server authentication Type, allowed values: OpaqueToken or JWT                                                                  |
+| authorization.server.endpoint              | AUTHORIZATION_SERVER_ENDPOINT              |                                                  | The endpoint value of the authorization server                                                                                                |
+| authorization.api.client.id                | AUTHORIZATION_API_CLIENT_ID                |                                                  | The ID value of the authorization server API client                                                                                           |
+| authorization.api.client.secret            | AUTHORIZATION_API_CLIENT_SECRET            |                                                  | The secret value of the authorization server API client                                                                                       |
+| authorization.swagger.ui.client.id         | AUTHORIZATION_SWAGGER_UI_CLIENT_ID         |                                                  | The ID value of the authorization server swagger-ui client                                                                                    |
+| otel.exporter.otlp.endpoint                | OTEL_EXPORTER_OTLP_ENDPOINT                | http://localhost:4317                            | URL of the OTEL collector                                                                                                                     |
+| clean.workspace.after.deployment.enabled   | CLEAN_WORKSPACE_AFTER_DEPLOYMENT_ENABLED   | true                                             | Whether to clean up the workspace after deployment is done,allowed values: true or false. Default value is true                               |
+| terra.boot.webhook.request.signing.enabled | TERRA_BOOT_WEBHOOK_REQUEST_SIGNING_ENABLED | true                                             | Whether to sign webhook requests initiated from terra-boot. The values must be agreed with the consumer application. Default value is true    |
 
 
 
@@ -110,7 +110,7 @@ Use the spring boot's dev profile to use default values that are just for non-pr
 
 ```shell
 ./mvmw clean install -DskipTests
-$ java -jar target/terraform-boot-*.jar\
+$ java -jar target/terra-boot-*.jar\
 --spring.profiles.active=oauth \
 --authorization.token.type=${token-type} \
 --authorization.server.endpoint=${server-endpoint} \
@@ -123,7 +123,7 @@ $ java -jar target/terraform-boot-*.jar\
 
 ```shell
 ./mvmw clean install -DskipTests
-$ java -jar target/terraform-boot-*.jar
+$ java -jar target/terra-boot-*.jar
 ```
 
 #### From IDE
@@ -152,18 +152,18 @@ http://localhost:9090/swagger-ui/index.html
 #### Docker Image
 
 This is the recommended way. Docker images can be pulled from GitHub Packages as
-mentioned [here](https://github.com/eclipse-xpanse/terraform-boot/pkgs/container/terraform-boot).
+mentioned [here](https://github.com/eclipse-xpanse/terra-boot/pkgs/container/terra-boot).
 All configuration parameters can be passed as environment variables to the container.
 
 #### Run Jar
 
 We also deliver a jar for each release and can be found in the asests list of each
-release [here](https://github.com/eclipse-xpanse/terraform-boot/releases).
+release [here](https://github.com/eclipse-xpanse/terra-boot/releases).
 The jar can be started as mentioned in the same way we do for local development.
 
 ### Observability
 
-`terraform-boot` provides an option to enable observability using [openTelemetry](https://opentelemetry.io/). This can
+`terra-boot` provides an option to enable observability using [openTelemetry](https://opentelemetry.io/). 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`.

jreleaser.yml

@@ -1,5 +1,5 @@
 project:
-  name: eclipse-terraform-boot
+  name: eclipse-terra-boot
   license: Apache-2.0
   description: RESTful APIs for executing Terraform commands.
   links:
@@ -48,4 +48,4 @@ signing:
   armored: true
 files:
   artifacts:
-    - path: 'target/terraform-boot-{{projectEffectiveVersion}}.jar'
+    - path: 'target/terra-boot-{{projectEffectiveVersion}}.jar'

pom.xml

@@ -14,9 +14,9 @@
 		<relativePath/> <!-- lookup parent from repository -->
 	</parent>
 	<groupId>org.eclipse.xpanse.terraform.boot</groupId>
-	<artifactId>terraform-boot</artifactId>
+	<artifactId>terra-boot</artifactId>
 	<version>1.0.19-SNAPSHOT</version>
-	<name>terraform-boot</name>
+	<name>terra-boot</name>
 	<description>RESTful API Wrapper for Terraform</description>
 	<properties>
 		<java.version>21</java.version>

src/main/java/org/eclipse/xpanse/terraform/boot/TerraformBootApplication.java src/main/java/org/eclipse/xpanse/terraform/boot/TerraBootApplication.java

@@ -13,15 +13,15 @@
 import org.springframework.scheduling.annotation.EnableAsync;
 import org.springframework.scheduling.annotation.EnableScheduling;
 
-/** Main entry class to terraform-boot. This class can be directly executed to start the server. */
+/** Main entry class to terra-boot. This class can be directly executed to start the server. */
 @EnableRetry
 @EnableAsync
 @EnableCaching
 @EnableScheduling
 @SpringBootApplication(exclude = {SecurityAutoConfiguration.class})
-public class TerraformBootApplication {
+public class TerraBootApplication {
 
     public static void main(String[] args) {
-        SpringApplication.run(TerraformBootApplication.class, args);
+        SpringApplication.run(TerraBootApplication.class, args);
     }
 }

src/main/java/org/eclipse/xpanse/terraform/boot/api/config/SpringDocOpenApiConfig.java

@@ -24,7 +24,7 @@ public OpenAPI configOpenApi() {
         return new OpenAPI()
                 .info(
                         new Info()
-                                .title("Terraform-Boot API")
+                                .title("Terra-Boot API")
                                 .description("RESTful Services to interact with terraform CLI")
                                 .version(version));
     }

src/main/java/org/eclipse/xpanse/terraform/boot/api/controllers/TerraformBootAdminApi.java src/main/java/org/eclipse/xpanse/terraform/boot/api/controllers/TerraBootAdminApi.java

@@ -8,7 +8,7 @@
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.extern.slf4j.Slf4j;
-import org.eclipse.xpanse.terraform.boot.models.TerraformBootSystemStatus;
+import org.eclipse.xpanse.terraform.boot.models.TerraBootSystemStatus;
 import org.eclipse.xpanse.terraform.boot.terraform.service.TerraformDirectoryService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
@@ -20,17 +20,17 @@
 import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestController;
 
-/** REST controller for admin services of terraform-boot. */
+/** REST controller for admin services of terra-boot. */
 @Slf4j
 @CrossOrigin
 @RestController
-@RequestMapping("/terraform-boot")
-public class TerraformBootAdminApi {
+@RequestMapping("/terra-boot")
+public class TerraBootAdminApi {
 
     private final TerraformDirectoryService terraformDirectoryService;
 
     @Autowired
-    public TerraformBootAdminApi(
+    public TerraBootAdminApi(
             @Qualifier("terraformDirectoryService")
                     TerraformDirectoryService terraformDirectoryService) {
         this.terraformDirectoryService = terraformDirectoryService;
@@ -42,10 +42,10 @@ public TerraformBootAdminApi(
      * @return Returns the current state of the system.
      */
     @Tag(name = "Admin", description = "Admin services for managing the application.")
-    @Operation(description = "Check health of Terraform Boot API service")
+    @Operation(description = "Check health of Terra Boot API service")
     @GetMapping(value = "/health", produces = MediaType.APPLICATION_JSON_VALUE)
     @ResponseStatus(HttpStatus.OK)
-    public TerraformBootSystemStatus healthCheck() {
+    public TerraBootSystemStatus healthCheck() {
         return terraformDirectoryService.tfHealthCheck();
     }
 }

src/main/java/org/eclipse/xpanse/terraform/boot/api/controllers/TerraformBootFromDirectoryApi.java src/main/java/org/eclipse/xpanse/terraform/boot/api/controllers/TerraBootFromDirectoryApi.java

@@ -50,8 +50,8 @@
 @Slf4j
 @CrossOrigin
 @RestController
-@RequestMapping("/terraform-boot/directory")
-public class TerraformBootFromDirectoryApi {
+@RequestMapping("/terra-boot/directory")
+public class TerraBootFromDirectoryApi {
 
     @Resource private TerraformDirectoryService directoryService;
     @Resource private TerraformScriptsHelper scriptsHelper;

src/main/java/org/eclipse/xpanse/terraform/boot/api/controllers/TerraformBootFromGitRepoApi.java src/main/java/org/eclipse/xpanse/terraform/boot/api/controllers/TerraBootFromGitRepoApi.java

@@ -39,12 +39,12 @@
 @Slf4j
 @CrossOrigin
 @RestController
-@RequestMapping("/terraform-boot/git")
-public class TerraformBootFromGitRepoApi {
+@RequestMapping("/terra-boot/git")
+public class TerraBootFromGitRepoApi {
 
     private final TerraformGitRepoService terraformGitRepoService;
 
-    public TerraformBootFromGitRepoApi(TerraformGitRepoService terraformGitRepoService) {
+    public TerraBootFromGitRepoApi(TerraformGitRepoService terraformGitRepoService) {
         this.terraformGitRepoService = terraformGitRepoService;
     }