Rename configuration-service => api (#243)

Co-authored-by: Chris Vermeulen <chris.vermeulen@container-solutions.com>

Author: ianmiell

.gitignore

@@ -17,6 +17,6 @@ __debug_*
 local.go
 resolver.go
 
-configuration-service
+api
 
 *.pem

Dockerfile

@@ -32,16 +32,16 @@ COPY . ./
 RUN make swag
 
 # Build it
-RUN GOOS=linux go build -o /configuration-service
+RUN GOOS=linux go build -o /api
 
 FROM golang:1.23 AS production
 WORKDIR /
 
-COPY --from=builder /configuration-service /configuration-service
+COPY --from=builder /api /api
 # Open port 8080 to traffic
 EXPOSE 8080
 
 # Specify the command to run on container start.
-CMD ["/configuration-service", "run"]
+CMD ["/api", "run"]
 
 FROM production

Makefile

@@ -120,7 +120,7 @@ check-diff: reviewable # Ensure branch is clean.
 
 .PHONY: build
 build: ## Build the service in Docker Compose
-	@docker compose -f docker-compose.yml build configuration-service
+	@docker compose -f docker-compose.yml build api
 
 .PHONY: dev
 up: ## Run the service in Docker Compose
@@ -142,4 +142,4 @@ generate-keys:
 	@$(OK) keys generated
 
 tag:   ## Build and tag a production-based image of the service
-	@docker build -t ghcr.io/compliance-framework/configuration-service:latest_local .
+	@docker build -t ghcr.io/compliance-framework/api:latest_local .

README.md

@@ -1,8 +1,8 @@
-# Configuration Service
+# API
 
 ## Overview
 
-The Configuration service is a core component of The Continuous Compliance Framework. It manages all the data and 
+The API is a core component of the Continuous Compliance Framework. It manages all the data and
 aggregation for compliance, and agent-collected data.
 
 The data structures in the service are heavily based on OSCAL (Open Security Controls Assessment Language), with the
@@ -20,16 +20,16 @@ goal of full support.
 This will also start the required auxiliary services.
 
 ```shell
-make up  
+make up
 # OR podman-compose up -d
-# OR docker compose up -d 
+# OR docker compose up -d
 
 curl http://localhost:8080
 ```
 
 ### The command line
 
-The Configuration Service ships with a built in CLI, which can be used to run administrative tasks within. 
+The API ships with a built in CLI, which can be used to run administrative tasks within.
 
 Some examples include:
 ```shell
@@ -50,15 +50,15 @@ $ go run main.go help # Learn more about all the available commands
 > [!IMPORTANT]
 > Make sure you run `make swag` when first cloning the repository (either locally or in CI steps) otherwise the build will fail
 
-The configuration service exposes all of its endpoints using Swagger.
+The API exposes all of its endpoints using Swagger.
 
 Swagger artefacts (docs.json/docs.yaml) are not stored within the repository as it is automatically generated using the [swag cli tool](https://github.com/swaggo/swag) and stored in the `docs/` directory. A helper function `make swag` can be run anytime to generate the most up to date swagger docs.
 
 You can access the Swagger documentation to test and interact with the API at: [http://localhost:8080/swagger/index.html](http://localhost:8080/swagger/index.html)
 
 ## Configuration
 
-You can configure configuration-service using environment variables or a `.env` file.
+You can configure the API using environment variables or a `.env` file.
 
 Available variables are shown in [`.env.example`](./.env.example)
 
@@ -69,14 +69,14 @@ cp .env.example .env
 
 ## Contributing
 
-We welcome contributions to configuration-service!
+We welcome contributions to the API!
 
 ## Testing
 
 ### Integration Tests
 
-The Configuration Service contains integration tests, which will run tests against a real database, ensuring the service
-works as expected. 
+The API contains integration tests, which will run tests against a real database, ensuring the service
+works as expected.
 
 The tests are marked with special build markers to avoid running them during normal development.
 

cmd/migrate.go

@@ -2,8 +2,8 @@ package cmd
 
 import (
 	"context"
-	"github.com/compliance-framework/configuration-service/internal/config"
-	"github.com/compliance-framework/configuration-service/internal/service"
+	"github.com/compliance-framework/api/internal/config"
+	"github.com/compliance-framework/api/internal/service"
 	"github.com/spf13/cobra"
 	"go.uber.org/zap"
 	"log"

cmd/oscal/import.go

@@ -3,16 +3,16 @@ package oscal
 import (
 	"context"
 	"encoding/json"
-	"github.com/compliance-framework/configuration-service/internal/service/relational"
+	"github.com/compliance-framework/api/internal/service/relational"
 	oscalTypes_1_1_3 "github.com/defenseunicorns/go-oscal/src/types/oscal-1-1-3"
 	"gorm.io/gorm"
 	"io"
 	"log"
 	"os"
 	"path"
 
-	"github.com/compliance-framework/configuration-service/internal/config"
-	"github.com/compliance-framework/configuration-service/internal/service"
+	"github.com/compliance-framework/api/internal/config"
+	"github.com/compliance-framework/api/internal/service"
 	"github.com/spf13/cobra"
 	"go.uber.org/zap"
 )

cmd/root.go

@@ -5,18 +5,18 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/compliance-framework/configuration-service/cmd/oscal"
-	"github.com/compliance-framework/configuration-service/cmd/seed"
-	"github.com/compliance-framework/configuration-service/cmd/users"
+	"github.com/compliance-framework/api/cmd/oscal"
+	"github.com/compliance-framework/api/cmd/seed"
+	"github.com/compliance-framework/api/cmd/users"
 	"github.com/joho/godotenv"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
 var (
 	rootCmd = &cobra.Command{
-		Use:   "conf-service",
-		Short: "Compliance Framework Configuration Service",
+		Use:   "api",
+		Short: "Compliance Framework API",
 	}
 )
 

cmd/run.go

@@ -4,20 +4,20 @@ import (
 	"context"
 	"log"
 
-	"github.com/compliance-framework/configuration-service/internal/api"
-	"github.com/compliance-framework/configuration-service/internal/api/handler"
-	"github.com/compliance-framework/configuration-service/internal/api/handler/auth"
-	"github.com/compliance-framework/configuration-service/internal/api/handler/oscal"
-	"github.com/compliance-framework/configuration-service/internal/config"
-	"github.com/compliance-framework/configuration-service/internal/service"
+	"github.com/compliance-framework/api/internal/api"
+	"github.com/compliance-framework/api/internal/api/handler"
+	"github.com/compliance-framework/api/internal/api/handler/auth"
+	"github.com/compliance-framework/api/internal/api/handler/oscal"
+	"github.com/compliance-framework/api/internal/config"
+	"github.com/compliance-framework/api/internal/service"
 	"github.com/spf13/cobra"
 	"go.uber.org/zap"
 )
 
 var (
 	RunCmd = &cobra.Command{
 		Use:   "run",
-		Short: "Run the configuration service API",
+		Short: "Run the compliance framework API",
 		Run:   RunServer,
 	}
 )

cmd/seed/evidence.go

@@ -3,8 +3,8 @@ package seed
 import (
 	"context"
 	"fmt"
-	"github.com/compliance-framework/configuration-service/internal"
-	"github.com/compliance-framework/configuration-service/internal/service/relational"
+	"github.com/compliance-framework/api/internal"
+	"github.com/compliance-framework/api/internal/service/relational"
 	oscalTypes_1_1_3 "github.com/defenseunicorns/go-oscal/src/types/oscal-1-1-3"
 	"github.com/google/uuid"
 	"github.com/schollz/progressbar/v3"
@@ -14,8 +14,8 @@ import (
 	"sync"
 	"time"
 
-	"github.com/compliance-framework/configuration-service/internal/config"
-	"github.com/compliance-framework/configuration-service/internal/service"
+	"github.com/compliance-framework/api/internal/config"
+	"github.com/compliance-framework/api/internal/service"
 	"github.com/spf13/cobra"
 	"go.uber.org/zap"
 )

cmd/seed/heartbeat.go

@@ -8,8 +8,8 @@ import (
 	"sync"
 	"time"
 
-	"github.com/compliance-framework/configuration-service/internal/config"
-	"github.com/compliance-framework/configuration-service/internal/service"
+	"github.com/compliance-framework/api/internal/config"
+	"github.com/compliance-framework/api/internal/service"
 	"github.com/spf13/cobra"
 	"go.uber.org/zap"
 )