Doc formatting update

Corrected indentation for the `nonResourcePath` and got a bit zealous with restructuring that section...
This commit is contained in:
Justin Nauman
2017-03-05 15:53:32 -06:00
committed by Andrew Chen
parent 133af46f89
commit d8595aa4ea
+16 -6
View File
@@ -87,15 +87,25 @@ properties:
- Subject-matching properties: - Subject-matching properties:
- `user`, type string; the user-string from `--token-auth-file`. If you specify `user`, it must match the username of the authenticated user. - `user`, type string; the user-string from `--token-auth-file`. If you specify `user`, it must match the username of the authenticated user.
- `group`, type string; if you specify `group`, it must match one of the groups of the authenticated user. `system:authenticated` matches all authenticated requests. `system:unauthenticated` matches all unauthenticated requests. - `group`, type string; if you specify `group`, it must match one of the groups of the authenticated user. `system:authenticated` matches all authenticated requests. `system:unauthenticated` matches all unauthenticated requests.
- `readonly`, type boolean, when true, means that the policy only applies to get, list, and watch operations.
- Resource-matching properties: - Resource-matching properties:
- `apiGroup`, type string; an API group, such as `extensions`. `*` matches all API groups. - `apiGroup`, type string; an API group.
- `namespace`, type string; a namespace string. `*` matches all resource requests. - Ex: `extensions`
- `resource`, type string; a resource, such as `pods`. `*` matches all resource requests. - Wildard: `*` matches all API groups.
- `namespace`, type string; a namespace.
- Ex: `kube-system`
- Wildard: `*` matches all resource requests.
- `resource`, type string; a resource type
- Ex: `pods`
- Wildcard: `*` matches all resource requests.
- Non-resource-matching properties: - Non-resource-matching properties:
- `nonResourcePath`, type string; matches the non-resource request paths (like `/version` and `/apis`). `*` matches all non-resource requests. `/foo/*` matches `/foo/` and all of its subpaths. - `nonResourcePath`, type string; non-resource request paths.
- Ex: `/version` or `/apis`
- Wildcard:
- `*` matches all non-resource requests.
- `/foo/*` matches `/foo/` and all of its subpaths.
- `readonly`, type boolean, when true, means that the policy only applies to get, list, and watch operations.
An unset property is the same as a property set to the zero value for its type **NOTES:** An unset property is the same as a property set to the zero value for its type
(e.g. empty string, 0, false). However, unset should be preferred for (e.g. empty string, 0, false). However, unset should be preferred for
readability. readability.