docs: update README add secret note

p2p-org · Aug 26, 2024 · 0dc8578 · 0dc8578
1 parent 34da168
commit 0dc8578
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 3 deletions.
diff --git a/charts/aethos/README.md b/charts/aethos/README.md
@@ -29,7 +29,7 @@ helm install aethos p2p-avs/aethos -f values.yaml
    - [Aethos](https://github.com/AethosNetwork/aethos-operator)
 
 2. Create a secret in Kubernetes for any workflow you want. Example you can find in `./examples`
-
+> Dont use secret in open way, try to figure out with [vault](https://github.com/hashicorp/vault) / [sealed-secrets](https://github.com/bitnami-labs/sealed-secrets) / [sops](https://github.com/getsops/sops)
 3. Fill the placeholders in your `values.yaml` file:
    - YOUR_OPERATOR_ADDRESS
    - YOUR_ECDSA_SIGN_KEY_SECRET

diff --git a/charts/aethos/example/README.md b/charts/aethos/example/README.md
@@ -1,3 +1,4 @@
 ## Generate keys
 
 For generate keys read this doc https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation
+> Dont use secret in open way, try to figure out with [vault](https://github.com/hashicorp/vault) / [sealed-secrets](https://github.com/bitnami-labs/sealed-secrets) / [sops](https://github.com/getsops/sops)
diff --git a/charts/arpa/README.md b/charts/arpa/README.md
@@ -30,7 +30,7 @@ helm install arpa p2p-avs/arpa -f values.yaml
    - [Arpa Configs](https://github.com/0xJomo/arpa-configs)
 
 2. Create a secret in Kubernetes for any workflow you want. Example you can find in `./examples`
-
+> Dont use secret in open way, try to figure out with [vault](https://github.com/hashicorp/vault) / [sealed-secrets](https://github.com/bitnami-labs/sealed-secrets) / [sops](https://github.com/getsops/sops)
 3. Fill the placeholders in your `values.yaml` file:
    - `YOUR_OPERATOR_ADDRESS`
    - `YOUR_ECDSA_SIGN_KEY_SECRET`

diff --git a/charts/arpa/example/README.md b/charts/arpa/example/README.md
@@ -1,3 +1,4 @@
 ## Generate keys
 
 For generate keys read this doc https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation
+> Dont use secret in open way, try to figure out with [vault](https://github.com/hashicorp/vault) / [sealed-secrets](https://github.com/bitnami-labs/sealed-secrets) / [sops](https://github.com/getsops/sops)
diff --git a/charts/k3/README.md b/charts/k3/README.md
@@ -9,6 +9,7 @@ More information about k3 you can find here `https://docs.k3-labs.com/introducti
   - [Introduction](#introduction)
   - [Table of Contents](#table-of-contents)
   - [Usage](#usage)
+    - [Steps to Follow:](#steps-to-follow)
   - [Configuration](#configuration)
   - [Dependencies](#dependencies)
   - [Troubleshooting](#troubleshooting)
@@ -22,6 +23,23 @@ To use this chart, you can override default values by providing your own `values
 helm install k3 p2p-avs/k3 -f values.yaml
 ```
 
+### Steps to Follow:
+1. Generate keys via the following URLs:
+   - [Eigenlayer Operator Installation Guide](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation)
+
+2. Create a secret in Kubernetes for any workflow you want. Example you can find in `./examples`
+> Dont use secret in open way, try to figure out with [vault](https://github.com/hashicorp/vault) / [sealed-secrets](https://github.com/bitnami-labs/sealed-secrets) / [sops](https://github.com/getsops/sops)
+1. Fill the placeholders in your `values.yaml` file:
+   - `YOUR_OPERATOR_ADDRESS`
+   - `YOUR_ECDSA_SIGN_KEY_SECRET`
+   - `YOUR_BLS_KEY_SECRET`
+   - `YOUR_ECDSA_KEY_SECRET`
+
+2. Run the following command to upgrade and install the chart:
+   ```sh
+   helm upgrade -i k3 p2p-avs/k3 -f values.yaml
+   ```
+
 Registration must be pass automatically via job register
 
 ## Configuration

diff --git a/charts/k3/example/README.md b/charts/k3/example/README.md
@@ -1,3 +1,4 @@
 ## Generate keys
 
 For generate keys read this doc https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation
+> Dont use secret in open way, try to figure out with [vault](https://github.com/hashicorp/vault) / [sealed-secrets](https://github.com/bitnami-labs/sealed-secrets) / [sops](https://github.com/getsops/sops)
diff --git a/charts/openoracle/README.md b/charts/openoracle/README.md
@@ -29,7 +29,7 @@ helm install openoracle p2p-avs/openoracle -f values.yaml
    - [Openoracle Configs](https://github.com/0xJomo/openoracle-configs)
 
 2. Create a secret in Kubernetes for any workflow you want. Example you can find in `./examples`
-
+> Dont use secret in open way, try to figure out with [vault](https://github.com/hashicorp/vault) / [sealed-secrets](https://github.com/bitnami-labs/sealed-secrets) / [sops](https://github.com/getsops/sops)
 3. Fill the placeholders in your `values.yaml` file:
    - `YOUR_OPERATOR_ADDRESS`
    - `YOUR_ECDSA_SIGN_KEY_SECRET`

diff --git a/charts/openoracle/example/README.md b/charts/openoracle/example/README.md
@@ -3,3 +3,5 @@
 For generate keys read this docs  
 - https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation
 - https://github.com/0xJomo/openoracle-configs
+
+> Dont use secret in open way, try to figure out with [vault](https://github.com/hashicorp/vault) / [sealed-secrets](https://github.com/bitnami-labs/sealed-secrets) / [sops](https://github.com/getsops/sops)