Skip to content

Commit

Permalink
Update operator crd-docs lint
Browse files Browse the repository at this point in the history
  • Loading branch information
kimlisa committed Oct 31, 2024
1 parent b2aba54 commit d69b2f5
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|---|---|---|
|annotations|object|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|[][object](#specallowrequestclaims_to_roles-items)|ClaimsToRoles specifies a mapping from claims (traits) to teleport roles.|
|kubernetes_resources|[][object](#specallowrequestkubernetes_resources-items)|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.|
|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|[]string|Roles is the name of roles which will match the request rule.|
|search_as_roles|[]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 @@ -134,6 +135,12 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|roles|[]string|Roles is a list of static teleport roles to match.|
|value|string|Value is a claim value to match.|

### spec.allow.request.kubernetes_resources items

|Field|Type|Description|
|---|---|---|
|kind|string|kind specifies the Kubernetes Resource type.|

### spec.allow.request.thresholds items

|Field|Type|Description|
Expand Down Expand Up @@ -278,6 +285,7 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|---|---|---|
|annotations|object|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|[][object](#specdenyrequestclaims_to_roles-items)|ClaimsToRoles specifies a mapping from claims (traits) to teleport roles.|
|kubernetes_resources|[][object](#specdenyrequestkubernetes_resources-items)|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.|
|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|[]string|Roles is the name of roles which will match the request rule.|
|search_as_roles|[]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 @@ -292,6 +300,12 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|roles|[]string|Roles is a list of static teleport roles to match.|
|value|string|Value is a claim value to match.|

### spec.deny.request.kubernetes_resources items

|Field|Type|Description|
|---|---|---|
|kind|string|kind specifies the Kubernetes Resource type.|

### spec.deny.request.thresholds items

|Field|Type|Description|
Expand Down Expand Up @@ -519,6 +533,7 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|---|---|---|
|annotations|object|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|[][object](#specallowrequestclaims_to_roles-items)|ClaimsToRoles specifies a mapping from claims (traits) to teleport roles.|
|kubernetes_resources|[][object](#specallowrequestkubernetes_resources-items)|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.|
|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|[]string|Roles is the name of roles which will match the request rule.|
|search_as_roles|[]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 @@ -533,6 +548,12 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|roles|[]string|Roles is a list of static teleport roles to match.|
|value|string|Value is a claim value to match.|

### spec.allow.request.kubernetes_resources items

|Field|Type|Description|
|---|---|---|
|kind|string|kind specifies the Kubernetes Resource type.|

### spec.allow.request.thresholds items

|Field|Type|Description|
Expand Down Expand Up @@ -677,6 +698,7 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|---|---|---|
|annotations|object|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|[][object](#specdenyrequestclaims_to_roles-items)|ClaimsToRoles specifies a mapping from claims (traits) to teleport roles.|
|kubernetes_resources|[][object](#specdenyrequestkubernetes_resources-items)|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.|
|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|[]string|Roles is the name of roles which will match the request rule.|
|search_as_roles|[]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 @@ -691,6 +713,12 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|roles|[]string|Roles is a list of static teleport roles to match.|
|value|string|Value is a claim value to match.|

### spec.deny.request.kubernetes_resources items

|Field|Type|Description|
|---|---|---|
|kind|string|kind specifies the Kubernetes Resource type.|

### spec.deny.request.thresholds items

|Field|Type|Description|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|---|---|---|
|annotations|object|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|[][object](#specallowrequestclaims_to_roles-items)|ClaimsToRoles specifies a mapping from claims (traits) to teleport roles.|
|kubernetes_resources|[][object](#specallowrequestkubernetes_resources-items)|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.|
|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|[]string|Roles is the name of roles which will match the request rule.|
|search_as_roles|[]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 @@ -134,6 +135,12 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|roles|[]string|Roles is a list of static teleport roles to match.|
|value|string|Value is a claim value to match.|

### spec.allow.request.kubernetes_resources items

|Field|Type|Description|
|---|---|---|
|kind|string|kind specifies the Kubernetes Resource type.|

### spec.allow.request.thresholds items

|Field|Type|Description|
Expand Down Expand Up @@ -278,6 +285,7 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|---|---|---|
|annotations|object|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|[][object](#specdenyrequestclaims_to_roles-items)|ClaimsToRoles specifies a mapping from claims (traits) to teleport roles.|
|kubernetes_resources|[][object](#specdenyrequestkubernetes_resources-items)|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.|
|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|[]string|Roles is the name of roles which will match the request rule.|
|search_as_roles|[]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 @@ -292,6 +300,12 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|roles|[]string|Roles is a list of static teleport roles to match.|
|value|string|Value is a claim value to match.|

### spec.deny.request.kubernetes_resources items

|Field|Type|Description|
|---|---|---|
|kind|string|kind specifies the Kubernetes Resource type.|

### spec.deny.request.thresholds items

|Field|Type|Description|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|---|---|---|
|annotations|object|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|[][object](#specallowrequestclaims_to_roles-items)|ClaimsToRoles specifies a mapping from claims (traits) to teleport roles.|
|kubernetes_resources|[][object](#specallowrequestkubernetes_resources-items)|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.|
|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|[]string|Roles is the name of roles which will match the request rule.|
|search_as_roles|[]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 @@ -134,6 +135,12 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|roles|[]string|Roles is a list of static teleport roles to match.|
|value|string|Value is a claim value to match.|

### spec.allow.request.kubernetes_resources items

|Field|Type|Description|
|---|---|---|
|kind|string|kind specifies the Kubernetes Resource type.|

### spec.allow.request.thresholds items

|Field|Type|Description|
Expand Down Expand Up @@ -278,6 +285,7 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|---|---|---|
|annotations|object|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|[][object](#specdenyrequestclaims_to_roles-items)|ClaimsToRoles specifies a mapping from claims (traits) to teleport roles.|
|kubernetes_resources|[][object](#specdenyrequestkubernetes_resources-items)|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.|
|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|[]string|Roles is the name of roles which will match the request rule.|
|search_as_roles|[]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 @@ -292,6 +300,12 @@ resource, which you can apply after installing the Teleport Kubernetes operator.
|roles|[]string|Roles is a list of static teleport roles to match.|
|value|string|Value is a claim value to match.|

### spec.deny.request.kubernetes_resources items

|Field|Type|Description|
|---|---|---|
|kind|string|kind specifies the Kubernetes Resource type.|

### spec.deny.request.thresholds items

|Field|Type|Description|
Expand Down

0 comments on commit d69b2f5

Please sign in to comment.