few doc improvements

tacoinfra · Feb 20, 2024 · 6438049 · 6438049
1 parent f32cf5b
commit 6438049
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 9 deletions.
diff --git a/charts/tezos/values.yaml b/charts/tezos/values.yaml
@@ -309,12 +309,14 @@ serviceMonitor:
 
 # # Signers
 #
-# Define remote signers. Bakers automatically use signers in their namespace
+# You may define remote signers with tezos-k8s. Bakers automatically use signers in their namespace
 # that are configured to sign for the accounts they are baking for.
 # By default no signer is configured.
 #
 # https://tezos.gitlab.io/user/key-management.html#signer
 octezSigners: {}
+# These signers use the octez-signer binary.
+# 
 # Example:
 # ```
 # octezSigners:
@@ -325,15 +327,18 @@ octezSigners: {}
 #     # Names of accounts used to authenticate the baker to the signer.
 #     # The signer will only sign a request from a baker authenticated
 #     # by an allowed key.
-      # If set, any baker targeting this signer will automatically have
-      # the associated private key accessible locally.
+#     # If set, any baker targeting this signer will automatically have
+#     # the associated private key accessible locally.
 #     - authorized-key-0
 # ```
 #
 # Deploys a signer using AWS KMS to sign operations.
 # The `AWS_REGION` env var must be set.
 # https://github.com/tacoinfra/tacoinfra-remote-signer
 tacoinfraSigners: {}
+# These signers deploy the [Tacoifra remote signer](https://github.com/tacoinfra/remote-signer),
+# a program that passes signing requests to supported HSM or KMS devices.
+#
 # Example:
 # ```
 # tacoinfraSigners

diff --git a/docs/00-helm-chart.md b/docs/00-helm-chart.md
@@ -1,3 +1,7 @@
 # Helm charts
 
-Tezos-k8s is deployed as a helm chart. The [values.yaml](https://github.com/tacoinfra/tezos-k8s/blob/main/charts/tezos/values.yaml) file offers rich configuration options to customize your Tezos setup on Kubernetes.
+Tezos-k8s is deployed as a helm chart.
+
+The sections below explain how to configure accounts, nodes and signers.
+
+The [values.yaml](https://github.com/tacoinfra/tezos-k8s/blob/main/charts/tezos/values.yaml) file serves as a reference for all possible configuration options of the tezos chart.
diff --git a/docs/Prerequisites.md b/docs/Prerequisites.md
@@ -94,9 +94,9 @@ eval $(minikube docker-env -u)
 helm repo add tacoinfra https://tacoinfra.github.io/tezos-helm-charts/
 ```
 
-## Using a custom Tezos build
+## Using a custom Octez build
 
-Create a clone of the `[tezos](https://gitlab.com/tezos/tezos)`
+Create a clone of the [Octez](https://gitlab.com/tezos/tezos)
 repository.  [Set up your development environment as usual](https://tezos.gitlab.io/introduction/howtoget.html#setting-up-the-development-environment-from-scratch).  Then run:
 
 ```shell
@@ -125,7 +125,7 @@ images:
   octez: <image>
 ```
 
-where image is `tezos:latest` or whatever.
+where the image is `tezos:latest`.
 
 Then install the chart as above.
 

diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@ Use it to deploy:
 
 * a Tezos node
 * a Tezos RPC service
-* a Tezos baker (coming soon)
+* a Tezos baker
 * a Tezos private chain
 
 on your laptop or in a cloud platform such as AWS, Digitalocean or GCP.
@@ -32,4 +32,4 @@ helm install tezos-mainnet tacoinfra/tezos-chain \
 --namespace tacoinfra --create-namespace
 ```
 
-k8s will spin up an [Octez](https://tezos.gitlab.io/) node which will download and import a Tezos [mainnet tarball](https://tezos.gitlab.io/). This will take a few minutes.
+k8s will spin up an [Octez](https://tezos.gitlab.io/) node which will download and import a Tezos mainnet snapshot. This will take a few minutes.