rockstor / rockstor-doc

Rockstor documentation
http://rockstor.com/docs
Other
24 stars 29 forks source link

The requirements for the Tailscale service are not described #471

Closed FroggyFlox closed 2 months ago

FroggyFlox commented 3 months ago

We currently do not list the requirements for the configuration of the Tailscale service:

This might have already been needed by a user of the Testing channel: https://forum.rockstor.com/t/unknown-internal-error-doing-a-post-to-api-sm-services-tailscaled-config/9418/2.

We should provide a link to the Tailscale docs that provide clear step-by-step instructions: https://tailscale.com/download/linux/opensuse-leap-15.2

Note that this page has two methods:


Partner doc issue: https://github.com/rockstor/rockstor-core/issues/2845

phillxnet commented 3 months ago

@FroggyFlox Thanks for creating this issue. From the context it does look like we need to have this doc entry in order to intercept and explain our two upstreams interincompatibility: i.e. the referenced Tailscale issue. It looks to me like that issue was accidentally closed actually.

[EDIT] Regarding: https://tailscale.com/kb/1303/install-opensuse-leap They now use, in those instructions, the a $VERSION env: so we may want to suggest that. And detail issues of the failure mode associated with them not having 15.6 for example.

FroggyFlox commented 3 months ago

They now use, in those instructions, the a $VERSION env

If I remember correctly, their auto install script also uses the $VERSION variable for most of the supported distributions. This does seem like their favorite route of operation, indeed.

phillxnet commented 2 months ago

State as of release of 15.6

From: https://tailscale.com/kb/1303/install-opensuse-leap

https://pkgs.tailscale.com/stable/opensuse/leap/15.6/tailscale.repo

is still non-existent, and the Tail scale front page here: https://tailscale.com/ - Download (top menu) - scroll-down has max Leap version of 15.2 !! So we have our docs point to the still outdated but years more relevant first link in this comment.

We should reference in our doc section, Tailscales Terms and Conditions for the use of their repository. This is indicated in the overview of available stable channel repos for statically linked binaries here:

https://pkgs.tailscale.com/stable/#static

phillxnet commented 2 months ago

I'm going to tackle at least the first flush of this issue. I.e. adding to our existing Tailscale section the indicated need to install first: https://rockstor.com/docs/interface/system/services.html#tailscale

And as from "Add Tailscale to list of features #461" #482 We no have the Tailscale upstream and our services page linked from our website index.

Give we already have a link to this doc section from within our current Web-UI thanks to @FroggyFlox via:

"Add/Update help icon linking to docs #2720" #2725

we can leverage this to point folks already to the reason they may encournter Tailscale config issues. This doc issues partner issue in rockstor-core can then enhance this further with more contextual feedback on the need to install Tailscale first.

phillxnet commented 2 months ago

Re:

Give we already have a link to this doc section from within our current Web-UI thanks to @FroggyFlox via:

Our Web-UI embedded current doc links is as follows: Existing-link-to-docs