network: Add nmstate examples

[cathay4t]

Now that nmstate is part of fcos the network configuration examples
should be extended with it.

Also fixed 10.10.10.1 been listed as IP address in NetworkManager key
file, it is supposed to be a gateway IP, not IP address of NIC.

[qinqon]

@cathay4t -> coreos/fedora-coreos-tracker#1175 (comment)

[cathay4t]

@dustymabe Any remaining task should I do to get this merged?

[dustymabe]

Thank you for working on this! I left some comments inline in the changes. I think ultimately the format of this is a bit unwieldy for the user, but I think having tabs support (which I've requested) will make this much better. We don't need to block on that here, though.

[dustymabe]

the later examples include a routes: entry in the nmstate yml file. I'm not sure I understand why those include it and this one doesn't?

[dustymabe]

Suggested change

	There are to main methods for configuring networking with ignition
	There are two main methods for configuring networking by delivering text configuration files via Ignition:

Also Let's add a blank line after this line so the bullets get broken out properly by antora/asciidoctor

[dustymabe]

I think we can shorten this now:

Suggested change

	- By creating NetworkManager configuration files described in an Ignition config. These are https://networkmanager.dev/docs/api/latest/nm-settings-keyfile.html[NetworkManager keyfiles] that are written to `/etc/NetworkManager/system-connections/` that tell NetworkManager what to do.
	- By creating https://networkmanager.dev/docs/api/latest/nm-settings-keyfile.html[NetworkManager keyfiles] that are written to `/etc/NetworkManager/system-connections/` that tell NetworkManager what to do.

[dustymabe]

I assume everywhere in this file we should be consisten with the capitalization of NMstate? Also a few wording suggestsion:

Suggested change

	- By creating a nmstate desire state YAML(postfix .yml) files at /etc/nmstate following https://nmstate.io[NMstate syntax]. The applied network state file will be renamed with postfix .applied to prevent repeated applied on next run.
	- By creating NMstate desired state YAML files with the `.yml` suffix under `/etc/nmstate/` following the https://nmstate.io[NMstate syntax]. The state files will be applied and then renamed with a `.applied` suffix to prevent being processed again.

[dustymabe]

Adding a . on the front will make the formatting look nice in antora:

Suggested change

	NetworkManager
	.NetworkManager keyfile

Also suggested adding keyfile on the end there.

I would apply this to all other instances in the file.

[dustymabe]

The . on the front makes the formatting nicer. Also suggest adding YAML:

Suggested change

	NMstate
	.NMstate YAML

I would apply this to all other instances in the file.

[dustymabe]

Suggested change

	In this section we'll go through common examples of setting up different types of networking devices using dracut kernel arguments, NetworkManager keyfiles and nmstate via Ignition/Butane.
	In this section we'll go through common examples of setting up different types of networking devices using dracut kernel arguments, NetworkManager keyfiles and NMstate via Ignition/Butane.

[dustymabe]

Suggested change

	==== Butane Nmstate config
	==== Butane NMstate YAML config

If we make this change then apply everywhere else too

[dustymabe]

To make it a little more clear:

Suggested change

	==== Butane NetworkManager config
	==== Butane NetworkManager keyfile config

If we make this change then apply everywhere else too