Packages:

addons.projectcapsule.dev/v1beta2

Resource Types:

ResourcePermit

↩ Parent

ResourcePermit is the Schema for the ResourcePermits API.

NameTypeDescriptionRequired
apiVersionstringaddons.projectcapsule.dev/v1beta2true
kindstringResourcePermittrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobjectResourcePermitSpec defines the desired state of ResourcePermit.
false
statusobjectResourcePermitStatus defines the observed state of ResourcePermit.
false

ResourcePermit.spec

↩ Parent

ResourcePermitSpec defines the desired state of ResourcePermit.

NameTypeDescriptionRequired
templateobjectTemplate references the template to use for this request.
true
durationstringThe duration of this ResourcePermit should be valid for. If no duration was defined, the lifecycle is bound to the request itself - if the request is deleted, it's the end of the duration. The Request can also be Terminated by another automation via calling the ExpirePermit() API-Function.
false
paramsobjectParams the parameters to use for the template.
false
reasonstringA reason on why the request is needed
false
requestorobjectRequesting actor for the resource permit.
false
startTimestringOptional point in time when the permit should become active. Must be in the future. If omitted, this is set to the current time. The Request must already be approved before the start time.

Format: date-time
false

ResourcePermit.spec.template

↩ Parent

Template references the template to use for this request.

NameTypeDescriptionRequired
kindenumKind of template being referenced.

Enum: ResourcePermitTemplate, GlobalResourcePermitTemplate
true
namestringName of the template being referenced.
true

ResourcePermit.spec.requestor

↩ Parent

Requesting actor for the resource permit.

NameTypeDescriptionRequired
groups[]stringThe groups the entity belongs to
false
namestringThe name of the entity
false
typeenumThe type of the entity

Enum: User, Group, System, ServiceAccount
false

ResourcePermit.status

↩ Parent

ResourcePermitStatus defines the observed state of ResourcePermit.

NameTypeDescriptionRequired
sizeintegerNumber of managed resources.
true
activeobjectShows timestamps between approval and termination of the request.
false
conditions[]objectConditions describes current operational state such as readiness.
false
failureobjectFailure describes a recoverable preflight or activation failure. RetryPhase is the trusted lifecycle phase Capsule resumes after a successful retry.
false
keepUntilstringThe time until which the ResourcePermit should be retained after it expires (e.g. for auditing). If unset, the ResourcePermit can be deleted immediately after expiring.

Format: date-time
false
phaseenum

Enum: Created, Requested, Pending, Denied, Approved, Active, Failed, Retrying, Expired
false
processedItems[]objectList of resources managed by the API object.
false
requestobjectRequest contains the resolved template, execution identity, lifecycle properties, and rendered resources presented for review.
false
reviewobjectReview refers to the subject that either approved or denied the request
false
transitions[]objectTransitions is the chronological, append-only audit trail of lifecycle changes. Conditions remain reserved for operational state such as Ready.
false

ResourcePermit.status.active

↩ Parent

Shows timestamps between approval and termination of the request.

NameTypeDescriptionRequired
fromstring

Format: date-time
false
untilstring

Format: date-time
false

ResourcePermit.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

NameTypeDescriptionRequired
lastTransitionTimestringlastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
messagestringmessage is a human readable message indicating details about the transition. This may be an empty string.
true
reasonstringreason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
statusenumstatus of the condition, one of True, False, Unknown.

Enum: True, False, Unknown
true
typestringtype of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGenerationintegerobservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
Minimum: 0
false

ResourcePermit.status.failure

↩ Parent

Failure describes a recoverable preflight or activation failure. RetryPhase is the trusted lifecycle phase Capsule resumes after a successful retry.

NameTypeDescriptionRequired
messagestringMessage contains the latest actionable failure returned by Kubernetes.
true
reasonstringReason is the stable machine-readable Ready condition reason.
true
retryPhaseenumRetryPhase is the phase Capsule resumes after recovery succeeds.

Enum: Requested, Approved
true
stageenumStage identifies whether the failure happened before review or while activating an already approved request.

Enum: Preflight, Activation
true

ResourcePermit.status.processedItems[index]

↩ Parent

Advanced Status Item for pin pointing items in tenants/namespaces.

NameTypeDescriptionRequired
groupstring
false
kindstring
false
namestring
false
namespacestring
false
originstring
false
statusobject
false
tenantstring
false
versionstring
false

ResourcePermit.status.processedItems[index].status

↩ Parent

NameTypeDescriptionRequired
statusenumstatus of the condition, one of True, False, Unknown.

Enum: True, False, Unknown
true
typestringtype of condition in CamelCase or in foo.example.com/CamelCase.
true
clusterScopedbooleanIndicates whether the referenced resource is cluster-scoped.
false
createdbooleanIndicates wether the resource was created or adopted
false
lastApplystringAn opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Format: date-time

false
messagestringmessage is a human readable message indicating details about the transition. This may be an empty string.
false
policyobjectPolicy is a lifecycle snapshot for protection and cleanup. Conditions are evaluated from the source block and omitted here. Failed updates retain the previous snapshot; a first successful content write records its policy even if metadata reconciliation fails, so cleanup respects explicit retention. An absent policy on an already applied item preserves legacy behavior.
false

ResourcePermit.status.processedItems[index].status.policy

↩ Parent

Policy is a lifecycle snapshot for protection and cleanup. Conditions are evaluated from the source block and omitted here. Failed updates retain the previous snapshot; a first successful content write records its policy even if metadata reconciliation fails, so cleanup respects explicit retention. An absent policy on an already applied item preserves legacy behavior.

NameTypeDescriptionRequired
creationenumCreation controls how an existing target is handled. Owner requires the resource to have been created by the applying controller and otherwise returns an error. Merge adopts an existing resource when possible and creates the resource when it does not exist.

Enum: Owner, Merge
Default: Owner
false
deletionenumDeletion controls what happens when the parent stops managing the target. Remove deletes resources created for the parent and relinquishes adopted resources. Orphan keeps the resource and removes Capsule's lifecycle metadata. Removal is the default.

Enum: Remove, Orphan
Default: Remove
false
forcebooleanForce allows server-side apply to acquire conflicting field ownership.

Default: false
false
protectbooleanProtect prevents users from changing or deleting the target through admission while it is managed. Protection is enabled by default.

Default: true
false

ResourcePermit.status.request

↩ Parent

Request contains the resolved template, execution identity, lifecycle properties, and rendered resources presented for review.

NameTypeDescriptionRequired
approvalsobjectApprovals is the approval policy copied from the resolved template. It is immutable after rendering so an in-flight request is reviewed against the policy presented with its resource snapshot.
false
durationstring
false
impersonationobjectImpersonation is the resolved identity used for template context loading and managed-resource actions. It is copied from the template before preflight and retained for the request's lifecycle, including cleanup.
false
keepForstring
false
resources[]objectResources contains the fully rendered manifests prepared for this request. These resources are the source of truth for server-side apply and pruning; source templates and rendering context are never copied into the request.
false
startTimestring

Format: date-time
false
templateobjectTemplate identifies the exact template version used to render the request.
false

ResourcePermit.status.request.approvals

↩ Parent

Approvals is the approval policy copied from the resolved template. It is immutable after rendering so an in-flight request is reviewed against the policy presented with its resource snapshot.

NameTypeDescriptionRequired
approvers[]objectApprovers lists the subjects permitted to approve a request manually. When omitted, any subject with permission to update the request status may approve it.
false
autobooleanAuto automatically approves matching requests. Approvers are ignored for automatic approvals.
false
conditions[]stringConditions contains CEL expressions evaluated as an OR list. At least one expression must evaluate to true. When omitted, approval is unconditional.
false

ResourcePermit.status.request.approvals.approvers[index]

↩ Parent

NameTypeDescriptionRequired
kindenumKind of entity. Possible values are "User", "Group", and "ServiceAccount"

Enum: User, Group, ServiceAccount
true
namestringName of the entity.
true

ResourcePermit.status.request.impersonation

↩ Parent

Impersonation is the resolved identity used for template context loading and managed-resource actions. It is copied from the template before preflight and retained for the request’s lifecycle, including cleanup.

NameTypeDescriptionRequired
namestringName of the referent.
true
namespacestringNamespace of the referent.
true

ResourcePermit.status.request.resources[index]

↩ Parent

RenderedResource is an execution-ready group of Kubernetes manifests produced from a ResourceTemplate. It intentionally cannot contain a source template so status consumers and reconcilers only observe concrete targets.

NameTypeDescriptionRequired
targets[]objectTargets are the fully rendered Kubernetes manifests.
true
policyobjectPolicy controls how every rendered target is created and managed.
false

ResourcePermit.status.request.resources[index].policy

↩ Parent

Policy controls how every rendered target is created and managed.

NameTypeDescriptionRequired
creationenumCreation controls how an existing target is handled. Owner requires the resource to have been created by the applying controller and otherwise returns an error. Merge adopts an existing resource when possible and creates the resource when it does not exist.

Enum: Owner, Merge
Default: Owner
false
deletionenumDeletion controls what happens when the parent stops managing the target. Remove deletes resources created for the parent and relinquishes adopted resources. Orphan keeps the resource and removes Capsule's lifecycle metadata. Removal is the default.

Enum: Remove, Orphan
Default: Remove
false
forcebooleanForce allows server-side apply to acquire conflicting field ownership.

Default: false
false
protectbooleanProtect prevents users from changing or deleting the target through admission while it is managed. Protection is enabled by default.

Default: true
false

ResourcePermit.status.request.template

↩ Parent

Template identifies the exact template version used to render the request.

NameTypeDescriptionRequired
kindenumKind of template being referenced.

Enum: ResourcePermitTemplate, GlobalResourcePermitTemplate
true
namestringName of the template being referenced.
true
resourceVersionstringResourceVersion of the template used to render the request resources.
true

ResourcePermit.status.review

↩ Parent

Review refers to the subject that either approved or denied the request

NameTypeDescriptionRequired
messagestringMessage with the review
false
reviewerobjectThe Entity reviewing this request
false
verdictenumThe verdict made by the reviewing entity

Enum: Pending, Denied, Approved
false

ResourcePermit.status.review.reviewer

↩ Parent

The Entity reviewing this request

NameTypeDescriptionRequired
groups[]stringThe groups the entity belongs to
false
namestringThe name of the entity
false
typeenumThe type of the entity

Enum: User, Group, System, ServiceAccount
false

ResourcePermit.status.transitions[index]

↩ Parent

ResourcePermitTransition records one authenticated lifecycle transition.

NameTypeDescriptionRequired
actorobjectActor is the authenticated user, ServiceAccount, or Capsule system actor responsible for the transition. Group claims are deliberately not copied into the audit trail.
true
reasonstringReason is a stable machine-readable explanation of the transition.
true
timestampstringTimestamp is when the transition was requested or performed.

Format: date-time
true
typeenumType identifies the lifecycle state entered by this transition. The previous state can be derived from the preceding chronological entry.

Enum: Created, Requested, Pending, Denied, Approved, Active, Failed, Retrying, Expired
true
eventTimestringEventTime is set after Capsule emits the Kubernetes lifecycle event for this transition.

Format: date-time
false
messagestringMessage is the human-readable explanation of the transition.
false

ResourcePermit.status.transitions[index].actor

↩ Parent

Actor is the authenticated user, ServiceAccount, or Capsule system actor responsible for the transition. Group claims are deliberately not copied into the audit trail.

NameTypeDescriptionRequired
namestringName is the authenticated actor name.
true
typeenumType identifies the kind of authenticated actor.

Enum: User, Group, System, ServiceAccount
true

ResourcePermitTemplate

↩ Parent

ResourcePermitTemplate is the Schema for namespaced ResourcePermit templates.

NameTypeDescriptionRequired
apiVersionstringaddons.projectcapsule.dev/v1beta2true
kindstringResourcePermitTemplatetrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobjectResourcePermitTemplateSpec defines the desired state of a namespaced ResourcePermitTemplate.
true
statusobjectResourcePermitTemplateStatus defines the observed state of ResourcePermitTemplate.
false

ResourcePermitTemplate.spec

↩ Parent

ResourcePermitTemplateSpec defines the desired state of a namespaced ResourcePermitTemplate.

NameTypeDescriptionRequired
impersonationobjectImpersonation identifies the required ServiceAccount used for context loading and every managed-resource action, including cleanup. Namespaced templates use a ServiceAccount in their own namespace; global templates specify both name and namespace. There is no default execution identity.
true
resources[]objectResources rendered and managed by this template.
true
approvalsobjectApprovals configures automatic and manual approval of requests using this template.
false
contextobjectContext loads additional Kubernetes resources for use by all resource targets and templates. Resource reference fields may use parameters declared by ParamSchema.
false
defaultDurationstringThe default duration of a ResourcePermit referencing this template.
false
keepForstringThe duration a ResourcePermit is retained after it expires for auditing.
false
maxDurationstringThe maximum allowed duration of a ResourcePermit referencing this template.
false
paramSchemaobjectParamSchema is the JSON Schema used to validate template parameters. Properties may use the x-capsule-form vendor extension to select values from arbitrary Kubernetes GVKs in compatible form clients. The schema may use x-kubernetes-validations for Kubernetes-compatible CEL rules.
false

ResourcePermitTemplate.spec.impersonation

↩ Parent

Impersonation identifies the required ServiceAccount used for context loading and every managed-resource action, including cleanup. Namespaced templates use a ServiceAccount in their own namespace; global templates specify both name and namespace. There is no default execution identity.

NameTypeDescriptionRequired
namestringName of the referent.
true

ResourcePermitTemplate.spec.resources[index]

↩ Parent

NameTypeDescriptionRequired
policyobjectPolicy controls how every target in this resource group is created and managed.

Default: map[]
false
targets[]objectTargets are Kubernetes resource objects to render and manage with Policy. Parameters and loaded context use the flat template root; trusted request metadata is available under .request.
false
templatestringTemplate is an optional Go template which may render one or more YAML or JSON Kubernetes resources separated by YAML document markers. Request parameters are available under .params and loaded resources under .context.resources. Trusted request metadata is available under .request with name, username, groups, and timestamp fields.
false

ResourcePermitTemplate.spec.resources[index].policy

↩ Parent

Policy controls how every target in this resource group is created and managed.

NameTypeDescriptionRequired
creationenumCreation controls how an existing target is handled. Owner requires the resource to have been created by the applying controller and otherwise returns an error. Merge adopts an existing resource when possible and creates the resource when it does not exist.

Enum: Owner, Merge
Default: Owner
false
deletionenumDeletion controls what happens when the parent stops managing the target. Remove deletes resources created for the parent and relinquishes adopted resources. Orphan keeps the resource and removes Capsule's lifecycle metadata. Removal is the default.

Enum: Remove, Orphan
Default: Remove
false
forcebooleanForce allows server-side apply to acquire conflicting field ownership.

Default: false
false
protectbooleanProtect prevents users from changing or deleting the target through admission while it is managed. Protection is enabled by default.

Default: true
false

ResourcePermitTemplate.spec.approvals

↩ Parent

Approvals configures automatic and manual approval of requests using this template.

NameTypeDescriptionRequired
approvers[]objectApprovers lists the subjects permitted to approve a request manually. When omitted, any subject with permission to update the request status may approve it.
false
autobooleanAuto automatically approves matching requests. Approvers are ignored for automatic approvals.
false
conditions[]stringConditions contains CEL expressions evaluated as an OR list. At least one expression must evaluate to true. When omitted, approval is unconditional.
false

ResourcePermitTemplate.spec.approvals.approvers[index]

↩ Parent

NameTypeDescriptionRequired
kindenumKind of entity. Possible values are "User", "Group", and "ServiceAccount"

Enum: User, Group, ServiceAccount
true
namestringName of the entity.
true

ResourcePermitTemplate.spec.context

↩ Parent

Context loads additional Kubernetes resources for use by all resource targets and templates. Resource reference fields may use parameters declared by ParamSchema.

NameTypeDescriptionRequired
resources[]object
false

ResourcePermitTemplate.spec.context.resources[index]

↩ Parent

NameTypeDescriptionRequired
kindstringKind of the referent.

Use “*” to match all kinds.

true
apiVersionstringAPI version, API group, or API group/version selector of the referent.

Empty APIVersion means the core Kubernetes API version “v1”. Use “*” to explicitly match all API groups and versions.

Examples:

  • "" means core “v1”.
  • “v1” means core “v1”.
  • “apps” means any version in the “apps” API group.
  • “apps/v1” means the “apps/v1” API group/version.
  • “apps/*” means any version in the “apps” API group.
false
indexstringIndex to mount the resource in the template context
false
namestringName of the values referent. This is useful when you traying to get a specific resource
false
namespacestringNamespace of the values referent.
false
optionalbooleanOnly relevant if name is set. If an item is not optional, there will be an error thrown when it does not exist

Default: true
false
selectorobjectSelector which allows to get any amount of these resources based on labels
false

ResourcePermitTemplate.spec.context.resources[index].selector

↩ Parent

Selector which allows to get any amount of these resources based on labels

NameTypeDescriptionRequired
matchExpressions[]objectmatchExpressions is a list of label selector requirements. The requirements are ANDed.
false
matchLabelsmap[string]stringmatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
false

ResourcePermitTemplate.spec.context.resources[index].selector.matchExpressions[index]

↩ Parent

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

NameTypeDescriptionRequired
keystringkey is the label key that the selector applies to.
true
operatorstringoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
true
values[]stringvalues is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
false

ResourcePermitTemplate.status

↩ Parent

ResourcePermitTemplateStatus defines the observed state of ResourcePermitTemplate.

NameTypeDescriptionRequired
conditions[]objectConditions contains the reconciliation conditions for this template.
false
observedGenerationintegerObservedGeneration is the most recent generation resolved by the controller.

Format: int64
false

ResourcePermitTemplate.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

NameTypeDescriptionRequired
lastTransitionTimestringlastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
messagestringmessage is a human readable message indicating details about the transition. This may be an empty string.
true
reasonstringreason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
statusenumstatus of the condition, one of True, False, Unknown.

Enum: True, False, Unknown
true
typestringtype of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGenerationintegerobservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
Minimum: 0
false

GlobalResourcePermitTemplate

↩ Parent

GlobalResourcePermitTemplate is the Schema for the globalresourcepermittemplates API.

NameTypeDescriptionRequired
apiVersionstringaddons.projectcapsule.dev/v1beta2true
kindstringGlobalResourcePermitTemplatetrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobjectGlobalResourcePermitTemplateSpec defines the desired state of GlobalResourcePermitTemplate.
true
statusobjectGlobalResourcePermitTemplateStatus defines the observed state of GlobalResourcePermitTemplate.
false

GlobalResourcePermitTemplate.spec

↩ Parent

GlobalResourcePermitTemplateSpec defines the desired state of GlobalResourcePermitTemplate.

NameTypeDescriptionRequired
impersonationobjectImpersonation identifies the required ServiceAccount used for context loading and every managed-resource action, including cleanup. Namespaced templates use a ServiceAccount in their own namespace; global templates specify both name and namespace. There is no default execution identity.
true
resources[]objectResources rendered and managed by this template.
true
approvalsobjectApprovals configures automatic and manual approval of requests using this template.
false
contextobjectContext loads additional Kubernetes resources for use by all resource targets and templates. Resource reference fields may use parameters declared by ParamSchema.
false
defaultDurationstringThe default duration of the ResourcePermit referencing this template should be valid for. If not set, the resource will be kept until the request is deleted.
false
keepForstringThe duration of this ResourcePermit will be kept in the system after it has been expired (eg. auditing purposes) If not set, the ResourcePermit will be deleted after expiring.
false
maxDurationstringThe max allowed duration of the ResourcePermit referencing this template should be valid for.
false
namespaceSelectors[]objectNamespaceSelectors limit the namespaces in which ResourcePermits may reference this template. Selectors are ORed. When omitted, the template is available in every namespace.
false
paramSchemaobjectParamSchema is the JSON Schema used to validate template parameters. Properties may use the x-capsule-form vendor extension to select values from arbitrary Kubernetes GVKs in compatible form clients. The schema may use x-kubernetes-validations for Kubernetes-compatible CEL rules.
false

GlobalResourcePermitTemplate.spec.impersonation

↩ Parent

Impersonation identifies the required ServiceAccount used for context loading and every managed-resource action, including cleanup. Namespaced templates use a ServiceAccount in their own namespace; global templates specify both name and namespace. There is no default execution identity.

NameTypeDescriptionRequired
namestringName of the referent.
true
namespacestringNamespace of the referent.
true

GlobalResourcePermitTemplate.spec.resources[index]

↩ Parent

NameTypeDescriptionRequired
policyobjectPolicy controls how every target in this resource group is created and managed.

Default: map[]
false
targets[]objectTargets are Kubernetes resource objects to render and manage with Policy. Parameters and loaded context use the flat template root; trusted request metadata is available under .request.
false
templatestringTemplate is an optional Go template which may render one or more YAML or JSON Kubernetes resources separated by YAML document markers. Request parameters are available under .params and loaded resources under .context.resources. Trusted request metadata is available under .request with name, username, groups, and timestamp fields.
false

GlobalResourcePermitTemplate.spec.resources[index].policy

↩ Parent

Policy controls how every target in this resource group is created and managed.

NameTypeDescriptionRequired
creationenumCreation controls how an existing target is handled. Owner requires the resource to have been created by the applying controller and otherwise returns an error. Merge adopts an existing resource when possible and creates the resource when it does not exist.

Enum: Owner, Merge
Default: Owner
false
deletionenumDeletion controls what happens when the parent stops managing the target. Remove deletes resources created for the parent and relinquishes adopted resources. Orphan keeps the resource and removes Capsule's lifecycle metadata. Removal is the default.

Enum: Remove, Orphan
Default: Remove
false
forcebooleanForce allows server-side apply to acquire conflicting field ownership.

Default: false
false
protectbooleanProtect prevents users from changing or deleting the target through admission while it is managed. Protection is enabled by default.

Default: true
false

GlobalResourcePermitTemplate.spec.approvals

↩ Parent

Approvals configures automatic and manual approval of requests using this template.

NameTypeDescriptionRequired
approvers[]objectApprovers lists the subjects permitted to approve a request manually. When omitted, any subject with permission to update the request status may approve it.
false
autobooleanAuto automatically approves matching requests. Approvers are ignored for automatic approvals.
false
conditions[]stringConditions contains CEL expressions evaluated as an OR list. At least one expression must evaluate to true. When omitted, approval is unconditional.
false

GlobalResourcePermitTemplate.spec.approvals.approvers[index]

↩ Parent

NameTypeDescriptionRequired
kindenumKind of entity. Possible values are "User", "Group", and "ServiceAccount"

Enum: User, Group, ServiceAccount
true
namestringName of the entity.
true

GlobalResourcePermitTemplate.spec.context

↩ Parent

Context loads additional Kubernetes resources for use by all resource targets and templates. Resource reference fields may use parameters declared by ParamSchema.

NameTypeDescriptionRequired
resources[]object
false

GlobalResourcePermitTemplate.spec.context.resources[index]

↩ Parent

NameTypeDescriptionRequired
kindstringKind of the referent.

Use “*” to match all kinds.

true
apiVersionstringAPI version, API group, or API group/version selector of the referent.

Empty APIVersion means the core Kubernetes API version “v1”. Use “*” to explicitly match all API groups and versions.

Examples:

  • "" means core “v1”.
  • “v1” means core “v1”.
  • “apps” means any version in the “apps” API group.
  • “apps/v1” means the “apps/v1” API group/version.
  • “apps/*” means any version in the “apps” API group.
false
indexstringIndex to mount the resource in the template context
false
namestringName of the values referent. This is useful when you traying to get a specific resource
false
namespacestringNamespace of the values referent.
false
optionalbooleanOnly relevant if name is set. If an item is not optional, there will be an error thrown when it does not exist

Default: true
false
selectorobjectSelector which allows to get any amount of these resources based on labels
false

GlobalResourcePermitTemplate.spec.context.resources[index].selector

↩ Parent

Selector which allows to get any amount of these resources based on labels

NameTypeDescriptionRequired
matchExpressions[]objectmatchExpressions is a list of label selector requirements. The requirements are ANDed.
false
matchLabelsmap[string]stringmatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
false

GlobalResourcePermitTemplate.spec.context.resources[index].selector.matchExpressions[index]

↩ Parent

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

NameTypeDescriptionRequired
keystringkey is the label key that the selector applies to.
true
operatorstringoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
true
values[]stringvalues is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
false

GlobalResourcePermitTemplate.spec.namespaceSelectors[index]

↩ Parent

Selector for resources and their labels or selecting origin namespaces

NameTypeDescriptionRequired
matchExpressions[]objectmatchExpressions is a list of label selector requirements. The requirements are ANDed.
false
matchLabelsmap[string]stringmatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
false

GlobalResourcePermitTemplate.spec.namespaceSelectors[index].matchExpressions[index]

↩ Parent

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

NameTypeDescriptionRequired
keystringkey is the label key that the selector applies to.
true
operatorstringoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
true
values[]stringvalues is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
false

GlobalResourcePermitTemplate.status

↩ Parent

GlobalResourcePermitTemplateStatus defines the observed state of GlobalResourcePermitTemplate.

NameTypeDescriptionRequired
conditions[]objectConditions contains the reconciliation conditions for this template.
false
namespaces[]stringNamespaces contains the namespaces allowed to reference this template. A single "*" entry means that the template is available in every namespace.
false
observedGenerationintegerObservedGeneration is the most recent generation resolved by the controller.

Format: int64
false

GlobalResourcePermitTemplate.status.conditions[index]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

NameTypeDescriptionRequired
lastTransitionTimestringlastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

Format: date-time
true
messagestringmessage is a human readable message indicating details about the transition. This may be an empty string.
true
reasonstringreason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
true
statusenumstatus of the condition, one of True, False, Unknown.

Enum: True, False, Unknown
true
typestringtype of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGenerationintegerobservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

Format: int64
Minimum: 0
false