Rename interface to vault-kv

vault-kv reflects the interface purpose better than `secrets`
canonical · Aug 18, 2023 · 26810e7 · 26810e7
1 parent 3399ded
commit 26810e7
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 16 deletions.
diff --git a/docs/json_schemas/secrets/v0/provider.json → docs/json_schemas/vault_kv/v0/provider.json b/docs/json_schemas/secrets/v0/provider.json → docs/json_schemas/vault_kv/v0/provider.json
@@ -7,7 +7,7 @@
       "$ref": "#/definitions/BaseModel"
     },
     "app": {
-      "$ref": "#/definitions/SecretsProviderSchema"
+      "$ref": "#/definitions/VaultKvProviderSchema"
     }
   },
   "required": [
@@ -47,8 +47,8 @@
         "$ref": "#/definitions/UnitCredentialsSchema"
       }
     },
-    "SecretsProviderSchema": {
-      "title": "SecretsProviderSchema",
+    "VaultKvProviderSchema": {
+      "title": "VaultKvProviderSchema",
       "type": "object",
       "properties": {
         "vault_url": {

diff --git a/docs/json_schemas/secrets/v0/requirer.json → docs/json_schemas/vault_kv/v0/requirer.json b/docs/json_schemas/secrets/v0/requirer.json → docs/json_schemas/vault_kv/v0/requirer.json
@@ -4,19 +4,19 @@
   "type": "object",
   "properties": {
     "unit": {
-      "$ref": "#/definitions/UnitSecretsRequirerSchema"
+      "$ref": "#/definitions/UnitVaultKvRequirerSchema"
     },
     "app": {
-      "$ref": "#/definitions/AppSecretsProviderSchema"
+      "$ref": "#/definitions/AppVaultKvProviderSchema"
     }
   },
   "required": [
     "unit",
     "app"
   ],
   "definitions": {
-    "UnitSecretsRequirerSchema": {
-      "title": "UnitSecretsRequirerSchema",
+    "UnitVaultKvRequirerSchema": {
+      "title": "UnitVaultKvRequirerSchema",
       "type": "object",
       "properties": {
         "egress_subnet": {
@@ -26,8 +26,8 @@
         }
       }
     },
-    "AppSecretsProviderSchema": {
-      "title": "AppSecretsProviderSchema",
+    "AppVaultKvProviderSchema": {
+      "title": "AppVaultKvProviderSchema",
       "type": "object",
       "properties": {
         "secret_backend": {

diff --git a/interfaces/secrets/v0/README.md → interfaces/vault_kv/v0/README.md b/interfaces/secrets/v0/README.md → interfaces/vault_kv/v0/README.md
@@ -1,4 +1,4 @@
-# `secrets`
+# `vault-kv`
 
 ## Usage
 

diff --git a/interfaces/secrets/v0/charms.yaml → interfaces/vault_kv/v0/charms.yaml b/interfaces/secrets/v0/charms.yaml → interfaces/vault_kv/v0/charms.yaml
diff --git a/interfaces/secrets/v0/schema.py → interfaces/vault_kv/v0/schema.py b/interfaces/secrets/v0/schema.py → interfaces/vault_kv/v0/schema.py
@@ -23,30 +23,30 @@ class CredentialsSchema(BaseModel):
     __root__: Mapping[str, UnitCredentialsSchema] = Field("Units' credentials")
 
 
-class SecretsProviderSchema(BaseModel):
+class VaultKvProviderSchema(BaseModel):
     vault_url: str = Field(description="The URL of the Vault server to connect to.")
     kv_mountpoint: str = Field(description="The mountpoint of the KV store to use.")
     credentials: Json[CredentialsSchema] = Field(
         description="The credentials to use to authenticate to Vault."
     )
 
 
-class AppSecretsProviderSchema(BaseModel):
+class AppVaultKvProviderSchema(BaseModel):
     secret_backend: str = Field("The name of the secret backend to use.")
 
 
-class UnitSecretsRequirerSchema(BaseModel):
+class UnitVaultKvRequirerSchema(BaseModel):
     egress_subnet: str = Field("Egress subnet to use.")
 
 
 class ProviderSchema(DataBagSchema):
     """The schema for the provider side of this interface."""
 
-    app: SecretsProviderSchema
+    app: VaultKvProviderSchema
 
 
 class RequirerSchema(DataBagSchema):
     """The schema for the requirer side of this interface."""
 
-    app: AppSecretsProviderSchema
-    unit: UnitSecretsRequirerSchema
+    app: AppVaultKvProviderSchema
+    unit: UnitVaultKvRequirerSchema