Skip to content

Commit

Permalink
Fix lint: update terraform docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kimlisa committed Nov 1, 2024
1 parent f8dc68e commit 012ed63
Show file tree
Hide file tree
Showing 3 changed files with 296 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/pages/reference/terraform-provider/data-sources/role.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ Optional:

- `annotations` (Map of List of String) Annotations is a collection of annotations to be programmatically appended to pending Access Requests at the time of their creation. These annotations serve as a mechanism to propagate extra information to plugins. Since these annotations support variable interpolation syntax, they also offer a mechanism for forwarding claims from an external identity provider, to a plugin via `{{external.trait_name}}` style substitutions.
- `claims_to_roles` (Attributes List) ClaimsToRoles specifies a mapping from claims (traits) to teleport roles. (see [below for nested schema](#nested-schema-for-specallowrequestclaims_to_roles))
- `kubernetes_resources` (Attributes List) kubernetes_resources can optionally enforce a requester to request only certain kinds of kube resources. Eg: Users can make request to either a resource kind "kube_cluster" or any of its subresources like "namespaces". This field can be defined such that it prevents a user from requesting "kube_cluster" and enforce requesting any of its subresources. (see [below for nested schema](#nested-schema-for-specallowrequestkubernetes_resources))
- `max_duration` (String) MaxDuration is the amount of time the access will be granted for. If this is zero, the default duration is used.
- `roles` (List of String) Roles is the name of roles which will match the request rule.
- `search_as_roles` (List of String) SearchAsRoles is a list of extra roles which should apply to a user while they are searching for resources as part of a Resource Access Request, and defines the underlying roles which will be requested as part of any Resource Access Request.
Expand All @@ -154,6 +155,13 @@ Optional:
- `value` (String) Value is a claim value to match.


### Nested Schema for `spec.allow.request.kubernetes_resources`

Optional:

- `kind` (String) kind specifies the Kubernetes Resource type.


### Nested Schema for `spec.allow.request.thresholds`

Optional:
Expand Down Expand Up @@ -311,6 +319,7 @@ Optional:

- `annotations` (Map of List of String) Annotations is a collection of annotations to be programmatically appended to pending Access Requests at the time of their creation. These annotations serve as a mechanism to propagate extra information to plugins. Since these annotations support variable interpolation syntax, they also offer a mechanism for forwarding claims from an external identity provider, to a plugin via `{{external.trait_name}}` style substitutions.
- `claims_to_roles` (Attributes List) ClaimsToRoles specifies a mapping from claims (traits) to teleport roles. (see [below for nested schema](#nested-schema-for-specdenyrequestclaims_to_roles))
- `kubernetes_resources` (Attributes List) kubernetes_resources can optionally enforce a requester to request only certain kinds of kube resources. Eg: Users can make request to either a resource kind "kube_cluster" or any of its subresources like "namespaces". This field can be defined such that it prevents a user from requesting "kube_cluster" and enforce requesting any of its subresources. (see [below for nested schema](#nested-schema-for-specdenyrequestkubernetes_resources))
- `max_duration` (String) MaxDuration is the amount of time the access will be granted for. If this is zero, the default duration is used.
- `roles` (List of String) Roles is the name of roles which will match the request rule.
- `search_as_roles` (List of String) SearchAsRoles is a list of extra roles which should apply to a user while they are searching for resources as part of a Resource Access Request, and defines the underlying roles which will be requested as part of any Resource Access Request.
Expand All @@ -326,6 +335,13 @@ Optional:
- `value` (String) Value is a claim value to match.


### Nested Schema for `spec.deny.request.kubernetes_resources`

Optional:

- `kind` (String) kind specifies the Kubernetes Resource type.


### Nested Schema for `spec.deny.request.thresholds`

Optional:
Expand Down
16 changes: 16 additions & 0 deletions docs/pages/reference/terraform-provider/resources/role.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@ Optional:

- `annotations` (Map of List of String) Annotations is a collection of annotations to be programmatically appended to pending Access Requests at the time of their creation. These annotations serve as a mechanism to propagate extra information to plugins. Since these annotations support variable interpolation syntax, they also offer a mechanism for forwarding claims from an external identity provider, to a plugin via `{{external.trait_name}}` style substitutions.
- `claims_to_roles` (Attributes List) ClaimsToRoles specifies a mapping from claims (traits) to teleport roles. (see [below for nested schema](#nested-schema-for-specallowrequestclaims_to_roles))
- `kubernetes_resources` (Attributes List) kubernetes_resources can optionally enforce a requester to request only certain kinds of kube resources. Eg: Users can make request to either a resource kind "kube_cluster" or any of its subresources like "namespaces". This field can be defined such that it prevents a user from requesting "kube_cluster" and enforce requesting any of its subresources. (see [below for nested schema](#nested-schema-for-specallowrequestkubernetes_resources))
- `max_duration` (String) MaxDuration is the amount of time the access will be granted for. If this is zero, the default duration is used.
- `roles` (List of String) Roles is the name of roles which will match the request rule.
- `search_as_roles` (List of String) SearchAsRoles is a list of extra roles which should apply to a user while they are searching for resources as part of a Resource Access Request, and defines the underlying roles which will be requested as part of any Resource Access Request.
Expand All @@ -208,6 +209,13 @@ Optional:
- `value` (String) Value is a claim value to match.


### Nested Schema for `spec.allow.request.kubernetes_resources`

Optional:

- `kind` (String) kind specifies the Kubernetes Resource type.


### Nested Schema for `spec.allow.request.thresholds`

Optional:
Expand Down Expand Up @@ -365,6 +373,7 @@ Optional:

- `annotations` (Map of List of String) Annotations is a collection of annotations to be programmatically appended to pending Access Requests at the time of their creation. These annotations serve as a mechanism to propagate extra information to plugins. Since these annotations support variable interpolation syntax, they also offer a mechanism for forwarding claims from an external identity provider, to a plugin via `{{external.trait_name}}` style substitutions.
- `claims_to_roles` (Attributes List) ClaimsToRoles specifies a mapping from claims (traits) to teleport roles. (see [below for nested schema](#nested-schema-for-specdenyrequestclaims_to_roles))
- `kubernetes_resources` (Attributes List) kubernetes_resources can optionally enforce a requester to request only certain kinds of kube resources. Eg: Users can make request to either a resource kind "kube_cluster" or any of its subresources like "namespaces". This field can be defined such that it prevents a user from requesting "kube_cluster" and enforce requesting any of its subresources. (see [below for nested schema](#nested-schema-for-specdenyrequestkubernetes_resources))
- `max_duration` (String) MaxDuration is the amount of time the access will be granted for. If this is zero, the default duration is used.
- `roles` (List of String) Roles is the name of roles which will match the request rule.
- `search_as_roles` (List of String) SearchAsRoles is a list of extra roles which should apply to a user while they are searching for resources as part of a Resource Access Request, and defines the underlying roles which will be requested as part of any Resource Access Request.
Expand All @@ -380,6 +389,13 @@ Optional:
- `value` (String) Value is a claim value to match.


### Nested Schema for `spec.deny.request.kubernetes_resources`

Optional:

- `kind` (String) kind specifies the Kubernetes Resource type.


### Nested Schema for `spec.deny.request.thresholds`

Optional:
Expand Down
Loading

0 comments on commit 012ed63

Please sign in to comment.