Skip to content

Commit

Permalink
docs: use consistent password in plugin generator examples (argoproj#…
Browse files Browse the repository at this point in the history
…14837)

* docs: use consistent password in plugin generator examples

The example secret with the token is using `strong-password`, but the later examples use `string-password`.

This updates all of the examples to use `strong-password`.

Signed-off-by: Nicholas Morey <nicholas@morey.tech>

* docs: update another-secret example to include `strong-password`

Consistent with above example of client token in argocd-secret

Signed-off-by: Nicholas Morey <nicholas@morey.tech>

---------

Signed-off-by: Nicholas Morey <nicholas@morey.tech>
  • Loading branch information
morey-tech authored Aug 2, 2023
1 parent 3f9133e commit c721592
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/operator-manual/applicationset/Generators-Plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@ metadata:
type: Opaque
data:
# ...
# The secret value must be base64 encoded **once**
# this value corresponds to: `printf "strong-password" | base64`
# The secret value must be base64 encoded **once**.
# this value corresponds to: `printf "strong-password" | base64`.
plugin.myplugin.token: "c3Ryb25nLXBhc3N3b3Jk"
# ...
```
Expand Down Expand Up @@ -124,9 +124,9 @@ type: Opaque
data:
# ...
# Store client secret like below.
# Ensure the secret is base64 encoded
plugin.myplugin.token: <client-secret-base64-encoded>
# ...
# The secret value must be base64 encoded **once**.
# This value corresponds to: `printf "strong-password" | base64`.
plugin.myplugin.token: "c3Ryb25nLXBhc3N3b3Jk"
```
### HTTP server
Expand All @@ -138,7 +138,7 @@ You can deploy it either as a sidecar or as a standalone deployment (the latter
In the example, the token is stored in a file at this location : `/var/run/argo/token`

```
string-password
strong-password
```
```python
Expand Down Expand Up @@ -199,7 +199,7 @@ if __name__ == '__main__':
Execute getparams with curl :

```
curl http://localhost:4355/api/v1/getparams.execute -H "Authorization: Bearer string-password" -d \
curl http://localhost:4355/api/v1/getparams.execute -H "Authorization: Bearer strong-password" -d \
'{
"applicationSetName": "fake-appset",
"input": {
Expand Down Expand Up @@ -283,7 +283,7 @@ To illustrate :
- The generator plugin would then perform 2 requests as follows :

```shell
curl http://localhost:4355/api/v1/getparams.execute -H "Authorization: Bearer string-password" -d \
curl http://localhost:4355/api/v1/getparams.execute -H "Authorization: Bearer strong-password" -d \
'{
"applicationSetName": "fb-matrix",
"input": {
Expand All @@ -297,7 +297,7 @@ curl http://localhost:4355/api/v1/getparams.execute -H "Authorization: Bearer st
Then,

```shell
curl http://localhost:4355/api/v1/getparams.execute -H "Authorization: Bearer string-password" -d \
curl http://localhost:4355/api/v1/getparams.execute -H "Authorization: Bearer strong-password" -d \
'{
"applicationSetName": "fb-matrix",
"input": {
Expand Down

0 comments on commit c721592

Please sign in to comment.