Unify capitaisation for KeyService

edgelesssys · Jan 12, 2023 · bd535e3 · bd535e3
1 parent 692b62e
commit bd535e3
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/.github/workflows/build-keyservice-image.yml b/.github/workflows/build-keyservice-image.yml
@@ -1,4 +1,4 @@
-name: Build and upload Keyservice image
+name: Build and upload KeyService image
 
 on:
   workflow_dispatch:
@@ -29,7 +29,7 @@ jobs:
         with:
           go-version: "1.19.4"
 
-      - name: Build and upload Keyservice container image
+      - name: Build and upload KeyService container image
         id: build-and-upload
         uses: ./.github/actions/build_micro_service
         with:

diff --git a/cli/internal/helm/charts/edgeless/constellation-services/charts/keyservice/Chart.yaml b/cli/internal/helm/charts/edgeless/constellation-services/charts/keyservice/Chart.yaml
@@ -1,5 +1,5 @@
 apiVersion: v2
 name: keyservice
-description: A Helm chart to deploy the Constellation Keyservice
+description: A Helm chart to deploy the Constellation KeyService
 type: application
 version: 2.4.0
diff --git a/cli/internal/helm/charts/edgeless/constellation-services/values.yaml b/cli/internal/helm/charts/edgeless/constellation-services/values.yaml
@@ -1,5 +1,5 @@
 global:
-  # Port on which the Keyservice will listen. Global since join-service also uses the value.
+  # Port on which the KeyService will listen. Global since join-service also uses the value.
   keyservicePort: 9000
   # Path to which secrets/CMs are mounted.
   serviceBasePath: /var/config

diff --git a/docs/docs/architecture/components.md b/docs/docs/architecture/components.md
@@ -22,7 +22,7 @@ flowchart LR
     end
     subgraph Kubernetes
         D[JoinService]
-        E[Keyservice]
+        E[KeyService]
         F[VerificationService]
     end
     A -- deploys -->
@@ -66,8 +66,8 @@ The *VerificationService* runs as DaemonSet on each node.
 It provides user-facing functionality for remote attestation during the cluster's lifetime via an endpoint for [verifying the cluster](attestation.md#cluster-attestation).
 Read more about the hardware-based [attestation feature](attestation.md) of Constellation and how to [verify](../workflows/verify-cluster.md) a cluster on the client side.
 
-## Keyservice
+## KeyService
 
-The *Keyservice* runs as DaemonSet on each control-plane node.
+The *KeyService* runs as DaemonSet on each control-plane node.
 It implements the key management for the [storage encryption keys](keys.md#storage-encryption) in Constellation. These keys are used for the [state disk](images.md#state-disk) of each node and the [transparently encrypted storage](encrypted-storage.md) for Kubernetes.
-Depending on wether the [constellation-managed](keys.md#constellation-managed-key-management) or [user-managed](keys.md#user-managed-key-management) mode is used, the *Keyservice* holds the key encryption key (KEK) directly or calls an external key management service (KMS) for key derivation respectively.
+Depending on wether the [constellation-managed](keys.md#constellation-managed-key-management) or [user-managed](keys.md#user-managed-key-management) mode is used, the *KeyService* holds the key encryption key (KEK) directly or calls an external key management service (KMS) for key derivation respectively.
diff --git a/docs/docs/architecture/encrypted-storage.md b/docs/docs/architecture/encrypted-storage.md
@@ -28,7 +28,7 @@ All cryptographic operations happen inside the trusted environment of the confid
 
 Note that for integrity-protected disks, [volume expansion](https://kubernetes.io/blog/2018/07/12/resizing-persistent-volumes-using-kubernetes/) isn't supported.
 
-By default the driver uses data encryption keys (DEKs) issued by the Constellation [*Keyservice*](components.md#keyservice).
+By default the driver uses data encryption keys (DEKs) issued by the Constellation [*KeyService*](components.md#keyservice).
 The DEKs are in turn derived from the Constellation's key encryption key (KEK), which is directly derived from the [master secret](keys.md#master-secret).
 This is the recommended mode of operation, and also requires the least amount of setup by the cluster administrator.
 

diff --git a/internal/versions/versions.go b/internal/versions/versions.go
@@ -58,7 +58,7 @@ const (
 	KonnectivityServerImage = "registry.k8s.io/kas-network-proxy/proxy-server:v0.0.35@sha256:d863f7fd0da4392b9753dc6c9195a658e80d70e0be8c9adb410d77cf20b75c76" // renovate:container
 	// JoinImage image of Constellation join service.
 	JoinImage = "ghcr.io/edgelesssys/constellation/join-service:v2.5.0-pre.0.20230111102352-5c9a15acf65c" // renovate:container
-	// KeyServiceImage image of Constellation Keyservice server.
+	// KeyServiceImage image of Constellation KeyService server.
 	KeyServiceImage = "ghcr.io/edgelesssys/constellation/keyservice:v2.5.0-pre.0.20230111102352-5c9a15acf65c" // renovate:container
 	// VerificationImage image of Constellation verification service.
 	VerificationImage = "ghcr.io/edgelesssys/constellation/verification-service:v2.4.0-pre.0.20230109111654-2700d5182b7d@sha256:43fd9d3494538d94f584dbcfa6d4fd82cadefe3e4fdaa33e9ffb19d8f6b98b94" // renovate:container