mirror of
https://github.com/tailscale/tailscale.git
synced 2024-11-26 19:45:35 +00:00
231e44e742
Temporarily reverting this PR to avoid releasing
half finished featue.
This reverts commit 9e2f58f846.
Signed-off-by: Irbe Krumina <irbe@tailscale.com>
1645 lines
64 KiB
Markdown
1645 lines
64 KiB
Markdown
# API Reference
|
|
|
|
Packages:
|
|
|
|
- [tailscale.com/v1alpha1](#tailscalecomv1alpha1)
|
|
|
|
# tailscale.com/v1alpha1
|
|
|
|
Resource Types:
|
|
|
|
- [Connector](#connector)
|
|
|
|
- [ProxyClass](#proxyclass)
|
|
|
|
|
|
|
|
|
|
## Connector
|
|
<sup><sup>[↩ Parent](#tailscalecomv1alpha1 )</sup></sup>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>apiVersion</b></td>
|
|
<td>string</td>
|
|
<td>tailscale.com/v1alpha1</td>
|
|
<td>true</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>kind</b></td>
|
|
<td>string</td>
|
|
<td>Connector</td>
|
|
<td>true</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta">metadata</a></b></td>
|
|
<td>object</td>
|
|
<td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b><a href="#connectorspec">spec</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
ConnectorSpec describes the desired Tailscale component.<br/>
|
|
<br/>
|
|
<i>Validations</i>:<li>has(self.subnetRouter) || self.exitNode == true: A Connector needs to be either an exit node or a subnet router, or both.</li>
|
|
</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b><a href="#connectorstatus">status</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
ConnectorStatus describes the status of the Connector. This is set and managed by the Tailscale operator.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### Connector.spec
|
|
<sup><sup>[↩ Parent](#connector)</sup></sup>
|
|
|
|
|
|
|
|
ConnectorSpec describes the desired Tailscale component.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>exitNode</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
ExitNode defines whether the Connector node should act as a Tailscale exit node. Defaults to false. https://tailscale.com/kb/1103/exit-nodes<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>hostname</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Hostname is the tailnet hostname that should be assigned to the Connector node. If unset, hostname defaults to <connector name>-connector. Hostname can contain lower case letters, numbers and dashes, it must not start or end with a dash and must be between 2 and 63 characters long.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>proxyClass</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
ProxyClass is the name of the ProxyClass custom resource that contains configuration options that should be applied to the resources created for this Connector. If unset, the operator will create resources with the default configuration.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#connectorspecsubnetrouter">subnetRouter</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
SubnetRouter defines subnet routes that the Connector node should expose to tailnet. If unset, none are exposed. https://tailscale.com/kb/1019/subnets/<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>tags</b></td>
|
|
<td>[]string</td>
|
|
<td>
|
|
Tags that the Tailscale node will be tagged with. Defaults to [tag:k8s]. To autoapprove the subnet routes or exit node defined by a Connector, you can configure Tailscale ACLs to give these tags the necessary permissions. See https://tailscale.com/kb/1018/acls/#auto-approvers-for-routes-and-exit-nodes. If you specify custom tags here, you must also make the operator an owner of these tags. See https://tailscale.com/kb/1236/kubernetes-operator/#setting-up-the-kubernetes-operator. Tags cannot be changed once a Connector node has been created. Tag values must be in form ^tag:[a-zA-Z][a-zA-Z0-9-]*$.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### Connector.spec.subnetRouter
|
|
<sup><sup>[↩ Parent](#connectorspec)</sup></sup>
|
|
|
|
|
|
|
|
SubnetRouter defines subnet routes that the Connector node should expose to tailnet. If unset, none are exposed. https://tailscale.com/kb/1019/subnets/
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>advertiseRoutes</b></td>
|
|
<td>[]string</td>
|
|
<td>
|
|
AdvertiseRoutes refer to CIDRs that the subnet router should make available. Route values must be strings that represent a valid IPv4 or IPv6 CIDR range. Values can be Tailscale 4via6 subnet routes. https://tailscale.com/kb/1201/4via6-subnets/<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### Connector.status
|
|
<sup><sup>[↩ Parent](#connector)</sup></sup>
|
|
|
|
|
|
|
|
ConnectorStatus describes the status of the Connector. This is set and managed by the Tailscale operator.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b><a href="#connectorstatusconditionsindex">conditions</a></b></td>
|
|
<td>[]object</td>
|
|
<td>
|
|
List of status conditions to indicate the status of the Connector. Known condition types are `ConnectorReady`.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>isExitNode</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
IsExitNode is set to true if the Connector acts as an exit node.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>subnetRoutes</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
SubnetRoutes are the routes currently exposed to tailnet via this Connector instance.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### Connector.status.conditions[index]
|
|
<sup><sup>[↩ Parent](#connectorstatus)</sup></sup>
|
|
|
|
|
|
|
|
ConnectorCondition contains condition information for a Connector.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>status</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Status of the condition, one of ('True', 'False', 'Unknown').<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b>type</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Type of the condition, known values are (`SubnetRouterReady`).<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b>lastTransitionTime</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
LastTransitionTime is the timestamp corresponding to the last status change of this condition.<br/>
|
|
<br/>
|
|
<i>Format</i>: date-time<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>message</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Message is a human readable description of the details of the last transition, complementing reason.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>observedGeneration</b></td>
|
|
<td>integer</td>
|
|
<td>
|
|
If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Connector.<br/>
|
|
<br/>
|
|
<i>Format</i>: int64<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>reason</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Reason is a brief machine readable explanation for the condition's last transition.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
## ProxyClass
|
|
<sup><sup>[↩ Parent](#tailscalecomv1alpha1 )</sup></sup>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>apiVersion</b></td>
|
|
<td>string</td>
|
|
<td>tailscale.com/v1alpha1</td>
|
|
<td>true</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>kind</b></td>
|
|
<td>string</td>
|
|
<td>ProxyClass</td>
|
|
<td>true</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta">metadata</a></b></td>
|
|
<td>object</td>
|
|
<td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspec">spec</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassstatus">status</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec
|
|
<sup><sup>[↩ Parent](#proxyclass)</sup></sup>
|
|
|
|
|
|
|
|
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b><a href="#proxyclassspecstatefulset">statefulSet</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
Proxy's StatefulSet spec.<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet
|
|
<sup><sup>[↩ Parent](#proxyclassspec)</sup></sup>
|
|
|
|
|
|
|
|
Proxy's StatefulSet spec.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>annotations</b></td>
|
|
<td>map[string]string</td>
|
|
<td>
|
|
Annotations that will be added to the StatefulSet created for the proxy. Any Annotations specified here will be merged with the default annotations applied to the StatefulSet by the Tailscale Kubernetes operator as well as any other annotations that might have been applied by other actors. Annotations must be valid Kubernetes annotations. https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>labels</b></td>
|
|
<td>map[string]string</td>
|
|
<td>
|
|
Labels that will be added to the StatefulSet created for the proxy. Any labels specified here will be merged with the default labels applied to the StatefulSet by the Tailscale Kubernetes operator as well as any other labels that might have been applied by other actors. Label keys and values must be valid Kubernetes label keys and values. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpod">pod</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
Configuration for the proxy Pod.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulset)</sup></sup>
|
|
|
|
|
|
|
|
Configuration for the proxy Pod.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>annotations</b></td>
|
|
<td>map[string]string</td>
|
|
<td>
|
|
Annotations that will be added to the proxy Pod. Any annotations specified here will be merged with the default annotations applied to the Pod by the Tailscale Kubernetes operator. Annotations must be valid Kubernetes annotations. https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodimagepullsecretsindex">imagePullSecrets</a></b></td>
|
|
<td>[]object</td>
|
|
<td>
|
|
Proxy Pod's image pull Secrets. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodSpec<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>labels</b></td>
|
|
<td>map[string]string</td>
|
|
<td>
|
|
Labels that will be added to the proxy Pod. Any labels specified here will be merged with the default labels applied to the Pod by the Tailscale Kubernetes operator. Label keys and values must be valid Kubernetes label keys and values. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>nodeName</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Proxy Pod's node name. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>nodeSelector</b></td>
|
|
<td>map[string]string</td>
|
|
<td>
|
|
Proxy Pod's node selector. By default Tailscale Kubernetes operator does not apply any node selector. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodsecuritycontext">securityContext</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
Proxy Pod's security context. By default Tailscale Kubernetes operator does not apply any Pod security context. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-2<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscalecontainer">tailscaleContainer</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
Configuration for the proxy container running tailscale.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscaleinitcontainer">tailscaleInitContainer</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
Configuration for the proxy init container that enables forwarding.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtolerationsindex">tolerations</a></b></td>
|
|
<td>[]object</td>
|
|
<td>
|
|
Proxy Pod's tolerations. By default Tailscale Kubernetes operator does not apply any tolerations. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.imagePullSecrets[index]
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpod)</sup></sup>
|
|
|
|
|
|
|
|
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>name</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.securityContext
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpod)</sup></sup>
|
|
|
|
|
|
|
|
Proxy Pod's security context. By default Tailscale Kubernetes operator does not apply any Pod security context. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-2
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>fsGroup</b></td>
|
|
<td>integer</td>
|
|
<td>
|
|
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
|
|
1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----
|
|
If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
<br/>
|
|
<i>Format</i>: int64<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>fsGroupChangePolicy</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsGroup</b></td>
|
|
<td>integer</td>
|
|
<td>
|
|
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
<br/>
|
|
<i>Format</i>: int64<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsNonRoot</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsUser</b></td>
|
|
<td>integer</td>
|
|
<td>
|
|
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
<br/>
|
|
<i>Format</i>: int64<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodsecuritycontextselinuxoptions">seLinuxOptions</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodsecuritycontextseccompprofile">seccompProfile</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>supplementalGroups</b></td>
|
|
<td>[]integer</td>
|
|
<td>
|
|
A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodsecuritycontextsysctlsindex">sysctls</a></b></td>
|
|
<td>[]object</td>
|
|
<td>
|
|
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodsecuritycontextwindowsoptions">windowsOptions</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.securityContext.seLinuxOptions
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodsecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>level</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Level is SELinux level label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>role</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Role is a SELinux role label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>type</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Type is a SELinux type label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>user</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
User is a SELinux user label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.securityContext.seccompProfile
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodsecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>type</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
type indicates which kind of seccomp profile will be applied. Valid options are:
|
|
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b>localhostProfile</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.securityContext.sysctls[index]
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodsecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
Sysctl defines a kernel parameter to be set
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>name</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Name of a property to set<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b>value</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Value of a property to set<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.securityContext.windowsOptions
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodsecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>gmsaCredentialSpec</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>gmsaCredentialSpecName</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
GMSACredentialSpecName is the name of the GMSA credential spec to use.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>hostProcess</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsUserName</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleContainer
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpod)</sup></sup>
|
|
|
|
|
|
|
|
Configuration for the proxy container running tailscale.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscalecontainerresources">resources</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
Container resource requirements. By default Tailscale Kubernetes operator does not apply any resource requirements. The amount of resources required wil depend on the amount of resources the operator needs to parse, usage patterns and cluster size. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscalecontainersecuritycontext">securityContext</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
Container security context. Security context specified here will override the security context by the operator. By default the operator: - sets 'privileged: true' for the init container - set NET_ADMIN capability for tailscale container for proxies that are created for Services or Connector. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleContainer.resources
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscalecontainer)</sup></sup>
|
|
|
|
|
|
|
|
Container resource requirements. By default Tailscale Kubernetes operator does not apply any resource requirements. The amount of resources required wil depend on the amount of resources the operator needs to parse, usage patterns and cluster size. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscalecontainerresourcesclaimsindex">claims</a></b></td>
|
|
<td>[]object</td>
|
|
<td>
|
|
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
|
|
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
|
|
This field is immutable. It can only be set for containers.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>limits</b></td>
|
|
<td>map[string]int or string</td>
|
|
<td>
|
|
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>requests</b></td>
|
|
<td>map[string]int or string</td>
|
|
<td>
|
|
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleContainer.resources.claims[index]
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscalecontainerresources)</sup></sup>
|
|
|
|
|
|
|
|
ResourceClaim references one entry in PodSpec.ResourceClaims.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>name</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleContainer.securityContext
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscalecontainer)</sup></sup>
|
|
|
|
|
|
|
|
Container security context. Security context specified here will override the security context by the operator. By default the operator: - sets 'privileged: true' for the init container - set NET_ADMIN capability for tailscale container for proxies that are created for Services or Connector. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>allowPrivilegeEscalation</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscalecontainersecuritycontextcapabilities">capabilities</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>privileged</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>procMount</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>readOnlyRootFilesystem</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsGroup</b></td>
|
|
<td>integer</td>
|
|
<td>
|
|
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
<br/>
|
|
<i>Format</i>: int64<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsNonRoot</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsUser</b></td>
|
|
<td>integer</td>
|
|
<td>
|
|
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
<br/>
|
|
<i>Format</i>: int64<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscalecontainersecuritycontextselinuxoptions">seLinuxOptions</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscalecontainersecuritycontextseccompprofile">seccompProfile</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscalecontainersecuritycontextwindowsoptions">windowsOptions</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleContainer.securityContext.capabilities
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscalecontainersecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>add</b></td>
|
|
<td>[]string</td>
|
|
<td>
|
|
Added capabilities<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>drop</b></td>
|
|
<td>[]string</td>
|
|
<td>
|
|
Removed capabilities<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleContainer.securityContext.seLinuxOptions
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscalecontainersecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>level</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Level is SELinux level label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>role</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Role is a SELinux role label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>type</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Type is a SELinux type label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>user</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
User is a SELinux user label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleContainer.securityContext.seccompProfile
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscalecontainersecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>type</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
type indicates which kind of seccomp profile will be applied. Valid options are:
|
|
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b>localhostProfile</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleContainer.securityContext.windowsOptions
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscalecontainersecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>gmsaCredentialSpec</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>gmsaCredentialSpecName</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
GMSACredentialSpecName is the name of the GMSA credential spec to use.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>hostProcess</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsUserName</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleInitContainer
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpod)</sup></sup>
|
|
|
|
|
|
|
|
Configuration for the proxy init container that enables forwarding.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscaleinitcontainerresources">resources</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
Container resource requirements. By default Tailscale Kubernetes operator does not apply any resource requirements. The amount of resources required wil depend on the amount of resources the operator needs to parse, usage patterns and cluster size. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscaleinitcontainersecuritycontext">securityContext</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
Container security context. Security context specified here will override the security context by the operator. By default the operator: - sets 'privileged: true' for the init container - set NET_ADMIN capability for tailscale container for proxies that are created for Services or Connector. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleInitContainer.resources
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscaleinitcontainer)</sup></sup>
|
|
|
|
|
|
|
|
Container resource requirements. By default Tailscale Kubernetes operator does not apply any resource requirements. The amount of resources required wil depend on the amount of resources the operator needs to parse, usage patterns and cluster size. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscaleinitcontainerresourcesclaimsindex">claims</a></b></td>
|
|
<td>[]object</td>
|
|
<td>
|
|
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
|
|
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
|
|
This field is immutable. It can only be set for containers.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>limits</b></td>
|
|
<td>map[string]int or string</td>
|
|
<td>
|
|
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>requests</b></td>
|
|
<td>map[string]int or string</td>
|
|
<td>
|
|
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleInitContainer.resources.claims[index]
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscaleinitcontainerresources)</sup></sup>
|
|
|
|
|
|
|
|
ResourceClaim references one entry in PodSpec.ResourceClaims.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>name</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleInitContainer.securityContext
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscaleinitcontainer)</sup></sup>
|
|
|
|
|
|
|
|
Container security context. Security context specified here will override the security context by the operator. By default the operator: - sets 'privileged: true' for the init container - set NET_ADMIN capability for tailscale container for proxies that are created for Services or Connector. https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>allowPrivilegeEscalation</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscaleinitcontainersecuritycontextcapabilities">capabilities</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>privileged</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>procMount</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>readOnlyRootFilesystem</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsGroup</b></td>
|
|
<td>integer</td>
|
|
<td>
|
|
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
<br/>
|
|
<i>Format</i>: int64<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsNonRoot</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsUser</b></td>
|
|
<td>integer</td>
|
|
<td>
|
|
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
<br/>
|
|
<i>Format</i>: int64<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscaleinitcontainersecuritycontextselinuxoptions">seLinuxOptions</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscaleinitcontainersecuritycontextseccompprofile">seccompProfile</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b><a href="#proxyclassspecstatefulsetpodtailscaleinitcontainersecuritycontextwindowsoptions">windowsOptions</a></b></td>
|
|
<td>object</td>
|
|
<td>
|
|
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleInitContainer.securityContext.capabilities
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscaleinitcontainersecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>add</b></td>
|
|
<td>[]string</td>
|
|
<td>
|
|
Added capabilities<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>drop</b></td>
|
|
<td>[]string</td>
|
|
<td>
|
|
Removed capabilities<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleInitContainer.securityContext.seLinuxOptions
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscaleinitcontainersecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>level</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Level is SELinux level label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>role</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Role is a SELinux role label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>type</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Type is a SELinux type label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>user</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
User is a SELinux user label that applies to the container.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleInitContainer.securityContext.seccompProfile
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscaleinitcontainersecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>type</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
type indicates which kind of seccomp profile will be applied. Valid options are:
|
|
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b>localhostProfile</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tailscaleInitContainer.securityContext.windowsOptions
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpodtailscaleinitcontainersecuritycontext)</sup></sup>
|
|
|
|
|
|
|
|
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>gmsaCredentialSpec</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>gmsaCredentialSpecName</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
GMSACredentialSpecName is the name of the GMSA credential spec to use.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>hostProcess</b></td>
|
|
<td>boolean</td>
|
|
<td>
|
|
HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>runAsUserName</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.spec.statefulSet.pod.tolerations[index]
|
|
<sup><sup>[↩ Parent](#proxyclassspecstatefulsetpod)</sup></sup>
|
|
|
|
|
|
|
|
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>effect</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>key</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>operator</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>tolerationSeconds</b></td>
|
|
<td>integer</td>
|
|
<td>
|
|
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.<br/>
|
|
<br/>
|
|
<i>Format</i>: int64<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>value</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.status
|
|
<sup><sup>[↩ Parent](#proxyclass)</sup></sup>
|
|
|
|
|
|
|
|
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b><a href="#proxyclassstatusconditionsindex">conditions</a></b></td>
|
|
<td>[]object</td>
|
|
<td>
|
|
List of status conditions to indicate the status of the ProxyClass. Known condition types are `ProxyClassReady`.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|
|
|
|
|
|
### ProxyClass.status.conditions[index]
|
|
<sup><sup>[↩ Parent](#proxyclassstatus)</sup></sup>
|
|
|
|
|
|
|
|
ConnectorCondition contains condition information for a Connector.
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Required</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr>
|
|
<td><b>status</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Status of the condition, one of ('True', 'False', 'Unknown').<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b>type</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Type of the condition, known values are (`SubnetRouterReady`).<br/>
|
|
</td>
|
|
<td>true</td>
|
|
</tr><tr>
|
|
<td><b>lastTransitionTime</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
LastTransitionTime is the timestamp corresponding to the last status change of this condition.<br/>
|
|
<br/>
|
|
<i>Format</i>: date-time<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>message</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Message is a human readable description of the details of the last transition, complementing reason.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>observedGeneration</b></td>
|
|
<td>integer</td>
|
|
<td>
|
|
If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Connector.<br/>
|
|
<br/>
|
|
<i>Format</i>: int64<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr><tr>
|
|
<td><b>reason</b></td>
|
|
<td>string</td>
|
|
<td>
|
|
Reason is a brief machine readable explanation for the condition's last transition.<br/>
|
|
</td>
|
|
<td>false</td>
|
|
</tr></tbody>
|
|
</table>
|