TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2024-11-25 19:15:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

cmd/k8s-operator, k8s-operator: fix outdated kb links (#13585)

Browse Source 
updates #13583

Signed-off-by: Cameron Stokes <cameron@tailscale.com>
This commit is contained in:
Cameron Stokes 2024-09-25 14:15:42 -07:00 committed by GitHub
parent 2fdbcbdf86
commit 65c26357b1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cmd/k8s-operator/deploy/chart/values.yaml
View File

@ -57,12 +57,12 @@ operatorConfig:
# proxyConfig contains configuraton that will be applied to any ingress/egress # proxyConfig contains configuraton that will be applied to any ingress/egress
# proxies created by the operator. # proxies created by the operator.
# https://tailscale.com/kb/1236/kubernetes-operator/#cluster-ingress # https://tailscale.com/kb/1439/kubernetes-operator-cluster-ingress
# https://tailscale.com/kb/1236/kubernetes-operator/#cluster-egress # https://tailscale.com/kb/1438/kubernetes-operator-cluster-egress
# Note that this section contains only a few global configuration options and # Note that this section contains only a few global configuration options and
# will not be updated with more configuration options in the future. # will not be updated with more configuration options in the future.
# If you need more configuration options, take a look at ProxyClass: # If you need more configuration options, take a look at ProxyClass:
# https://tailscale.com/kb/1236/kubernetes-operator#cluster-resource-customization-using-proxyclass-custom-resource # https://tailscale.com/kb/1445/kubernetes-operator-customization#cluster-resource-customization-using-proxyclass-custom-resource
proxyConfig: proxyConfig:
image: image:
# Repository defaults to DockerHub, but images are also synced to ghcr.io/tailscale/tailscale. # Repository defaults to DockerHub, but images are also synced to ghcr.io/tailscale/tailscale.
@ -84,7 +84,7 @@ proxyConfig:
# apiServerProxyConfig allows to configure whether the operator should expose # apiServerProxyConfig allows to configure whether the operator should expose
# Kubernetes API server. # Kubernetes API server.
# https://tailscale.com/kb/1236/kubernetes-operator/#accessing-the-kubernetes-control-plane-using-an-api-server-proxy # https://tailscale.com/kb/1437/kubernetes-operator-api-server-proxy
apiServerProxyConfig: apiServerProxyConfig:
mode: "false" # "true", "false", "noauth" mode: "false" # "true", "false", "noauth"

4
cmd/k8s-operator/deploy/crds/tailscale.com_connectors.yaml
View File

@ -37,7 +37,7 @@ spec:
exit node. exit node.
Connector is a cluster-scoped resource. Connector is a cluster-scoped resource.
More info: More info:
https://tailscale.com/kb/1236/kubernetes-operator#deploying-exit-nodes-and-subnet-routers-on-kubernetes-using-connector-custom-resource https://tailscale.com/kb/1441/kubernetes-operator-connector
type: object type: object
required: required:
- spec - spec
@ -115,7 +115,7 @@ spec:
To autoapprove the subnet routes or exit node defined by a Connector, To autoapprove the subnet routes or exit node defined by a Connector,
you can configure Tailscale ACLs to give these tags the necessary you can configure Tailscale ACLs to give these tags the necessary
permissions. permissions.
See https://tailscale.com/kb/1018/acls/#auto-approvers-for-routes-and-exit-nodes. See https://tailscale.com/kb/1337/acl-syntax#autoapprovers.
If you specify custom tags here, you must also make the operator an owner of these tags. 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. See https://tailscale.com/kb/1236/kubernetes-operator/#setting-up-the-kubernetes-operator.
Tags cannot be changed once a Connector node has been created. Tags cannot be changed once a Connector node has been created.

4
cmd/k8s-operator/deploy/crds/tailscale.com_proxyclasses.yaml
View File

@ -30,7 +30,7 @@ spec:
connector.spec.proxyClass field. connector.spec.proxyClass field.
ProxyClass is a cluster scoped resource. ProxyClass is a cluster scoped resource.
More info: More info:
https://tailscale.com/kb/1236/kubernetes-operator#cluster-resource-customization-using-proxyclass-custom-resource. https://tailscale.com/kb/1445/kubernetes-operator-customization#cluster-resource-customization-using-proxyclass-custom-resource
type: object type: object
required: required:
- spec - spec
@ -1908,7 +1908,7 @@ spec:
routes advertized by other nodes on the tailnet, such as subnet routes advertized by other nodes on the tailnet, such as subnet
routes. routes.
This is equivalent of passing --accept-routes flag to a tailscale Linux client. This is equivalent of passing --accept-routes flag to a tailscale Linux client.
https://tailscale.com/kb/1019/subnets#use-your-subnet-routes-from-other-machines https://tailscale.com/kb/1019/subnets#use-your-subnet-routes-from-other-devices
Defaults to false. Defaults to false.
type: boolean type: boolean
status: status:

8
cmd/k8s-operator/deploy/manifests/operator.yaml
View File

@ -66,7 +66,7 @@ spec:
exit node. exit node.
Connector is a cluster-scoped resource. Connector is a cluster-scoped resource.
More info: More info:
https://tailscale.com/kb/1236/kubernetes-operator#deploying-exit-nodes-and-subnet-routers-on-kubernetes-using-connector-custom-resource https://tailscale.com/kb/1441/kubernetes-operator-connector
properties: properties:
apiVersion: apiVersion:
description: |- description: |-
@ -140,7 +140,7 @@ spec:
To autoapprove the subnet routes or exit node defined by a Connector, To autoapprove the subnet routes or exit node defined by a Connector,
you can configure Tailscale ACLs to give these tags the necessary you can configure Tailscale ACLs to give these tags the necessary
permissions. permissions.
See https://tailscale.com/kb/1018/acls/#auto-approvers-for-routes-and-exit-nodes. See https://tailscale.com/kb/1337/acl-syntax#autoapprovers.
If you specify custom tags here, you must also make the operator an owner of these tags. 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. See https://tailscale.com/kb/1236/kubernetes-operator/#setting-up-the-kubernetes-operator.
Tags cannot be changed once a Connector node has been created. Tags cannot be changed once a Connector node has been created.
@ -463,7 +463,7 @@ spec:
connector.spec.proxyClass field. connector.spec.proxyClass field.
ProxyClass is a cluster scoped resource. ProxyClass is a cluster scoped resource.
More info: More info:
https://tailscale.com/kb/1236/kubernetes-operator#cluster-resource-customization-using-proxyclass-custom-resource. https://tailscale.com/kb/1445/kubernetes-operator-customization#cluster-resource-customization-using-proxyclass-custom-resource
properties: properties:
apiVersion: apiVersion:
description: |- description: |-
@ -2336,7 +2336,7 @@ spec:
routes advertized by other nodes on the tailnet, such as subnet routes advertized by other nodes on the tailnet, such as subnet
routes. routes.
This is equivalent of passing --accept-routes flag to a tailscale Linux client. This is equivalent of passing --accept-routes flag to a tailscale Linux client.
https://tailscale.com/kb/1019/subnets#use-your-subnet-routes-from-other-machines https://tailscale.com/kb/1019/subnets#use-your-subnet-routes-from-other-devices
Defaults to false. Defaults to false.
type: boolean type: boolean
type: object type: object

8
k8s-operator/api.md
View File

@ -30,7 +30,7 @@ node can be configured to act as a Tailscale subnet router and/or a Tailscale
exit node. exit node.
Connector is a cluster-scoped resource. Connector is a cluster-scoped resource.
More info: More info:
https://tailscale.com/kb/1236/kubernetes-operator#deploying-exit-nodes-and-subnet-routers-on-kubernetes-using-connector-custom-resource https://tailscale.com/kb/1441/kubernetes-operator-connector
@ -81,7 +81,7 @@ _Appears in:_
| Field | Description | Default | Validation | | Field | Description | Default | Validation |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `tags` _[Tags](#tags)_ | Tags that the Tailscale node will be tagged with.<br />Defaults to [tag:k8s].<br />To autoapprove the subnet routes or exit node defined by a Connector,<br />you can configure Tailscale ACLs to give these tags the necessary<br />permissions.<br />See https://tailscale.com/kb/1018/acls/#auto-approvers-for-routes-and-exit-nodes.<br />If you specify custom tags here, you must also make the operator an owner of these tags.<br />See https://tailscale.com/kb/1236/kubernetes-operator/#setting-up-the-kubernetes-operator.<br />Tags cannot be changed once a Connector node has been created.<br />Tag values must be in form ^tag:[a-zA-Z][a-zA-Z0-9-]*$. | | Pattern: `^tag:[a-zA-Z][a-zA-Z0-9-]*$` <br />Type: string <br /> | | `tags` _[Tags](#tags)_ | Tags that the Tailscale node will be tagged with.<br />Defaults to [tag:k8s].<br />To autoapprove the subnet routes or exit node defined by a Connector,<br />you can configure Tailscale ACLs to give these tags the necessary<br />permissions.<br />See https://tailscale.com/kb/1337/acl-syntax#autoapprovers.<br />If you specify custom tags here, you must also make the operator an owner of these tags.<br />See https://tailscale.com/kb/1236/kubernetes-operator/#setting-up-the-kubernetes-operator.<br />Tags cannot be changed once a Connector node has been created.<br />Tag values must be in form ^tag:[a-zA-Z][a-zA-Z0-9-]*$. | | Pattern: `^tag:[a-zA-Z][a-zA-Z0-9-]*$` <br />Type: string <br /> |
| `hostname` _[Hostname](#hostname)_ | Hostname is the tailnet hostname that should be assigned to the<br />Connector node. If unset, hostname defaults to <connector<br />name>-connector. Hostname can contain lower case letters, numbers and<br />dashes, it must not start or end with a dash and must be between 2<br />and 63 characters long. | | Pattern: `^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$` <br />Type: string <br /> | | `hostname` _[Hostname](#hostname)_ | Hostname is the tailnet hostname that should be assigned to the<br />Connector node. If unset, hostname defaults to <connector<br />name>-connector. Hostname can contain lower case letters, numbers and<br />dashes, it must not start or end with a dash and must be between 2<br />and 63 characters long. | | Pattern: `^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$` <br />Type: string <br /> |
| `proxyClass` _string_ | ProxyClass is the name of the ProxyClass custom resource that<br />contains configuration options that should be applied to the<br />resources created for this Connector. If unset, the operator will<br />create resources with the default configuration. | | | | `proxyClass` _string_ | ProxyClass is the name of the ProxyClass custom resource that<br />contains configuration options that should be applied to the<br />resources created for this Connector. If unset, the operator will<br />create resources with the default configuration. | | |
| `subnetRouter` _[SubnetRouter](#subnetrouter)_ | SubnetRouter defines subnet routes that the Connector node should<br />expose to tailnet. If unset, none are exposed.<br />https://tailscale.com/kb/1019/subnets/ | | | | `subnetRouter` _[SubnetRouter](#subnetrouter)_ | SubnetRouter defines subnet routes that the Connector node should<br />expose to tailnet. If unset, none are exposed.<br />https://tailscale.com/kb/1019/subnets/ | | |
@ -378,7 +378,7 @@ given ProxyClass to resources created for a Connector, use
connector.spec.proxyClass field. connector.spec.proxyClass field.
ProxyClass is a cluster scoped resource. ProxyClass is a cluster scoped resource.
More info: More info:
https://tailscale.com/kb/1236/kubernetes-operator#cluster-resource-customization-using-proxyclass-custom-resource. https://tailscale.com/kb/1445/kubernetes-operator-customization#cluster-resource-customization-using-proxyclass-custom-resource
@ -783,6 +783,6 @@ _Appears in:_
| Field | Description | Default | Validation | | Field | Description | Default | Validation |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `acceptRoutes` _boolean_ | AcceptRoutes can be set to true to make the proxy instance accept<br />routes advertized by other nodes on the tailnet, such as subnet<br />routes.<br />This is equivalent of passing --accept-routes flag to a tailscale Linux client.<br />https://tailscale.com/kb/1019/subnets#use-your-subnet-routes-from-other-machines<br />Defaults to false. | | | | `acceptRoutes` _boolean_ | AcceptRoutes can be set to true to make the proxy instance accept<br />routes advertized by other nodes on the tailnet, such as subnet<br />routes.<br />This is equivalent of passing --accept-routes flag to a tailscale Linux client.<br />https://tailscale.com/kb/1019/subnets#use-your-subnet-routes-from-other-devices<br />Defaults to false. | | |

4
k8s-operator/apis/v1alpha1/types_connector.go
View File

@ -29,7 +29,7 @@
// exit node. // exit node.
// Connector is a cluster-scoped resource. // Connector is a cluster-scoped resource.
// More info: // More info:
// https://tailscale.com/kb/1236/kubernetes-operator#deploying-exit-nodes-and-subnet-routers-on-kubernetes-using-connector-custom-resource // https://tailscale.com/kb/1441/kubernetes-operator-connector
type Connector struct { type Connector struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"` metav1.ObjectMeta `json:"metadata,omitempty"`
@ -62,7 +62,7 @@ type ConnectorSpec struct {
// To autoapprove the subnet routes or exit node defined by a Connector, // To autoapprove the subnet routes or exit node defined by a Connector,
// you can configure Tailscale ACLs to give these tags the necessary // you can configure Tailscale ACLs to give these tags the necessary
// permissions. // permissions.
// See https://tailscale.com/kb/1018/acls/#auto-approvers-for-routes-and-exit-nodes. // See https://tailscale.com/kb/1337/acl-syntax#autoapprovers.
// If you specify custom tags here, you must also make the operator an owner of these tags. // 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. // See https://tailscale.com/kb/1236/kubernetes-operator/#setting-up-the-kubernetes-operator.
// Tags cannot be changed once a Connector node has been created. // Tags cannot be changed once a Connector node has been created.

4
k8s-operator/apis/v1alpha1/types_proxyclass.go
View File

@ -25,7 +25,7 @@
// connector.spec.proxyClass field. // connector.spec.proxyClass field.
// ProxyClass is a cluster scoped resource. // ProxyClass is a cluster scoped resource.
// More info: // More info:
// https://tailscale.com/kb/1236/kubernetes-operator#cluster-resource-customization-using-proxyclass-custom-resource. // https://tailscale.com/kb/1445/kubernetes-operator-customization#cluster-resource-customization-using-proxyclass-custom-resource
type ProxyClass struct { type ProxyClass struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"` metav1.ObjectMeta `json:"metadata,omitempty"`
@ -73,7 +73,7 @@ type TailscaleConfig struct {
// routes advertized by other nodes on the tailnet, such as subnet // routes advertized by other nodes on the tailnet, such as subnet
// routes. // routes.
// This is equivalent of passing --accept-routes flag to a tailscale Linux client. // This is equivalent of passing --accept-routes flag to a tailscale Linux client.
// https://tailscale.com/kb/1019/subnets#use-your-subnet-routes-from-other-machines // https://tailscale.com/kb/1019/subnets#use-your-subnet-routes-from-other-devices
// Defaults to false. // Defaults to false.
AcceptRoutes bool `json:"acceptRoutes,omitempty"` AcceptRoutes bool `json:"acceptRoutes,omitempty"`
} }