Ouroboros Tutorial 03 - Revision history

Thijs at 12:59, 30 November 2023

2023-11-30T12:59:23Z

← Older revision		Revision as of 12:59, 30 November 2023
Line 35:		Line 35:
	Instead of logging to standard output, we will use the system log, which is Ouroboros' default. Use your preferred way to view the system log. We use journalctl		Instead of logging to standard output, we will use the system log, which is Ouroboros' default. Use your preferred way to view the system log. We use journalctl

	$ sudo journalctl --identifier=irmd --follow #short form: sudo journalctl -t irmd -f		$ sudo journalctl --identifier=irmd --follow #short form: sudo journalctl -t irmd -f

	In a different window, start the irmd using the config file and without the ''--stdout'' option:		In a different window, start the irmd using the config file and without the ''--stdout'' option:

Thijs: Use long form command line options in documentation & tutorials.

2023-11-30T12:57:52Z

Use long form command line options in documentation & tutorials.

← Older revision		Revision as of 12:57, 30 November 2023
Line 9:		Line 9:
	[name.oping-server]		[name.oping-server]
	prog=["/usr/bin/oping"]		prog=["/usr/bin/oping"]
	args=["-l"]		args=["--listen"]

	[local.local-ipcp]		[local.local-ipcp]
Line 43:		Line 43:
	This will load the configuration and will set up the same network that we created in [[Ouroboros Tutorial 02 \| the second tutorial]].		This will load the configuration and will set up the same network that we created in [[Ouroboros Tutorial 02 \| the second tutorial]].

	Now, we will ping an oping server from the client over that unicast-layer. In the previous two tutorials, we first started the server, but O7s can start a server automatically. This is the ''auto'' feature of the ''irm bind program'' CLI tool. In the configuration file, this feature is enabled by specifying an ''args'' line for a service name. In our configuration example, we defined that the service name ''oping-server'' is bound to program ''/usr/bin/oping'' and can be automatically started if needed with the argument ''-l'' (~~which~~ is ~~short for~~ -~~-listen~~).		Now, we will ping an oping server from the client over that unicast-layer. In the previous two tutorials, we first started the server, but O7s can start a server automatically. This is the ''auto'' feature of the ''irm bind program'' CLI tool. In the configuration file, this feature is enabled by specifying an ''args'' line for a service name. In our configuration example, we defined that the service name ''oping-server'' is bound to program ''/usr/bin/oping'' and can be automatically started if needed with the argument ''--listen'' (the short form is -l).

	Just start a client towards oping-server:		Just start a client towards oping-server:

Thijs: Use long form command line options in documentation & tutorials.

2023-11-30T12:52:56Z

Use long form command line options in documentation & tutorials.

← Older revision		Revision as of 12:52, 30 November 2023
Line 35:		Line 35:
	Instead of logging to standard output, we will use the system log, which is Ouroboros' default. Use your preferred way to view the system log. We use journalctl		Instead of logging to standard output, we will use the system log, which is Ouroboros' default. Use your preferred way to view the system log. We use journalctl

	$ sudo journalctl -t irmd -f		$ sudo journalctl --identifier=irmd --follow #short form: sudo journalctl -t irmd -f

	In a different window, start the irmd using the config file and without the ''--stdout'' option:		In a different window, start the irmd using the config file and without the ''--stdout'' option:

Dimitri at 09:24, 7 November 2023

2023-11-07T09:24:56Z

← Older revision		Revision as of 09:24, 7 November 2023
Line 29:		Line 29:
	It has 4 stanza:		It has 4 stanza:
	# ''name.oping-server'': This creates a service name, in this case the name is ''oping-server''. Note that if we wanted to name the service ''oping.server'' it would need quotes like this ''[name."oping.server"]''. That name will be served by all instances of the ''oping'' binary (located at /usr/bin/oping). We specify the ''args'' option to start oping automatically (see below).		# ''name.oping-server'': This creates a service name, in this case the name is ''oping-server''. Note that if we wanted to name the service ''oping.server'' it would need quotes like this ''[name."oping.server"]''. That name will be served by all instances of the ''oping'' binary (located at /usr/bin/oping). We specify the ''args'' option to start oping automatically (see below).
	# ''local.local-ipcp'': ~~This creates~~ a local IPCP called ''local-ipcp''. We also specify a bootstrap option to start a new Layer called ''local-layer''. We will be running 2 unicast IPCPs on top, named uni-1 and uni-2. Both of these will also listen to the ''anycast'' name ''unicast-layer''.		# ''local.local-ipcp'': The IRMd will start a local IPCP called ''local-ipcp''. We also specify a bootstrap option to start a new Layer called ''local-layer''. We will be running 2 unicast IPCPs on top, named uni-1 and uni-2. Both of these will also listen to the ''anycast'' name ''unicast-layer''.
	# ''unicast.uni-1'':		# ''unicast.uni-1'': The IRMd will start a unicast IPCP called ''uni-1''. We also specify it will bootstrap a new network Layer called ''unicast-layer''. The autobind option will bind it to both the IPCP name ("uni-1") as the anycast layer name ("unicast-layer"). We register the oping server application on this node.
	# ''unicast.uni-2'':		# ''unicast.uni-2'': The IRMd will start a unicast IPCP called ''uni-1''. This IPCP will not bootstrap, but enroll in the ''unicast-layer'' and then connect (creating both management and data transfer flow) to create a forwarding adjacency with "uni-1".

	Instead of logging to standard output, we will use the system log, which is Ouroboros' default. Use your preferred way to view the system log. We use journalctl		Instead of logging to standard output, we will use the system log, which is Ouroboros' default. Use your preferred way to view the system log. We use journalctl

Dimitri at 09:14, 7 November 2023

2023-11-07T09:14:40Z

← Older revision		Revision as of 09:14, 7 November 2023
Line 23:		Line 23:
	enrol="unicast-layer"		enrol="unicast-layer"
	conn=["uni-1"]		conn=["uni-1"]
			</syntaxhighlight>

	</~~syntaxhighlight>~~		The configuration file is in TOML format (we may add support for other formats in the future). This demo will create a local Layer and then a 2-node unicast Layer on top, just like in [[Ouroboros Tutorial 02 \| Tutorial 02]] to support the ''oping'' application.

			It has 4 stanza:
			# ''name.oping-server'': This creates a service name, in this case the name is ''oping-server''. Note that if we wanted to name the service ''oping.server'' it would need quotes like this ''[name."oping.server"]''. That name will be served by all instances of the ''oping'' binary (located at /usr/bin/oping). We specify the ''args'' option to start oping automatically (see below).
			# ''local.local-ipcp'': This creates a local IPCP called ''local-ipcp''. We also specify a bootstrap option to start a new Layer called ''local-layer''. We will be running 2 unicast IPCPs on top, named uni-1 and uni-2. Both of these will also listen to the ''anycast'' name ''unicast-layer''.
			# ''unicast.uni-1'':
			# ''unicast.uni-2'':

	Instead of logging to standard output, we will use the system log, which is Ouroboros' default. Use your preferred way to view the system log. We use journalctl		Instead of logging to standard output, we will use the system log, which is Ouroboros' default. Use your preferred way to view the system log. We use journalctl

Dimitri at 08:42, 7 November 2023

2023-11-07T08:42:14Z

← Older revision		Revision as of 08:42, 7 November 2023
Line 30:		Line 30:
	$ sudo journalctl -t irmd -f		$ sudo journalctl -t irmd -f

	In a different window, start the irmd ~~reading~~ the config file:		In a different window, start the irmd using the config file and without the ''--stdout'' option:

	$ sudo irmd --config /etc/ouroboros/tut03.conf		$ sudo irmd --config /etc/ouroboros/tut03.conf

Dimitri at 08:39, 7 November 2023

2023-11-07T08:39:31Z

← Older revision		Revision as of 08:39, 7 November 2023
Line 5:		Line 5:
	Copy/paste the text below and store it as a file, we named it ''tut03.conf'' and saved it in /etc/ouroboros/, which is the default used for O7s configurations.		Copy/paste the text below and store it as a file, we named it ''tut03.conf'' and saved it in /etc/ouroboros/, which is the default used for O7s configurations.

	<syntaxhighlight>		<syntaxhighlight lang=toml>
	### Ouroboros configuration file Tutorial 03		### Ouroboros configuration file Tutorial 03
	[name.oping-server]		[name.oping-server]

Dimitri at 17:20, 5 November 2023

2023-11-05T17:20:09Z

← Older revision		Revision as of 17:20, 5 November 2023
Line 1:		Line 1:
	[[File: O7s_tutorial03-01.png\|border\|right\|thumb\|frame\|Ouroboros Tutorial 03]]		[[File: O7s_tutorial03-01.png\|border\|right\|thumb\|frame\|Ouroboros Tutorial 03]]

	Ouroboros can be configured using a config file in TOML format (requires libtomlc99 to be installed).		Ouroboros can be configured using a config file in TOML format (requires [https://github.com/cktan/tomlc99 libtomlc99] to be installed when building the prototype).

	Copy/paste the text below and store it as a file, we named it ''tut03.conf'' and saved it in /etc/ouroboros/, which is the default used for O7s configurations.		Copy/paste the text below and store it as a file, we named it ''tut03.conf'' and saved it in /etc/ouroboros/, which is the default used for O7s configurations.

Dimitri at 17:19, 5 November 2023

2023-11-05T17:19:28Z

← Older revision		Revision as of 17:19, 5 November 2023
Line 1:		Line 1:
	[[File: O7s_tutorial03-01.png\|border\|right\|thumb\|frame\|Ouroboros Tutorial 03]]		[[File: O7s_tutorial03-01.png\|border\|right\|thumb\|frame\|Ouroboros Tutorial 03]]

	Ouroboros can be configured using a config file in TOML format.		Ouroboros can be configured using a config file in TOML format (requires libtomlc99 to be installed).

	Copy/paste the text below and store it as a file, we named it ''tut03.conf'' and saved it in /etc/ouroboros/, which is the default used for O7s configurations.		Copy/paste the text below and store it as a file, we named it ''tut03.conf'' and saved it in /etc/ouroboros/, which is the default used for O7s configurations.

Dimitri at 17:15, 5 November 2023

2023-11-05T17:15:07Z

← Older revision		Revision as of 17:15, 5 November 2023
Line 63:		Line 63:
	Flow 64 timed out.		Flow 64 timed out.

	When the IRMd auto-instantiates a program, it will log ~~the following~~:		When the IRMd auto-instantiates a program, it will log this event as:

	Nov 05 17:58:38 phonetria irmd[3820]: Flow request arrived for oping-server.		Nov 05 17:58:38 phonetria irmd[3820]: Flow request arrived for oping-server.
	Nov 05 17:58:38 phonetria irmd[3820]: Instantiated /usr/bin/oping as process 3961.		Nov 05 17:58:38 phonetria irmd[3820]: Instantiated /usr/bin/oping as process 3961.
			Nov 05 17:58:38 phonetria irmd[3820]: Process 3961 inherits name oping-server from program oping.