Browse Source

fix: the esoctl tooling website was not working (#4383)

Signed-off-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com>
Gergely Brautigam 1 year ago
parent
commit
92b7ebcc6b
2 changed files with 13 additions and 11 deletions
  1. 10 10
      docs/guides/using-esoctl-tool.md
  2. 3 1
      docs/snippets/esoctl-tool-push-secret-snippet.yaml

+ 10 - 10
docs/guides/using-esoctl-tool.md

@@ -5,8 +5,9 @@ The tool can be found under `cmd/esoctl`. The `template` command can be used to
 To run render simply execute `make build` in the `cmd/esoctl` folder. This will result in a binary under `cmd/esoctl/bin`.
 
 Once the build succeeds, the command can be used as such:
-```console
-./bin/esoctl template --source-templated-object template-test/push-secret.yaml --source-secret-data-file template-test/secret.yaml
+
+```
+bin/esoctl template --source-templated-object template-test/push-secret.yaml --source-secret-data-file template-test/secret.yaml
 ```
 
 Where template-test looks like this:
@@ -22,7 +23,6 @@ template-test/
 
 `PushSecret` is simply the following:
 
-
 ```yaml
 {% include 'esoctl-tool-push-secret-snippet.yaml' %}
 ```
@@ -38,21 +38,21 @@ simply put it into a file along with the data it's using, and run this command.
 
 The output will be something like this:
 
-```console
-➜ ./bin/esoctl template --source-templated-object template-test/push-secret.yaml --source-secret-data-file template-test/secret.yaml
+```
+bin/esoctl template --source-templated-object template-test/push-secret.yaml --source-secret-data-file template-test/secret.yaml
 data:
   token: VE9LRU4gd2FzIHRlbXBsYXRlZA==
 metadata:
   creationTimestamp: null
 
-echo -n "VE9LRU4gd2FzIHRlbXBsYXRlZA==" | base64 -d
+echo -n "VE9LRU4gd2FzIHRlbXBsYXRlZA==" | base64 -d
 TOKEN was templated⏎
 ```
 
 Further options can be used to provide templates from a ConfigMap or a Secret:
 ```
-➜ ./bin/esoctl template --source-templated-object template-test/push-secret.yaml \
-    --source-secret-data-file template-test/secret.yaml \
-    --template-from-config-map template-test/template-config-map.yaml \
-    --template-from-secret template-test/template-secret.yaml
+bin/esoctl template --source-templated-object template-test/push-secret.yaml \
+  --source-secret-data-file template-test/secret.yaml \
+  --template-from-config-map template-test/template-config-map.yaml \
+  --template-from-secret template-test/template-secret.yaml
 ```

+ 3 - 1
docs/snippets/esoctl-tool-push-secret-snippet.yaml

@@ -1,3 +1,4 @@
+{% raw %}
 apiVersion: external-secrets.io/v1alpha1
 kind: PushSecret
 metadata:
@@ -19,4 +20,5 @@ spec:
         secretKey: token
         remoteRef:
           remoteKey: git-sync-secret-copy-templated
-          property: token
+          property: token
+{% endraw %}