Convert the existing swagger2.0 file to a moden OpenAPI file.
Add missing endpoitns and model definitions.
Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
With this change /system/info endpoint is going to give
information about the platform architecture it is running on
(arm64, armhf, x86_64)
Signed-off-by: Ivana Yovcheva (VMware) <iyovcheva@vmware.com>
The documentation for async-function pointed to
the old faas/guide and should be to docs.openfaas.com
Signed-off-by: gabrielsson <max.gabrielsson@gmail.com>
**What**
- Document the new logs handler url env variable in the gateway readme
- Document the logs handler in the swagger docs
Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
Previous Spec was flawed as it showed that the response model was
```
[
{
"name": "aws-key",
"value": "changeme"
}
]
```
Changed the model to match what is returned
Signed-off-by: Rishabh Gupta<r.g.gupta@outlook.com>
- added secret definition and removed types used previously
Remove structs for secrets
- after discussion on PR the core contributors decided we just
want simple CRUD with the Secret type.
Signed-off-by: Alex Ellis (VMware) <alexellis2@gmail.com>
The scaling endpoint supports POST method, but in Swagger it was
documented with GET instead. Also bumped up the gateway version
to 0.8.12
Signed-off-by: Ivana Yovcheva (VMware) <iyovcheva@vmware.com>
Changes:
Increased version to reflect latest
Every path now is in ''
Added all receivable Status Codes
Made use of Schemas
Added required annotation to models
Signed-off-by: Simon Pelczer <templum.dev@gmail.com>
- exposes scale-function endpoint for use with faas-idler, this
is protected by auth when enabled.
Signed-off-by: Alex Ellis (VMware) <alexellis2@gmail.com>
1. Add new annotation attributes which may be used
by the back-end for making scheduling or routing decisions.
2. Updated tests/README.md to give clearer instructions on creating and
tearing down the stack required to run the integration tests
3. Update ci.sh
* Fail as soon as an error is encountered
* Allow script to run locally in development environment, test if repos
are already cloned etc..
* Deploy ./stack.yml used by existing integration tests
Signed-off-by: Edward Wilde <ewilde@gmail.com>
EnvVars are incorrectly marked as arrays and this is causing some
confusion. Made a fix with Ivana reviewing and tested in Swagger
UI. https://github.com/openfaas/faas-netes/issues/204
Signed-off-by: Alex Ellis (VMware) <alexellis2@gmail.com>
**What**
- Add a description for the secret key to the api swagger spec.
- Remove optional examples from the secret management guide.
- Update the ApiKeyProtected README to point at the new guide.
- Refactor the `makeSpec` function to accept the already assembled secrets
array because this should be easier to unit test.
Signed-off-by: Lucas Roesler <lucas.roesler@gmail.com>
**What**
- During function creation, accept an array of strings defining swarm secrets
that are required for the service
- Update docs
- Add new guide on using the secrets capability
- Add new sample function to highlight using environment variables
- Update `ApiKeyProtected` sample function to utilize the new secrets
capabilities
**Why**
- This allows secrets to remain encrypted at rest instead of being unencrypted
in environment variables and yaml files.
Fixes#285
Signed-off-by: Lucas Roesler <lucas.roesler@gmail.com>
Note, not all `alexellis/github` references should be changed, there are
a number of repos which are not part of the openfaas org, this commit
excludes those.
Signed-off-by: John McCabe <john@johnmccabe.net>
This commit implements an update handler for Docker Swarm, it queries the
current spec, updates values in-situ before calling ServiceUpdate.
The UpdateConfig FailureAction is set to rollback, so in the event of
supplying values to the update that would result in the service failing
then the update will be rolled back.
The UpdateConfig Parallelism param is set to an explicit value of 1 which
will result in functions being updated 1 by 1 rather than all at once.
It also moves the restartDelay declaration out of the create and update
handlers and into the main server function alongside maxRestarts.
And finally this commit uses the PUT HTTP verb for updates rather than
the non-HTTP UPDATE verb which was being used initially (also adding it
to the Swagger definition).
Signed-off-by: John McCabe <john@johnmccabe.net>
This adds support for private docker registries, by adding
an optional `registryAuth` field in the CreateFunctionRequest.
Auth must be passed as base64-encoded basic auth, similar to
how done in Docker file store credentials (~/.docker/config.json).
Credentials are then passed to swarm at service creation.
