cumulusnetworks / docs Goto Github PK

• Image has only swp1/swp2
• Vlans on image does not match vlans in example configuration

https://docs.cumulusnetworks.com/cumulus-linux-42/Layer-2/Link-Layer-Discovery-Protocol/Voice-VLAN/#example-configuration

The User Guide PDF for version 4.2 contains a lot of similarly broken links. The PDF is available at https://docs.cumulusnetworks.com/cumulus-linux-42/

Example
All links with text 'Management VRF' point neither to the respective PDF section nor the respective online manual section. Instead, the links point to something like https://stage.*.amplifyapp.com/cumulus-linux-42/Layer-3/Management-VRF/ , where the '*' is some (not sure if variable) alpha-numeric id . Seems to be the result of the amplify.yaml configuration file.

I do not have any proposed solution, because I am not familiar with the build process.

The documentation for backing up NetQ 4.5.0 or later references an option that is invalid.

The command sudo /usr/sbin/vm-backuprestore.sh --backup --start-pods
needs to be updated to sudo /usr/sbin/vm-backuprestore.sh --backup --start_pods

Specifically the underscore instead of hyphen in --start_pods

https://github.com/CumulusNetworks/docs/blob/stage/content/cumulus-linux-42/Layer-3/Routing.md

If the interface is bounced up and down, then the routes are no longer in the route table.

I'm not quite sure what this sentence is trying to say. Based on the config provided, it looks like this route would be readded after the interface comes back up.

https://docs.nvidia.com/networking-ethernet-software/nvue-reference/Show-Commands/System-Config/

This page seems to be missing documentation and an example for overwrite: all.

cumulus@switch:mgmt:~$ nv show system config apply
ignore: {}
overwrite: all

The following commands are invalid in this document:
https://docs.nvidia.com/networking-ethernet-software/cumulus-linux-55/System-Configuration/Authentication-Authorization-and-Accounting/SSH-for-Remote-Access/#nvue-managed-user

cumulus@leaf01:~$ nv set user admin2 ssh authorized-key prod_key key 1234
cumulus@leaf01:~$ nv set user admin2 ssh authorized-key prod_key type ssh-rsa
cumulus@leaf01:~$ nv config apply

Probably just needs to be updated to nv set system aaa user ...

Additionally, it would be nice to see a more realistic example of this command as adding user accounts is a very common task.

Need to specify which branch the PRs should come in to.
https://github.com/CumulusNetworks/docs#contributing-to-the-documentation

In the PDF for Cumulus 4.2, there is no index present. The PDF currently contains over 2000 pages and is available at https://docs.cumulusnetworks.com/cumulus-linux-42/

This seems to be a regression as compared to the PDF for Cumulus Linux 3.7, which has a very usable index. Available at https://docs.cumulusnetworks.com/cumulus-linux-37/

content/cumulus-linux-55/Monitoring-and-Troubleshooting/Simple-Network-Management-Protocol-SNMP/Supported-MIBs.md

Cumulus Linux also includes its own BGP unnumbered MIB for BGP unnumbered peers, defined in /usr/share/snmp/mibs/Cumulus-BGPUN-MIB.txt, which has the OID 1.3.6.1.41.1.40310.7.

The OID is written as "1.3.6.1.41.1.40310.7", but I believe the correct one is "1.3.6.1.4.1.40310.7".
Could you please update the document accordingly?

The link to the pdf version of the user guide (https://docs.nvidia.com/cumulus-linux-43/cumulus-linux-43.pdf) redirects immediately to https://docs.nvidia.com/. How can I download a pdf version of the dokumentation?
The same issue is true for version 4.0, 4.1, 4.3 and 3.7.12 ESR (https://docs.nvidia.com/cumulus-linux-37/cumulus-linux-37.pdf).

I'm following this procedure but can't get the server running. It hangs for a long time and then fails:

~/docs stage !1 ?1 ❯ ./hugo server -v
INFO 2021/07/26 20:28:29 Using config file:
Start building sites …
INFO 2021/07/26 20:28:29 syncing static files to /
Built in 97810 ms
Error: Error building site: TOCSS: failed to transform "book.scss" (text/x-scss). Check your Hugo installation; you need the extended version to build SCSS/SASS.
~/docs stage !1 ?1 ❯ ./hugo version                                                                                     ✘ 255 1m 38s
hugo v0.82.0-9D960784 linux/amd64 BuildDate=2021-03-21T17:28:04Z VendorInfo=gohugoio

Hi there,

when using the Online Documentation at https://docs.cumulusnetworks.com/cumulus-linux-42/System-Configuration/Authentication-Authorization-and-Accounting/ (or any other page on that Level that has direct Links) you cannot access the "TACACS+" documentation.

Seems like the Link "https://docs.cumulusnetworks.com/cumulus-linux-42/System-Configuration/Authentication-Authorization-and-Accounting/TACACS+/" is br0ken/invalid.

docs/content/cumulus-linux-44/System-Configuration/Netfilter-ACLs/Default-Cumulus-Linux-ACL-Configuration.md

The document says things like Police: Packet rate 2000 burst 2000 but doesn't give any indication what that means - as it says packet rate I'd assume maybe packets per second? but it could equally be bits per second? or per any other time period really? Could the document please be updated to include some detail on the units?

Documentation for CL v5.5 reports incorrect attribute gateway instead of giaddress

cumulus@DC-Spine02:mgmt:~$ nv set service dhcp-relay default source-ip 
auto       giaddress  
cumulus@DC-Spine02:mgmt:~$ nv set service dhcp-relay default source-ip giaddress 
cumulus@DC-Spine02:mgmt:~$ nv config diff 
- set:
    service:
      dhcp-relay:
        default:
          source-ip: giaddress