From 65c26357b10db228b7abe9116ad6a2c89ecb98d1 Mon Sep 17 00:00:00 2001 From: Cameron Stokes Date: Wed, 25 Sep 2024 14:15:42 -0700 Subject: [PATCH] cmd/k8s-operator, k8s-operator: fix outdated kb links (#13585) updates #13583 Signed-off-by: Cameron Stokes --- cmd/k8s-operator/deploy/chart/values.yaml | 8 ++++---- .../deploy/crds/tailscale.com_connectors.yaml | 4 ++-- .../deploy/crds/tailscale.com_proxyclasses.yaml | 4 ++-- cmd/k8s-operator/deploy/manifests/operator.yaml | 8 ++++---- k8s-operator/api.md | 8 ++++---- k8s-operator/apis/v1alpha1/types_connector.go | 4 ++-- k8s-operator/apis/v1alpha1/types_proxyclass.go | 4 ++-- 7 files changed, 20 insertions(+), 20 deletions(-) diff --git a/cmd/k8s-operator/deploy/chart/values.yaml b/cmd/k8s-operator/deploy/chart/values.yaml index bf98a725b..43ed382c6 100644 --- a/cmd/k8s-operator/deploy/chart/values.yaml +++ b/cmd/k8s-operator/deploy/chart/values.yaml @@ -57,12 +57,12 @@ operatorConfig: # proxyConfig contains configuraton that will be applied to any ingress/egress # proxies created by the operator. -# https://tailscale.com/kb/1236/kubernetes-operator/#cluster-ingress -# https://tailscale.com/kb/1236/kubernetes-operator/#cluster-egress +# https://tailscale.com/kb/1439/kubernetes-operator-cluster-ingress +# https://tailscale.com/kb/1438/kubernetes-operator-cluster-egress # Note that this section contains only a few global configuration options and # will not be updated with more configuration options in the future. # 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: image: # 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 # 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: mode: "false" # "true", "false", "noauth" diff --git a/cmd/k8s-operator/deploy/crds/tailscale.com_connectors.yaml b/cmd/k8s-operator/deploy/crds/tailscale.com_connectors.yaml index 66ff060d4..9614f74e6 100644 --- a/cmd/k8s-operator/deploy/crds/tailscale.com_connectors.yaml +++ b/cmd/k8s-operator/deploy/crds/tailscale.com_connectors.yaml @@ -37,7 +37,7 @@ spec: exit node. Connector is a cluster-scoped resource. 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 required: - spec @@ -115,7 +115,7 @@ spec: 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. + 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. See https://tailscale.com/kb/1236/kubernetes-operator/#setting-up-the-kubernetes-operator. Tags cannot be changed once a Connector node has been created. diff --git a/cmd/k8s-operator/deploy/crds/tailscale.com_proxyclasses.yaml b/cmd/k8s-operator/deploy/crds/tailscale.com_proxyclasses.yaml index dc16511ce..0fff30516 100644 --- a/cmd/k8s-operator/deploy/crds/tailscale.com_proxyclasses.yaml +++ b/cmd/k8s-operator/deploy/crds/tailscale.com_proxyclasses.yaml @@ -30,7 +30,7 @@ spec: connector.spec.proxyClass field. ProxyClass is a cluster scoped resource. 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 required: - spec @@ -1908,7 +1908,7 @@ spec: routes advertized by other nodes on the tailnet, such as subnet routes. 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. type: boolean status: diff --git a/cmd/k8s-operator/deploy/manifests/operator.yaml b/cmd/k8s-operator/deploy/manifests/operator.yaml index 0929aff4c..f35703621 100644 --- a/cmd/k8s-operator/deploy/manifests/operator.yaml +++ b/cmd/k8s-operator/deploy/manifests/operator.yaml @@ -66,7 +66,7 @@ spec: exit node. Connector is a cluster-scoped resource. 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: apiVersion: description: |- @@ -140,7 +140,7 @@ spec: 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. + 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. See https://tailscale.com/kb/1236/kubernetes-operator/#setting-up-the-kubernetes-operator. Tags cannot be changed once a Connector node has been created. @@ -463,7 +463,7 @@ spec: connector.spec.proxyClass field. ProxyClass is a cluster scoped resource. 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: apiVersion: description: |- @@ -2336,7 +2336,7 @@ spec: routes advertized by other nodes on the tailnet, such as subnet routes. 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. type: boolean type: object diff --git a/k8s-operator/api.md b/k8s-operator/api.md index e96baa790..fe673dd4e 100644 --- a/k8s-operator/api.md +++ b/k8s-operator/api.md @@ -30,7 +30,7 @@ node can be configured to act as a Tailscale subnet router and/or a Tailscale exit node. Connector is a cluster-scoped resource. 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 | | --- | --- | --- | --- | -| `tags` _[Tags](#tags)_ | 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-]*$. | | Pattern: `^tag:[a-zA-Z][a-zA-Z0-9-]*$`
Type: string
| +| `tags` _[Tags](#tags)_ | 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/1337/acl-syntax#autoapprovers.
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-]*$. | | Pattern: `^tag:[a-zA-Z][a-zA-Z0-9-]*$`
Type: string
| | `hostname` _[Hostname](#hostname)_ | Hostname is the tailnet hostname that should be assigned to the
Connector node. If unset, hostname defaults to 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. | | Pattern: `^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$`
Type: string
| | `proxyClass` _string_ | 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. | | | | `subnetRouter` _[SubnetRouter](#subnetrouter)_ | SubnetRouter defines subnet routes that the Connector node should
expose to tailnet. If unset, none are exposed.
https://tailscale.com/kb/1019/subnets/ | | | @@ -378,7 +378,7 @@ given ProxyClass to resources created for a Connector, use connector.spec.proxyClass field. ProxyClass is a cluster scoped resource. 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 | | --- | --- | --- | --- | -| `acceptRoutes` _boolean_ | AcceptRoutes can be set to true to make the proxy instance accept
routes advertized by other nodes on the tailnet, such as subnet
routes.
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
Defaults to false. | | | +| `acceptRoutes` _boolean_ | AcceptRoutes can be set to true to make the proxy instance accept
routes advertized by other nodes on the tailnet, such as subnet
routes.
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-devices
Defaults to false. | | | diff --git a/k8s-operator/apis/v1alpha1/types_connector.go b/k8s-operator/apis/v1alpha1/types_connector.go index 87c44926b..21d4e4834 100644 --- a/k8s-operator/apis/v1alpha1/types_connector.go +++ b/k8s-operator/apis/v1alpha1/types_connector.go @@ -29,7 +29,7 @@ // exit node. // Connector is a cluster-scoped resource. // 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 { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` @@ -62,7 +62,7 @@ type ConnectorSpec struct { // 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. + // 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. // See https://tailscale.com/kb/1236/kubernetes-operator/#setting-up-the-kubernetes-operator. // Tags cannot be changed once a Connector node has been created. diff --git a/k8s-operator/apis/v1alpha1/types_proxyclass.go b/k8s-operator/apis/v1alpha1/types_proxyclass.go index bdf7bd380..7f415bc34 100644 --- a/k8s-operator/apis/v1alpha1/types_proxyclass.go +++ b/k8s-operator/apis/v1alpha1/types_proxyclass.go @@ -25,7 +25,7 @@ // connector.spec.proxyClass field. // ProxyClass is a cluster scoped resource. // 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 { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` @@ -73,7 +73,7 @@ type TailscaleConfig struct { // routes advertized by other nodes on the tailnet, such as subnet // routes. // 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. AcceptRoutes bool `json:"acceptRoutes,omitempty"` }