Organize network docs differently and add Multus #257
Conversation
manuelbuil
force-pushed
the
newNetworkDocs
branch
8 times, most recently
from
8515447 to
912e372
Compare
manuelbuil
requested review from
dereknola,
brandond,
rbrtbnfgl and
thomasferrandiz
There was a problem hiding this comment.
I think its time we moved the networking stuff out of the installation dropdown and just integrate it at the top level. Incorporate the existing network page as "Network Components", because its basically a reference page on what various networking addons do.
This has always been in my mind but I was hesitant to do it. On the one hand, having two different Network sections is strange but I think the separation was made based on: what's related to setting up the cluster and what's not. On the other hand, if we consolidate everything in one Networking section outside of the installation dropdown, we would have installation related parts that are not in the installation section, which could also be confusing? |
manuelbuil
force-pushed
the
newNetworkDocs
branch
5 times, most recently
from
5e7c93a to
85a678d
Compare
There was a problem hiding this comment.
If we're going to move this file, can we keep a redirect or placeholder page in place so that old links to https://docs.k3s.io/installation/network-options continue to work?
@dereknola any suggestions on how to accomplish this?
There was a problem hiding this comment.
Good point, @manuelbuil you just need to add a line at https://github.com/k3s-io/docs/blob/main/docusaurus.config.js#L121
{ from: '/installation/network-options', to: '/networking/basic-network-options' },
85a678d to
26da7ec
Compare
manuelbuil
force-pushed
the
newNetworkDocs
branch
from
26da7ec to
69b893f
Compare
Signed-off-by: Manuel Buil <[email protected]>
manuelbuil
force-pushed
the
newNetworkDocs
branch
from
69b893f to
80a91ee
Compare
| </Tabs> |
There was a problem hiding this comment.
Nothing, I think it is a strange Github effect. The </Tabs> is correct
| @@ -17,7 +17,7 @@ | |||
| "@docusaurus/core": "^3.2.0", | |||
| "@docusaurus/plugin-client-redirects": "^3.2.0", | |||
| "@docusaurus/preset-classic": "^3.2.0", | |||
| "@docusaurus/theme-common": "^3.0.1", | |||
| "@docusaurus/theme-common": "^3.2.0", | |||
There was a problem hiding this comment.
Is it right to change also these files?
There was a problem hiding this comment.
Good catch. I think it is ok because things are still working and my env requires that to make docs work
| <TabItem value="host-local" default> | ||
| The host-local IPAM plugin allocates ip addresses out of a set of address ranges. It stores the state locally on the host filesystem, hence ensuring uniqueness of IP addresses on a single host. Therefore, we don't recommend it for multi-node clusters. This IPAM plugin does not require any extra deployment. For more information: https://www.cni.dev/plugins/current/ipam/host-local/. | ||
|
|
||
| To use the host-local plugin, please create a file called `multus-values.yaml` with the following content: |
There was a problem hiding this comment.
In which folder should the user create this file?
There was a problem hiding this comment.
It does not matter, it is used later as values for the helm install command:
helm install multus rke2-charts/rke2-multus -n kube-system --kubeconfig /etc/rancher/k3s/k3s.yaml --values multus-values.yaml
There was a problem hiding this comment.
Ok I was confused. I thought it was used to deploy multus automatically
This PR adds information about how to use Multus with additional IPAMs (e.g. whereabouts).
Moreover, it consolidates all networking information in the Networking tab, which has three different sections:
The networking information under installation gets removed
Having all together felt too much for just one document