Skip to content

Commit f832b28

Browse files
committed
Add examples for IAM language
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent d93d4e1 commit f832b28

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/openfaas-pro/iam/overview.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,16 @@ Permissions can be scoped cluster wide, or to a specific namespace:
9191
* `*` - cluster-wide access
9292
* `staging:*` - access to the `staging` namespace only
9393

94+
## OpenFaaS IAM language
95+
96+
The OpenFaaS IAM language is a inspired by AWS IAM, however only a subset of the language is implemented at present:
97+
98+
* `StringEquals` - match a string exactly this would be used to match an exact email address or issuer
99+
* `StringLike` - match a string with a wildcard - this could be used to match an email domain for instance
100+
* `ForAnyValue:StringEqual` - match a value within an array, this can be used to check group membership
101+
102+
There is currently no support for negation, such as `NotStringEquals` or `NotStringLike`.
103+
94104
## Concepts
95105

96106
OpenFaaS IAM objects are defined in the `openfaas` namespace, and need to be created by a system administrator using kubectl, Helm or a GitOps tool.

0 commit comments

Comments
 (0)