diff --git a/docs/content/general/crds-apis.md b/docs/content/general/crds-apis.md index 93f5187c..184a38bd 100644 --- a/docs/content/general/crds-apis.md +++ b/docs/content/general/crds-apis.md @@ -19,1567 +19,9 @@ Packages: -- [capsule.clastix.io/v1alpha1](#capsuleclastixiov1alpha1) - [capsule.clastix.io/v1beta2](#capsuleclastixiov1beta2) - [capsule.clastix.io/v1beta1](#capsuleclastixiov1beta1) -# capsule.clastix.io/v1alpha1 - -Resource Types: - -- [CapsuleConfiguration](#capsuleconfiguration) - -- [Tenant](#tenant) - - - - -## CapsuleConfiguration - - - - - - -CapsuleConfiguration is the Schema for the Capsule configuration API. - -
Name | -Type | -Description | -Required | -
---|---|---|---|
apiVersion | -string | -capsule.clastix.io/v1alpha1 | -true | -
kind | -string | -CapsuleConfiguration | -true | -
metadata | -object | -Refer to the Kubernetes API documentation for the fields of the `metadata` field. | -true | -
spec | -object | -
- CapsuleConfigurationSpec defines the Capsule configuration. - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
forceTenantPrefix | -boolean | -
- Enforces the Tenant owner, during Namespace creation, to name it using the selected Tenant name as prefix, separated by a dash. This is useful to avoid Namespace name collision in a public CaaS environment. - - Default: false - |
- false | -
protectedNamespaceRegex | -string | -
- Disallow creation of namespaces, whose name matches this regexp - |
- false | -
userGroups | -[]string | -
- Names of the groups for Capsule users. - - Default: [capsule.clastix.io] - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
apiVersion | -string | -capsule.clastix.io/v1alpha1 | -true | -
kind | -string | -Tenant | -true | -
metadata | -object | -Refer to the Kubernetes API documentation for the fields of the `metadata` field. | -true | -
spec | -object | -
- TenantSpec defines the desired state of Tenant. - |
- false | -
status | -object | -
- TenantStatus defines the observed state of Tenant. - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
owner | -object | -
- OwnerSpec defines tenant owner name and kind. - |
- true | -
additionalRoleBindings | -[]object | -
- - |
- false | -
containerRegistries | -object | -
- - |
- false | -
externalServiceIPs | -object | -
- - |
- false | -
ingressClasses | -object | -
- - |
- false | -
ingressHostnames | -object | -
- - |
- false | -
limitRanges | -[]object | -
- - |
- false | -
namespaceQuota | -integer | -
- - - Format: int32 - Minimum: 1 - |
- false | -
namespacesMetadata | -object | -
- - |
- false | -
networkPolicies | -[]object | -
- - |
- false | -
nodeSelector | -map[string]string | -
- - |
- false | -
resourceQuotas | -[]object | -
- - |
- false | -
servicesMetadata | -object | -
- - |
- false | -
storageClasses | -object | -
- - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
kind | -enum | -
- - - Enum: User, Group - |
- true | -
name | -string | -
- - |
- true | -
Name | -Type | -Description | -Required | -
---|---|---|---|
clusterRoleName | -string | -
- - |
- true | -
subjects | -[]object | -
- kubebuilder:validation:Minimum=1 - |
- true | -
Name | -Type | -Description | -Required | -
---|---|---|---|
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. - |
- true | -
name | -string | -
- Name of the object being referenced. - |
- true | -
apiGroup | -string | -
- 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 | -
namespace | -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. - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
allowed | -[]string | -
- - |
- false | -
allowedRegex | -string | -
- - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
allowed | -[]string | -
- - |
- true | -
Name | -Type | -Description | -Required | -
---|---|---|---|
allowed | -[]string | -
- - |
- false | -
allowedRegex | -string | -
- - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
allowed | -[]string | -
- - |
- false | -
allowedRegex | -string | -
- - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
limits | -[]object | -
- Limits is the list of LimitRangeItem objects that are enforced. - |
- true | -
Name | -Type | -Description | -Required | -
---|---|---|---|
type | -string | -
- Type of resource that this limit applies to. - |
- true | -
default | -map[string]int or string | -
- Default resource requirement limit value by resource name if resource limit is omitted. - |
- false | -
defaultRequest | -map[string]int or string | -
- DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. - |
- false | -
max | -map[string]int or string | -
- Max usage constraints on this kind by resource name. - |
- false | -
maxLimitRequestRatio | -map[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 | -
min | -map[string]int or string | -
- Min usage constraints on this kind by resource name. - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
additionalAnnotations | -map[string]string | -
- - |
- false | -
additionalLabels | -map[string]string | -
- - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
podSelector | -object | -
- podSelector 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 | -
egress | -[]object | -
- egress is a 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 | -
- ingress is a 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 | -
policyTypes | -[]string | -
- policyTypes is a 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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
matchExpressions | -[]object | -
- matchExpressions is a list of label selector requirements. The requirements are ANDed. - |
- false | -
matchLabels | -map[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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
key | -string | -
- key is the label key that the selector applies to. - |
- true | -
operator | -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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
ports | -[]object | -
- ports is a 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 | -
to | -[]object | -
- to is a 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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
endPort | -integer | -
- endPort indicates that the range of ports from port to endPort if set, 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. - - Format: int32 - |
- false | -
port | -int or string | -
- port represents 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 | -
protocol | -string | -
- protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP. - - Default: TCP - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
ipBlock | -object | -
- ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. - |
- false | -
namespaceSelector | -object | -
- namespaceSelector 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 | -
podSelector | -object | -
- podSelector 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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
cidr | -string | -
- cidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" - |
- true | -
except | -[]string | -
- except is a slice of CIDRs that should not be included within an IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" Except values will be rejected if they are outside the cidr range - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
matchExpressions | -[]object | -
- matchExpressions is a list of label selector requirements. The requirements are ANDed. - |
- false | -
matchLabels | -map[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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
key | -string | -
- key is the label key that the selector applies to. - |
- true | -
operator | -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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
matchExpressions | -[]object | -
- matchExpressions is a list of label selector requirements. The requirements are ANDed. - |
- false | -
matchLabels | -map[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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
key | -string | -
- key is the label key that the selector applies to. - |
- true | -
operator | -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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
from | -[]object | -
- from is a 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 | -
ports | -[]object | -
- ports is a 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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
ipBlock | -object | -
- ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. - |
- false | -
namespaceSelector | -object | -
- namespaceSelector 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 | -
podSelector | -object | -
- podSelector 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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
cidr | -string | -
- cidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" - |
- true | -
except | -[]string | -
- except is a slice of CIDRs that should not be included within an IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" Except values will be rejected if they are outside the cidr range - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
matchExpressions | -[]object | -
- matchExpressions is a list of label selector requirements. The requirements are ANDed. - |
- false | -
matchLabels | -map[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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
key | -string | -
- key is the label key that the selector applies to. - |
- true | -
operator | -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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
matchExpressions | -[]object | -
- matchExpressions is a list of label selector requirements. The requirements are ANDed. - |
- false | -
matchLabels | -map[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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
key | -string | -
- key is the label key that the selector applies to. - |
- true | -
operator | -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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
endPort | -integer | -
- endPort indicates that the range of ports from port to endPort if set, 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. - - Format: int32 - |
- false | -
port | -int or string | -
- port represents 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 | -
protocol | -string | -
- protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP. - - Default: TCP - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
hard | -map[string]int or string | -
- hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ - |
- false | -
scopeSelector | -object | -
- scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. - |
- false | -
scopes | -[]string | -
- A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
matchExpressions | -[]object | -
- A list of scope selector requirements by scope of the resources. - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
operator | -string | -
- Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. - |
- true | -
scopeName | -string | -
- The name of the scope that the selector applies to. - |
- true | -
values | -[]string | -
- 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 | -
Name | -Type | -Description | -Required | -
---|---|---|---|
additionalAnnotations | -map[string]string | -
- - |
- false | -
additionalLabels | -map[string]string | -
- - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
allowed | -[]string | -
- - |
- false | -
allowedRegex | -string | -
- - |
- false | -
Name | -Type | -Description | -Required | -
---|---|---|---|
size | -integer | -
- - |
- true | -
namespaces | -[]string | -
- - |
- false | -