Docs update for revisited configuration policy syntax (#254)

* Docs update for new policy syntax * Don't hardcode values in documentation
ecadlabs · Oct 28, 2022 · dae3146 · dae3146
1 parent f07f140
commit dae3146
Show file tree

Hide file tree

Showing 9 changed files with 305 additions and 291 deletions.
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/aws_kms.md b/docs/aws_kms.md
@@ -14,14 +14,15 @@ Search for IAM and create a user with "Programmatic access" for Signatory to acc
 
 Below are the minimum configuration required.
 
-```sh
-awskms:
+```yaml
+vaults:
+  aws:
     driver: awskms
     config:
-      user_name: sigy-tsty
-      access_key_id: AKIATXBC6RIH4YZT5U6B
-      secret_access_key: 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
-      region: us-west-2
+      user_name: <iam_username>
+      access_key_id: <aws_access_key_id>
+      secret_access_key: <aws_secret_access_key>
+      region: <aws_region>
 ```
 
 ### Configuration parameters

diff --git a/docs/azure_kms.md b/docs/azure_kms.md
@@ -289,6 +289,10 @@ Allowed Kinds:      [endorsement transaction]
 **Update signatory.yaml config with PKH:**
 
 ```yaml
+server:
+  address: :6732
+  utility_address: :9583
+
 vaults:
   azure:
     driver: azure
@@ -304,12 +308,11 @@ vaults:
 tezos:
   tz3d6nYmR1LmSDsgJ463Kgd8EbH53pYnuv8S:
     log_payloads: true
-    allowed_operations:
-      # List of [generic, block, endorsement]
-      - generic
-      - block
-      - endorsement
-    allowed_kinds:
-      # List of [endorsement, ballot, reveal, transaction, origination, delegation, seed_nonce_revelation, activate_account]
-      - transaction
-      - endorsement
+    allow:
+      block:
+      endorsement:
+      preendorsement:
+      generic:
+        - transaction
+        - reveal
+        - delegation
diff --git a/docs/cli.md b/docs/cli.md
@@ -94,19 +94,15 @@ vaults:
 tezos:
   tz2***:
     log_payloads: true
-    allowed_operations:
-      # List of [generic, block, endorsement]
-      - generic
-      - block
-      - endorsement
-    allowed_kinds:
-      # List of [endorsement, ballot, reveal, transaction, origination, delegation, seed_nonce_revelation, activate_account]
-      - transaction
-      - endorsement
+    allow:
+      block:
+      endorsement:
+      preendorsement:
+      generic:
+        - transaction
   tz3***:
     log_payloads: true
-    allowed_operations:
-      - generic
-    allowed_kinds:
-      - transaction
+    allow:
+      generic:
+        - transaction
 ```
diff --git a/docs/gcp_kms.md b/docs/gcp_kms.md
@@ -77,37 +77,28 @@ Status:             FOUND_NOT_CONFIGURED
 
 **Update signatory.yaml config with PKH:**
 
-```sh
-signatory % cat /etc/s.yaml 
+```yaml
 server:
-  # Address/Port that Signatory listens on
   address: :6732
-  # Address/Port that Signatory serves prometheus metrics on
   utility_address: :9583
 
 vaults:
-  kms:
+  gcp:
     driver: cloudkms
     config:
-      project: signatory-testing
-      location: europe-south1
-      key_ring: sigy-key
+      project: <gcp_project>
+      location: <gcp_region>
+      key_ring: <key_ring_name>
+      application_credentials: <credentials_file_path>
 tezos:
-  # Default policy allows "block" and "endorsement" operations
   tz3fK7rVYSg2HTEAmUYdfjJWSDGfsKrxH3xQ:
-    # Setting `log_payloads` to `true` will cause Signatory to log operation
-    # payloads to `stdout`. This may be desirable for audit and investigative
-    # purposes.
     log_payloads: true
-    allowed_operations:
-      # List of [generic, block, endorsement]
-      - generic
-      - block
-      - endorsement
-    allowed_kinds:
-      # List of [endorsement, ballot, reveal, transaction, origination, delegation, seed_nonce_revelation, activate_account]
-      - transaction
-      - endorsement
+    allow:
+      block:
+      endorsement:
+      preendorsement:
+      generic:
+        - transaction
 ```
 
 ## **Key Import:**

diff --git a/docs/ledger.md b/docs/ledger.md
@@ -38,7 +38,6 @@ Examples (equivalent): `bip32-ed25519/m/44'/1729'/0'/0'`,
 
 ```yaml
 vaults:
-# Name of vault
   ledger:
     driver: ledger
     config: