From 0fcd70414c97e7c8b575213d625dfeb30532d833 Mon Sep 17 00:00:00 2001 From: Dario Tranchitella Date: Tue, 4 Oct 2022 11:24:12 +0200 Subject: [PATCH] docs: tenantresource api support --- Makefile | 2 +- .../general/{tenant-crd.md => crds-apis.md} | 1584 ++++++++++++----- docs/content/general/references.md | 2 +- docs/gridsome.server.js | 2 +- 4 files changed, 1170 insertions(+), 420 deletions(-) rename docs/content/general/{tenant-crd.md => crds-apis.md} (89%) diff --git a/Makefile b/Makefile index 753f6bed7..927b476eb 100644 --- a/Makefile +++ b/Makefile @@ -79,7 +79,7 @@ generate: controller-gen $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..." apidoc: apidocs-gen - $(APIDOCS_GEN) crdoc --resources config/crd/bases --output docs/content/general/tenant-crd.md --template docs/template/reference-cr.tmpl + $(APIDOCS_GEN) crdoc --resources config/crd/bases --output docs/content/general/crds-apis.md --template docs/template/reference-cr.tmpl # Helm SRC_ROOT = $(shell git rev-parse --show-toplevel) diff --git a/docs/content/general/tenant-crd.md b/docs/content/general/crds-apis.md similarity index 89% rename from docs/content/general/tenant-crd.md rename to docs/content/general/crds-apis.md index 4a34dc2e4..a026c91c8 100644 --- a/docs/content/general/tenant-crd.md +++ b/docs/content/general/crds-apis.md @@ -1586,6 +1586,8 @@ Resource Types: - [CapsuleConfiguration](#capsuleconfiguration) +- [TenantResource](#tenantresource) + - [Tenant](#tenant) @@ -1848,14 +1850,14 @@ Allows to set different name rather than the canonical one for the Capsule confi -## Tenant +## TenantResource -Tenant is the Schema for the tenants API. +TenantResource is the Schema for the tenantresources API @@ -1875,7 +1877,7 @@ Tenant is the Schema for the tenants API. - + @@ -1884,28 +1886,28 @@ Tenant is the Schema for the tenants API. - + - +
kind stringTenantTenantResource true
Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
specspec object - TenantSpec defines the desired state of Tenant.
+ TenantResourceSpec defines the desired state of TenantResource
 false
statusstatus object - Returns the observed state of the Tenant.
+ TenantResourceStatus defines the observed state of TenantResource
 false
-### Tenant.spec +### TenantResource.spec -TenantSpec defines the desired state of Tenant. +TenantResourceSpec defines the desired state of TenantResource @@ -1917,119 +1919,77 @@ TenantSpec defines the desired state of Tenant. - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - + + +
ownersresources []object - Specifies the owners of the Tenant. Mandatory.
+
true
additionalRoleBindings[]object - Specifies additional RoleBindings assigned to the Tenant. Capsule will ensure that all namespaces in the Tenant always contain the RoleBinding for the given ClusterRole. Optional.
- 		false
containerRegistriesobject - Specifies the trusted Image Registries assigned to the Tenant. Capsule assures that all Pods resources created in the Tenant can use only one of the allowed trusted registries. Optional.
- 		false
cordonedboolean - Toggling the Tenant resources cordoning, when enable resources cannot be deleted.
- 		false
imagePullPolicies[]enum - Specify the allowed values for the imagePullPolicies option in Pod resources. Capsule assures that all Pod resources created in the Tenant can use only one of the allowed policy. Optional.
- 		false
ingressOptionsobject - Specifies options for the Ingress resources, such as allowed hostnames and IngressClass. Optional.
- 		false
limitRangesobject - Specifies the resource min/max usage restrictions to the Tenant. The assigned values are inherited by any namespace created in the Tenant. Optional.
- 		false
namespaceOptionsobject - Specifies options for the Namespaces, such as additional metadata or maximum number of namespaces allowed for that Tenant. Once the namespace quota assigned to the Tenant has been reached, the Tenant owner cannot create further namespaces. Optional.
- 		false
networkPoliciesobject - Specifies the NetworkPolicies assigned to the Tenant. The assigned NetworkPolicies are inherited by any namespace created in the Tenant. Optional.
- 		false
nodeSelectormap[string]string - Specifies the label to control the placement of pods on a given pool of worker nodes. All namespaces created within the Tenant will have the node selector annotation. This annotation tells the Kubernetes scheduler to place pods on the nodes having the selector label. Optional.
- 		false
preventDeletionbooleanresyncPeriodstring - Prevent accidental deletion of the Tenant. When enabled, the deletion request will be declined.
+
+
+ Default: 60s
false
priorityClassestrue
+ + +### TenantResource.spec.resources[index] + + + + + + + + + + + + + + + + - + - - + + - - + +
NameTypeDescriptionRequired
additionalMetadata object - Specifies the allowed priorityClasses assigned to the Tenant. Capsule assures that all Pods resources created in the Tenant can use only one of the allowed PriorityClasses. Optional.
+ Besides the Capsule metadata required by TenantResource controller, defines additional metadata that must be added to the replicated resources.
 false
resourceQuotasnamespaceSelector object - Specifies a list of ResourceQuota resources assigned to the Tenant. The assigned values are inherited by any namespace created in the Tenant. The Capsule operator aggregates ResourceQuota at Tenant level, so that the hard quota is never crossed for the given Tenant. This permits the Tenant owner to consume resources in the Tenant regardless of the namespace. Optional.
+ Defines the Namespace selector to select the Tenant Samespaces on which the resources must be propagated. In case of nil value, all the Tenant Namespaces are targeted.
 false
serviceOptionsobjectnamespacedItems[]object - Specifies options for the Service, such as additional metadata or block of certain type of Services. Optional.
+ List of the resources already existing in other Namespaces that must be replicated.
 false
storageClassesobjectrawItems[]RawExtension - Specifies the allowed StorageClasses assigned to the Tenant. Capsule assures that all PersistentVolumeClaim resources created in the Tenant can use only one of the allowed StorageClasses. Optional.
+ List of raw resources that must be replicated.
 false
-### Tenant.spec.owners[index] - +### TenantResource.spec.resources[index].additionalMetadata +Besides the Capsule metadata required by TenantResource controller, defines additional metadata that must be added to the replicated resources. @@ -2041,44 +2001,28 @@ TenantSpec defines the desired state of Tenant. - - - - - - - + + - - - - - - + - - + +
clusterRoles[]string - Defines additional cluster-roles for the specific Owner.
- 		true
kindenumannotationsmap[string]string - Kind of tenant owner. Possible values are "User", "Group", and "ServiceAccount"

- Enum: User, Group, ServiceAccount
- 		true
namestring - Name of tenant owner.
truefalse
proxySettings[]objectlabelsmap[string]string - Proxy settings for tenant owner.
+
false
-### Tenant.spec.owners[index].proxySettings[index] - +### TenantResource.spec.resources[index].namespaceSelector +Defines the Namespace selector to select the Tenant Samespaces on which the resources must be propagated. In case of nil value, all the Tenant Namespaces are targeted. @@ -2090,30 +2034,28 @@ TenantSpec defines the desired state of Tenant. - - + + - + - - + + - +
kindenummatchExpressions[]object -
-
- Enum: Nodes, StorageClasses, IngressClasses, PriorityClasses
+ matchExpressions is a list of label selector requirements. The requirements are ANDed.
truefalse
operations[]enummatchLabelsmap[string]string -
+ matchLabels 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.
truefalse
-### Tenant.spec.additionalRoleBindings[index] - +### TenantResource.spec.resources[index].namespaceSelector.matchExpressions[index] +A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. @@ -2125,28 +2067,35 @@ TenantSpec defines the desired state of Tenant. - + - - + + + + + + +
clusterRoleNamekey string -
+ key is the label key that the selector applies to.
 true
subjects[]objectoperatorstring - kubebuilder:validation:Minimum=1
+ operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
 true
values[]string + values 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
-### Tenant.spec.additionalRoleBindings[index].subjects[index] +### TenantResource.spec.resources[index].namespacedItems[index] + -Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. @@ -2161,39 +2110,39 @@ Subject contains a reference to the object or user identities a role binding app - + - - + + - + - +
kind string - Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
+ Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
 true
namenamespace string - Name of the object being referenced.
+ Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
 true
apiGroupstringselectorobject - APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
+ Label selector used to select the given resources in the given Namespace.
falsetrue
namespaceapiVersion string - Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+ API version of the referent.
 false
-### Tenant.spec.containerRegistries +### TenantResource.spec.resources[index].namespacedItems[index].selector -Specifies the trusted Image Registries assigned to the Tenant. Capsule assures that all Pods resources created in the Tenant can use only one of the allowed trusted registries. Optional. +Label selector used to select the given resources in the given Namespace. @@ -2205,28 +2154,28 @@ Specifies the trusted Image Registries assigned to the Tenant. Capsule assures t - - + + - - + +
allowed[]stringmatchExpressions[]object -
+ matchExpressions is a list of label selector requirements. The requirements are ANDed.
 false
allowedRegexstringmatchLabelsmap[string]string -
+ matchLabels 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
-### Tenant.spec.ingressOptions +### TenantResource.spec.resources[index].namespacedItems[index].selector.matchExpressions[index] -Specifies options for the Ingress resources, such as allowed hostnames and IngressClass. Optional. +A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. @@ -2238,49 +2187,35 @@ Specifies options for the Ingress resources, such as allowed hostnames and Ingre - - + + - - - - - - - + + - + - - + +
allowWildcardHostnamesbooleankeystring - Toggles the ability for Ingress resources created in a Tenant to have a hostname wildcard.
+ key is the label key that the selector applies to.
 true
allowedClassesobject - Specifies the allowed IngressClasses assigned to the Tenant. Capsule assures that all Ingress resources created in the Tenant can use only one of the allowed IngressClasses. Optional.
- 		false
allowedHostnamesobjectoperatorstring - Specifies the allowed hostnames in Ingresses for the given Tenant. Capsule assures that all Ingress resources created in the Tenant can use only one of the allowed hostnames. Optional.
+ operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
falsetrue
hostnameCollisionScopeenumvalues[]string - Defines the scope of hostname collision check performed when Tenant Owners create Ingress with allowed hostnames. - - Cluster: disallow the creation of an Ingress if the pair hostname and path is already used across the Namespaces managed by Capsule. - - Tenant: disallow the creation of an Ingress if the pair hostname and path is already used across the Namespaces of the Tenant. - - Namespace: disallow the creation of an Ingress if the pair hostname and path is already used in the Ingress Namespace. - Optional.
-
- Enum: Cluster, Tenant, Namespace, Disabled
- Default: Disabled
+ values 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
-### Tenant.spec.ingressOptions.allowedClasses +### TenantResource.status -Specifies the allowed IngressClasses assigned to the Tenant. Capsule assures that all Ingress resources created in the Tenant can use only one of the allowed IngressClasses. Optional. +TenantResourceStatus defines the observed state of TenantResource @@ -2292,12 +2227,519 @@ Specifies the allowed IngressClasses assigned to the Tenant. Capsule assures tha - - + + - + + +
allowed[]stringprocessedItems[]object -
+ Map of the replicated resources for the given TenantResource.
falsetrue
+ + +### TenantResource.status.processedItems[index] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 		true
namestring + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ 		true
namespacestring + Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ 		true
apiVersionstring + API version of the referent.
+ 		false
+ +## Tenant + + + + + + +Tenant is the Schema for the tenants API. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringcapsule.clastix.io/v1beta2true
kindstringTenanttrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + TenantSpec defines the desired state of Tenant.
+ 		false
statusobject + Returns the observed state of the Tenant.
+ 		false
+ + +### Tenant.spec + + + +TenantSpec defines the desired state of Tenant. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
owners[]object + Specifies the owners of the Tenant. Mandatory.
+ 		true
additionalRoleBindings[]object + Specifies additional RoleBindings assigned to the Tenant. Capsule will ensure that all namespaces in the Tenant always contain the RoleBinding for the given ClusterRole. Optional.
+ 		false
containerRegistriesobject + Specifies the trusted Image Registries assigned to the Tenant. Capsule assures that all Pods resources created in the Tenant can use only one of the allowed trusted registries. Optional.
+ 		false
cordonedboolean + Toggling the Tenant resources cordoning, when enable resources cannot be deleted.
+ 		false
imagePullPolicies[]enum + Specify the allowed values for the imagePullPolicies option in Pod resources. Capsule assures that all Pod resources created in the Tenant can use only one of the allowed policy. Optional.
+ 		false
ingressOptionsobject + Specifies options for the Ingress resources, such as allowed hostnames and IngressClass. Optional.
+ 		false
limitRangesobject + Specifies the resource min/max usage restrictions to the Tenant. The assigned values are inherited by any namespace created in the Tenant. Optional.
+ 		false
namespaceOptionsobject + Specifies options for the Namespaces, such as additional metadata or maximum number of namespaces allowed for that Tenant. Once the namespace quota assigned to the Tenant has been reached, the Tenant owner cannot create further namespaces. Optional.
+ 		false
networkPoliciesobject + Specifies the NetworkPolicies assigned to the Tenant. The assigned NetworkPolicies are inherited by any namespace created in the Tenant. Optional.
+ 		false
nodeSelectormap[string]string + Specifies the label to control the placement of pods on a given pool of worker nodes. All namespaces created within the Tenant will have the node selector annotation. This annotation tells the Kubernetes scheduler to place pods on the nodes having the selector label. Optional.
+ 		false
preventDeletionboolean + Prevent accidental deletion of the Tenant. When enabled, the deletion request will be declined.
+ 		false
priorityClassesobject + Specifies the allowed priorityClasses assigned to the Tenant. Capsule assures that all Pods resources created in the Tenant can use only one of the allowed PriorityClasses. Optional.
+ 		false
replicatedResources[]object + Define the resources that must be replicated across the Tenant Namespaces.
+ 		false
resourceQuotasobject + Specifies a list of ResourceQuota resources assigned to the Tenant. The assigned values are inherited by any namespace created in the Tenant. The Capsule operator aggregates ResourceQuota at Tenant level, so that the hard quota is never crossed for the given Tenant. This permits the Tenant owner to consume resources in the Tenant regardless of the namespace. Optional.
+ 		false
serviceOptionsobject + Specifies options for the Service, such as additional metadata or block of certain type of Services. Optional.
+ 		false
storageClassesobject + Specifies the allowed StorageClasses assigned to the Tenant. Capsule assures that all PersistentVolumeClaim resources created in the Tenant can use only one of the allowed StorageClasses. Optional.
+ 		false
+ + +### Tenant.spec.owners[index] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
clusterRoles[]string + Defines additional cluster-roles for the specific Owner.
+ 		true
kindenum + Kind of tenant owner. Possible values are "User", "Group", and "ServiceAccount"
+
+ Enum: User, Group, ServiceAccount
+ 		true
namestring + Name of tenant owner.
+ 		true
proxySettings[]object + Proxy settings for tenant owner.
+ 		false
+ + +### Tenant.spec.owners[index].proxySettings[index] + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindenum +
+
+ Enum: Nodes, StorageClasses, IngressClasses, PriorityClasses
+ 		true
operations[]enum +
+ 		true
+ + +### Tenant.spec.additionalRoleBindings[index] + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
clusterRoleNamestring +
+ 		true
subjects[]object + kubebuilder:validation:Minimum=1
+ 		true
+ + +### Tenant.spec.additionalRoleBindings[index].subjects[index] + + + +Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
+ 		true
namestring + Name of the object being referenced.
+ 		true
apiGroupstring + APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
+ 		false
namespacestring + Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+ 		false
+ + +### Tenant.spec.containerRegistries + + + +Specifies the trusted Image Registries assigned to the Tenant. Capsule assures that all Pods resources created in the Tenant can use only one of the allowed trusted registries. Optional. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowed[]string +
+ 		false
allowedRegexstring +
+ 		false
+ + +### Tenant.spec.ingressOptions + + + +Specifies options for the Ingress resources, such as allowed hostnames and IngressClass. Optional. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowWildcardHostnamesboolean + Toggles the ability for Ingress resources created in a Tenant to have a hostname wildcard.
+ 		true
allowedClassesobject + Specifies the allowed IngressClasses assigned to the Tenant. Capsule assures that all Ingress resources created in the Tenant can use only one of the allowed IngressClasses. Optional.
+ 		false
allowedHostnamesobject + Specifies the allowed hostnames in Ingresses for the given Tenant. Capsule assures that all Ingress resources created in the Tenant can use only one of the allowed hostnames. Optional.
+ 		false
hostnameCollisionScopeenum + Defines the scope of hostname collision check performed when Tenant Owners create Ingress with allowed hostnames. + - Cluster: disallow the creation of an Ingress if the pair hostname and path is already used across the Namespaces managed by Capsule. + - Tenant: disallow the creation of an Ingress if the pair hostname and path is already used across the Namespaces of the Tenant. + - Namespace: disallow the creation of an Ingress if the pair hostname and path is already used in the Ingress Namespace. + Optional.
+
+ Enum: Cluster, Tenant, Namespace, Disabled
+ Default: Disabled
+ 		false
+ + +### Tenant.spec.ingressOptions.allowedClasses + + + +Specifies the allowed IngressClasses assigned to the Tenant. Capsule assures that all Ingress resources created in the Tenant can use only one of the allowed IngressClasses. Optional. + + + + + + + + + + + + + + + @@ -2368,11 +2810,247 @@ Specifies the resource min/max usage restrictions to the Tenant. The assigned va
NameTypeDescriptionRequired
allowed[]string +
+ 		false
allowedRegex string
-### Tenant.spec.limitRanges.items[index] +### Tenant.spec.limitRanges.items[index] + + + +LimitRangeSpec defines a min/max usage limit for resources that match on kind. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limits[]object + Limits is the list of LimitRangeItem objects that are enforced.
+ 		true
+ + +### Tenant.spec.limitRanges.items[index].limits[index] + + + +LimitRangeItem defines a min/max usage limit for any resource that matches on kind. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + Type of resource that this limit applies to.
+ 		true
defaultmap[string]int or string + Default resource requirement limit value by resource name if resource limit is omitted.
+ 		false
defaultRequestmap[string]int or string + DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
+ 		false
maxmap[string]int or string + Max usage constraints on this kind by resource name.
+ 		false
maxLimitRequestRatiomap[string]int or string + MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
+ 		false
minmap[string]int or string + Min usage constraints on this kind by resource name.
+ 		false
+ + +### Tenant.spec.namespaceOptions + + + +Specifies options for the Namespaces, such as additional metadata or maximum number of namespaces allowed for that Tenant. Once the namespace quota assigned to the Tenant has been reached, the Tenant owner cannot create further namespaces. Optional. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
forbiddenAnnotationsobject + Define the annotations that a Tenant Owner cannot set for their Namespace resources.
+ 		true
forbiddenLabelsobject + Define the labels that a Tenant Owner cannot set for their Namespace resources.
+ 		true
additionalMetadataobject + Specifies additional labels and annotations the Capsule operator places on any Namespace resource in the Tenant. Optional.
+ 		false
quotainteger + Specifies the maximum number of namespaces allowed for that Tenant. Once the namespace quota assigned to the Tenant has been reached, the Tenant owner cannot create further namespaces. Optional.
+
+ Format: int32
+ Minimum: 1
+ 		false
+ + +### Tenant.spec.namespaceOptions.forbiddenAnnotations + + + +Define the annotations that a Tenant Owner cannot set for their Namespace resources. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
denied[]string +
+ 		false
deniedRegexstring +
+ 		false
+ + +### Tenant.spec.namespaceOptions.forbiddenLabels + + + +Define the labels that a Tenant Owner cannot set for their Namespace resources. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
denied[]string +
+ 		false
deniedRegexstring +
+ 		false
+ + +### Tenant.spec.namespaceOptions.additionalMetadata + + + +Specifies additional labels and annotations the Capsule operator places on any Namespace resource in the Tenant. Optional. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
labelsmap[string]string +
+ 		false
+ + +### Tenant.spec.networkPolicies -LimitRangeSpec defines a min/max usage limit for resources that match on kind. +Specifies the NetworkPolicies assigned to the Tenant. The assigned NetworkPolicies are inherited by any namespace created in the Tenant. Optional. @@ -2384,21 +3062,21 @@ LimitRangeSpec defines a min/max usage limit for resources that match on kind. - + - +
limitsitems []object - Limits is the list of LimitRangeItem objects that are enforced.
+
truefalse
-### Tenant.spec.limitRanges.items[index].limits[index] +### Tenant.spec.networkPolicies.items[index] -LimitRangeItem defines a min/max usage limit for any resource that matches on kind. +NetworkPolicySpec provides the specification of a NetworkPolicy @@ -2410,56 +3088,42 @@ LimitRangeItem defines a min/max usage limit for any resource that matches on ki - - + + - - - - - - - - - - - - + + - - + + - - + +
typestringpodSelectorobject - Type of resource that this limit applies to.
+ Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
 true
defaultmap[string]int or string - Default resource requirement limit value by resource name if resource limit is omitted.
- 		false
defaultRequestmap[string]int or string - DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
- 		false
maxmap[string]int or stringegress[]object - Max usage constraints on this kind by resource name.
+ List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
 false
maxLimitRequestRatiomap[string]int or stringingress[]object - MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
+ List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)
 false
minmap[string]int or stringpolicyTypes[]string - Min usage constraints on this kind by resource name.
+ List of rule types that the NetworkPolicy relates to. Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
 false
-### Tenant.spec.namespaceOptions +### Tenant.spec.networkPolicies.items[index].podSelector -Specifies options for the Namespaces, such as additional metadata or maximum number of namespaces allowed for that Tenant. Once the namespace quota assigned to the Tenant has been reached, the Tenant owner cannot create further namespaces. Optional. +Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. @@ -2471,45 +3135,28 @@ Specifies options for the Namespaces, such as additional metadata or maximum num - - - - - - - - - - - - + + - - + +
forbiddenAnnotationsobject - Define the annotations that a Tenant Owner cannot set for their Namespace resources.
- 		true
forbiddenLabelsobject - Define the labels that a Tenant Owner cannot set for their Namespace resources.
- 		true
additionalMetadataobjectmatchExpressions[]object - Specifies additional labels and annotations the Capsule operator places on any Namespace resource in the Tenant. Optional.
+ matchExpressions is a list of label selector requirements. The requirements are ANDed.
 false
quotaintegermatchLabelsmap[string]string - Specifies the maximum number of namespaces allowed for that Tenant. Once the namespace quota assigned to the Tenant has been reached, the Tenant owner cannot create further namespaces. Optional.
-
- Format: int32
- Minimum: 1
+ matchLabels 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
-### Tenant.spec.namespaceOptions.forbiddenAnnotations +### Tenant.spec.networkPolicies.items[index].podSelector.matchExpressions[index] -Define the annotations that a Tenant Owner cannot set for their Namespace resources. +A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. @@ -2521,28 +3168,35 @@ Define the annotations that a Tenant Owner cannot set for their Namespace resour - - + + - + - + + + + + +
denied[]stringkeystring -
+ key is the label key that the selector applies to.
falsetrue
deniedRegexoperator string -
+ operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ 		true
values[]string + values 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
-### Tenant.spec.namespaceOptions.forbiddenLabels +### Tenant.spec.networkPolicies.items[index].egress[index] -Define the labels that a Tenant Owner cannot set for their Namespace resources. +NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8 @@ -2554,28 +3208,28 @@ Define the labels that a Tenant Owner cannot set for their Namespace resources. - - + + - - + +
denied[]stringports[]object -
+ List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
 false
deniedRegexstringto[]object -
+ List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
 false
-### Tenant.spec.namespaceOptions.additionalMetadata +### Tenant.spec.networkPolicies.items[index].egress[index].ports[index] -Specifies additional labels and annotations the Capsule operator places on any Namespace resource in the Tenant. Optional. +NetworkPolicyPort describes a port to allow traffic on @@ -2587,28 +3241,39 @@ Specifies additional labels and annotations the Capsule operator places on any N - - + + - - + + + + + + +
annotationsmap[string]stringendPortinteger + If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Beta state and is enabled by default. It can be disabled using the Feature Gate "NetworkPolicyEndPort".

+ Format: int32
 false
labelsmap[string]stringportint or string + The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
+ 		false
protocolstring + The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.

+ Default: TCP
 false
-### Tenant.spec.networkPolicies +### Tenant.spec.networkPolicies.items[index].egress[index].to[index] -Specifies the NetworkPolicies assigned to the Tenant. The assigned NetworkPolicies are inherited by any namespace created in the Tenant. Optional. +NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed @@ -2620,21 +3285,37 @@ Specifies the NetworkPolicies assigned to the Tenant. The assigned NetworkPolici - - + + + + + + + + + + + +
items[]objectipBlockobject -
+ IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
+ 		false
namespaceSelectorobject + Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. + If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
+ 		false
podSelectorobject + This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. + If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
 false
-### Tenant.spec.networkPolicies.items[index] +### Tenant.spec.networkPolicies.items[index].egress[index].to[index].ipBlock -NetworkPolicySpec provides the specification of a NetworkPolicy +IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. @@ -2646,42 +3327,29 @@ NetworkPolicySpec provides the specification of a NetworkPolicy - - + + - - - - - - - - - - - +
podSelectorobjectcidrstring - Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
+ CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"
 true
egress[]object - List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
- 		false
ingress[]object - List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)
- 		false
policyTypesexcept []string - List of rule types that the NetworkPolicy relates to. Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
+ Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range
 false
-### Tenant.spec.networkPolicies.items[index].podSelector +### Tenant.spec.networkPolicies.items[index].egress[index].to[index].namespaceSelector -Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. +Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. + If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. @@ -2693,7 +3361,7 @@ Selects the pods to which this NetworkPolicy object applies. The array of ingres - +
matchExpressionsmatchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
@@ -2710,7 +3378,7 @@ Selects the pods to which this NetworkPolicy object applies. The array of ingres
-### Tenant.spec.networkPolicies.items[index].podSelector.matchExpressions[index] +### Tenant.spec.networkPolicies.items[index].egress[index].to[index].namespaceSelector.matchExpressions[index] @@ -2750,11 +3418,12 @@ A label selector requirement is a selector that contains values, a key, and an o -### Tenant.spec.networkPolicies.items[index].egress[index] +### Tenant.spec.networkPolicies.items[index].egress[index].to[index].podSelector -NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8 +This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. + If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. @@ -2766,28 +3435,68 @@ NetworkPolicyEgressRule describes a particular set of traffic that is allowed ou - + + + + + + + + +
portsmatchExpressions []object - List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
+ matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[string]string + matchLabels 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
+ + +### Tenant.spec.networkPolicies.items[index].egress[index].to[index].podSelector.matchExpressions[index] + + + +A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + + + + + + + + + + + + + + + + + + + - + - - + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
falsetrue
to[]objectvalues[]string - List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
+ values 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
-### Tenant.spec.networkPolicies.items[index].egress[index].ports[index] +### Tenant.spec.networkPolicies.items[index].ingress[index] -NetworkPolicyPort describes a port to allow traffic on +NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from. @@ -2799,35 +3508,24 @@ NetworkPolicyPort describes a port to allow traffic on - - - - - - - + + - - + +
endPortinteger - If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Beta state and is enabled by default. It can be disabled using the Feature Gate "NetworkPolicyEndPort".
-
- Format: int32
- 		false
portint or stringfrom[]object - The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
+ List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.
 false
protocolstringports[]object - The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
-
- Default: TCP
+ List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
 false
-### Tenant.spec.networkPolicies.items[index].egress[index].to[index] +### Tenant.spec.networkPolicies.items[index].ingress[index].from[index] @@ -2843,14 +3541,14 @@ NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combin - ipBlock + ipBlock object IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
false - namespaceSelector + namespaceSelector object Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. @@ -2858,7 +3556,7 @@ NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combin false - podSelector + podSelector object This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. @@ -2869,7 +3567,7 @@ NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combin -### Tenant.spec.networkPolicies.items[index].egress[index].to[index].ipBlock +### Tenant.spec.networkPolicies.items[index].ingress[index].from[index].ipBlock @@ -2902,7 +3600,7 @@ IPBlock defines policy on a particular IPBlock. If this field is set then neithe -### Tenant.spec.networkPolicies.items[index].egress[index].to[index].namespaceSelector +### Tenant.spec.networkPolicies.items[index].ingress[index].from[index].namespaceSelector @@ -2919,7 +3617,7 @@ Selects Namespaces using cluster-scoped labels. This field follows standard labe - matchExpressions + matchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
@@ -2936,7 +3634,7 @@ Selects Namespaces using cluster-scoped labels. This field follows standard labe -### Tenant.spec.networkPolicies.items[index].egress[index].to[index].namespaceSelector.matchExpressions[index] +### Tenant.spec.networkPolicies.items[index].ingress[index].from[index].namespaceSelector.matchExpressions[index] @@ -2976,7 +3674,7 @@ A label selector requirement is a selector that contains values, a key, and an o -### Tenant.spec.networkPolicies.items[index].egress[index].to[index].podSelector +### Tenant.spec.networkPolicies.items[index].ingress[index].from[index].podSelector @@ -2993,7 +3691,7 @@ This is a label selector which selects Pods. This field follows standard label s - matchExpressions + matchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
@@ -3010,7 +3708,7 @@ This is a label selector which selects Pods. This field follows standard label s -### Tenant.spec.networkPolicies.items[index].egress[index].to[index].podSelector.matchExpressions[index] +### Tenant.spec.networkPolicies.items[index].ingress[index].from[index].podSelector.matchExpressions[index] @@ -3050,11 +3748,11 @@ A label selector requirement is a selector that contains values, a key, and an o -### Tenant.spec.networkPolicies.items[index].ingress[index] +### Tenant.spec.networkPolicies.items[index].ingress[index].ports[index] -NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from. +NetworkPolicyPort describes a port to allow traffic on @@ -3066,28 +3764,39 @@ NetworkPolicyIngressRule describes a particular set of traffic that is allowed t - - + + - - + + + + + + +
from[]objectendPortinteger - List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.
+ If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Beta state and is enabled by default. It can be disabled using the Feature Gate "NetworkPolicyEndPort".
+
+ Format: int32
 false
ports[]objectportint or string - List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
+ The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
+ 		false
protocolstring + The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
+
+ Default: TCP
 false
-### Tenant.spec.networkPolicies.items[index].ingress[index].from[index] +### Tenant.spec.priorityClasses -NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed +Specifies the allowed priorityClasses assigned to the Tenant. Capsule assures that all Pods resources created in the Tenant can use only one of the allowed PriorityClasses. Optional. @@ -3099,37 +3808,28 @@ NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combin - - - - - - - + + - - + +
ipBlockobject - IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
- 		false
namespaceSelectorobjectallowed[]string - Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. - If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
+
false
podSelectorobjectallowedRegexstring - This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. - If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
+
false
-### Tenant.spec.networkPolicies.items[index].ingress[index].from[index].ipBlock +### Tenant.spec.replicatedResources[index] -IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. +TenantResourceSpec defines the desired state of TenantResource @@ -3141,29 +3841,30 @@ IPBlock defines policy on a particular IPBlock. If this field is set then neithe - - + + - - + + - +
cidrstringresources[]object - CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"
+
true
except[]stringresyncPeriodstring - Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range
+
+
+ Default: 60s
falsetrue
-### Tenant.spec.networkPolicies.items[index].ingress[index].from[index].namespaceSelector +### Tenant.spec.replicatedResources[index].resources[index] + -Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. - If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. @@ -3175,28 +3876,42 @@ Selects Namespaces using cluster-scoped labels. This field follows standard labe - + + + + + + + + + + + - - + +
matchExpressionsadditionalMetadataobject + Besides the Capsule metadata required by TenantResource controller, defines additional metadata that must be added to the replicated resources.
+ 		false
namespaceSelectorobject + Defines the Namespace selector to select the Tenant Samespaces on which the resources must be propagated. In case of nil value, all the Tenant Namespaces are targeted.
+ 		false
namespacedItems []object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ List of the resources already existing in other Namespaces that must be replicated.
 false
matchLabelsmap[string]stringrawItems[]RawExtension - matchLabels 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.
+ List of raw resources that must be replicated.
 false
-### Tenant.spec.networkPolicies.items[index].ingress[index].from[index].namespaceSelector.matchExpressions[index] +### Tenant.spec.replicatedResources[index].resources[index].additionalMetadata -A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +Besides the Capsule metadata required by TenantResource controller, defines additional metadata that must be added to the replicated resources. @@ -3208,36 +3923,28 @@ A label selector requirement is a selector that contains values, a key, and an o - - - - - - - + + - + - - + +
keystring - key is the label key that the selector applies to.
- 		true
operatorstringannotationsmap[string]string - operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+
truefalse
values[]stringlabelsmap[string]string - values 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
-### Tenant.spec.networkPolicies.items[index].ingress[index].from[index].podSelector +### Tenant.spec.replicatedResources[index].resources[index].namespaceSelector -This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. - If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. +Defines the Namespace selector to select the Tenant Samespaces on which the resources must be propagated. In case of nil value, all the Tenant Namespaces are targeted. @@ -3249,7 +3956,7 @@ This is a label selector which selects Pods. This field follows standard label s - +
matchExpressionsmatchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
@@ -3266,7 +3973,7 @@ This is a label selector which selects Pods. This field follows standard label s
-### Tenant.spec.networkPolicies.items[index].ingress[index].from[index].podSelector.matchExpressions[index] +### Tenant.spec.replicatedResources[index].resources[index].namespaceSelector.matchExpressions[index] @@ -3306,11 +4013,11 @@ A label selector requirement is a selector that contains values, a key, and an o -### Tenant.spec.networkPolicies.items[index].ingress[index].ports[index] +### Tenant.spec.replicatedResources[index].resources[index].namespacedItems[index] + -NetworkPolicyPort describes a port to allow traffic on @@ -3322,39 +4029,42 @@ NetworkPolicyPort describes a port to allow traffic on - - + + - + - - + + - + - + + + + + +
endPortintegerkindstring - If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Beta state and is enabled by default. It can be disabled using the Feature Gate "NetworkPolicyEndPort".
-
- Format: int32
+ Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
falsetrue
portint or stringnamespacestring - The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
+ Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
falsetrue
protocolselectorobject + Label selector used to select the given resources in the given Namespace.
+ 		true
apiVersion string - The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
-
- Default: TCP
+ API version of the referent.
 false
-### Tenant.spec.priorityClasses +### Tenant.spec.replicatedResources[index].resources[index].namespacedItems[index].selector -Specifies the allowed priorityClasses assigned to the Tenant. Capsule assures that all Pods resources created in the Tenant can use only one of the allowed PriorityClasses. Optional. +Label selector used to select the given resources in the given Namespace. @@ -3366,17 +4076,57 @@ Specifies the allowed priorityClasses assigned to the Tenant. Capsule assures th - - + + - + + + + + +
allowed[]stringmatchExpressions[]object -
+ matchExpressions is a list of label selector requirements. The requirements are ANDed.
 false
allowedRegexmatchLabelsmap[string]string + matchLabels 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
+ + +### Tenant.spec.replicatedResources[index].resources[index].namespacedItems[index].selector.matchExpressions[index] + + + +A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/content/general/references.md b/docs/content/general/references.md index bc91c311a..8b959c7c1 100644 --- a/docs/content/general/references.md +++ b/docs/content/general/references.md @@ -6,7 +6,7 @@ Reference document for Capsule Operator configuration Capsule operator uses a Custom Resources Definition (CRD) for _Tenants_. Tenants are cluster wide resources, so you need cluster level permissions to work with tenants. -You can learn about tenant CRDs in the following [section](./tenant-crd) +You can learn about tenant CRDs in the following [section](./crds-apis) ## Capsule Configuration diff --git a/docs/gridsome.server.js b/docs/gridsome.server.js index f85a76491..a4d02b807 100644 --- a/docs/gridsome.server.js +++ b/docs/gridsome.server.js @@ -39,7 +39,7 @@ module.exports = function (api) { }, { label: 'CRDs APIs', - path: '/docs/general/tenant-crd' + path: '/docs/general/crds-apis' }, { label: 'Multi-Tenant Benchmark',
NameTypeDescriptionRequired
key string -
+ key is the label key that the selector applies to.
+ 		true
operatorstring + operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ 		true
values[]string + values 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