Skip to content

Commit 8930d35

Browse files
authored
Update README.md
1 parent c538ad1 commit 8930d35

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ creates tokens for the [oc-gate](https://github.com/yaacov/oc-gate) service
77
[![Go Report Card](https://goreportcard.com/badge/github.com/yaacov/oc-gate-operator)](https://goreportcard.com/report/github.com/yaacov/oc-gate-operator)
88
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
99

10+
Requesting a token for [oc-gate](https://github.com/yaacov/oc-gate) service is done using GateToken CRD,
11+
12+
Available fields are:
13+
14+
- user-id: string (required), user-id is the user id of the user requesting this token.
15+
- match-path: string (required), match-path is a regular expresion used to validate API request path, API requests matching this pattern will be validated by the token. This field may not be empty.
16+
- match-method: string, a comma separeted list of allowed http methods, defoult is "GET,OPTIONS"
17+
- duration-sec: int, duration-sec is the duration in sec the token will be validated since it's invocation. Defalut value is 3600s (1h).
18+
- from: string, from is time of token invocation, the token will not validate before this time, the token duration will start from this time. Defalut to token object creation time.
19+
20+
Creating a token requires a secret holding a RSA private-key for sighing the token in the namespace of the token (secret name: oc-gate-jwt-secret), nce token is ready it will be available in the GateToken status.
21+
1022
Get a token:
1123

1224
[![asciicast](https://asciinema.org/a/397136.svg)](https://asciinema.org/a/397136)

0 commit comments

Comments
 (0)