mirror of
https://github.com/openfaas/faas.git
synced 2025-06-09 00:36:46 +00:00
Following the existing README instructions would result in an error when the user attempted to create the secret. This small change remediates the instruction so that the secret is successfully created. Signed-off-by: rgee0 <richard@technologee.co.uk>
971 B
971 B
Sample: apikey-secret
This function returns access denied, or unlocked depending on whether your header for X-Api-Key matches a secret in the cluster called secret_api_key
.
See the secure secret management guide for more information on secrets.
Trying the sample:
$ docker secret remove secret_api_key # make sure we delete any existing secret
# Create a secret with Swarm
$ echo -n "secret_value_goes_here" | docker secret create secret_api_key -
# Deploy this sample with Docker Swarm and attach the secret to it
$ cd faas/sample-functions/
$ faas-cli deploy --filter apikey-secret --secret secret_api_key
# Now invoke the function with a good value:
$ echo -n | faas invoke --header "X-Api-Key=secret_value_goes_here" apikey-secret
You unlocked the function.
# Now invoke with a bad value:
echo -n | faas invoke --header "X-Api-Key=wrong_secret_value_goes_here" apikey-secret
Access was denied.