Nms current design - Revision history

Chubbard: /* Backend */

2023-10-13T00:11:52Z

Backend

← Older revision		Revision as of 17:11, 12 October 2023
Line 17:		Line 17:
	* User access levels work		* User access levels work
	* Still some minor warnings to clean up due to PHP version change		* Still some minor warnings to clean up due to PHP version change
			** As I have gotten better with PHP looking at older APIs makes me think some of them should be re-implemented
			** Focus more on CRUD for every API, and make sure information leakage is always minimal
			** Keep putting notes in your PHP! Even snarky crap can be useful

	== Frontend ==		== Frontend ==

Chubbard: /* Frontend */

2023-10-13T00:08:26Z

Frontend

← Older revision		Revision as of 17:08, 12 October 2023
Line 19:		Line 19:

	== Frontend ==		== Frontend ==
	Frontend is Bootstrap5 and ~~PHP7~~.x		Frontend is Bootstrap5 and PHP8.x
	# No database connections will EVER be allowed from the frontend. Anything to do with the DB must use an API.		# No database connections will EVER be allowed from the frontend. Anything to do with the DB must use an API.
	# Attempting to keep complex PHP out of the frontend. Mostly specific to rendering and curl calls		# Attempting to keep complex PHP out of the frontend. Mostly specific to rendering and curl calls
Line 29:		Line 29:
	## API keys will be leveraged beyond user auth. Only "blessed" UI's will be able to talk to the APIs for sensitive data		## API keys will be leveraged beyond user auth. Only "blessed" UI's will be able to talk to the APIs for sensitive data
	### Making the assumption that there could be a kiosk UI that is different than an Ops UI outside of User access levels		### Making the assumption that there could be a kiosk UI that is different than an Ops UI outside of User access levels
	# User auth is still in the ~~thinking phase~~, ~~nothing~~ implemented ~~yet.~~		### investigate support for a kiosk mode as a general user with minimal access and a long JWT timer?
			### This is still at the spitball stage, and may never get coded out
			# User auth is still at the implementation level. It does work, but has not been wired in
			## JWT implemented and works, along with userAccess levels, but need to tie into frontend
			## Initial design will likely save JWT as a cookie to keep it simple initially
			## JWT lifetime currently set at 1 hour, when live likely default to 12 hours
	# '''Kidnap or blackmail a real UX dev to get this beyond kindergarten level of UX'''		# '''Kidnap or blackmail a real UX dev to get this beyond kindergarten level of UX'''

Chubbard: /* Backend */

2023-10-12T23:31:41Z

Backend

← Older revision		Revision as of 16:31, 12 October 2023
Line 16:		Line 16:
	* JWT works		* JWT works
	* User access levels work		* User access levels work
			* Still some minor warnings to clean up due to PHP version change

	== Frontend ==		== Frontend ==

Chubbard: /* Recommendations to reproduce a minimal install */

2023-10-12T23:31:15Z

Recommendations to reproduce a minimal install

← Older revision		Revision as of 16:31, 12 October 2023
Line 92:		Line 92:
	** Debugging API can also be done via <pre> nohup php -S 0.0.0.0:8002 -t public 2>&1 >> ./logs/someLogSomewhere.log & </pre>		** Debugging API can also be done via <pre> nohup php -S 0.0.0.0:8002 -t public 2>&1 >> ./logs/someLogSomewhere.log & </pre>
	* PHP composer (only used on backend currently)		* PHP composer (only used on backend currently)
	* PHP 7.4 or greater. Testing 8.3 soonish		* PHP 8.1 or greater. Testing 8.3 soonish
	* 100 GB HDD.		* 100 GB HDD.
	* 2 Cores		* 2 Cores

Chubbard: /* Backend */

2023-10-12T23:30:05Z

Backend

← Older revision		Revision as of 16:30, 12 October 2023
Line 7:		Line 7:

	== Backend ==		== Backend ==
	The backend is PHP 7.X using the Slim4 framework.		The backend is PHP 8.X using the Slim4 framework.
	Composer is used for additional functionality, however most of the installed packages are not actually being used. These are going to have to be removed and get down to the core packages needed before posting the code publicly.		Composer is used for additional functionality, however most of the installed packages are not actually being used. These are going to have to be removed and get down to the core packages needed before posting the code publicly.
	* This is going to be migrated to PHP 8.3 as soon as reasonable to test
	* Some additional custom classes were written to simplify some tasks that were more of a pain to deal with using default classes than I liked.		* Some additional custom classes were written to simplify some tasks that were more of a pain to deal with using default classes than I liked.
	* locations: app/ templates/ src/Infrastructure/Shared/		* locations: app/ templates/ src/Infrastructure/Shared/
	* Several previously serial tasks can be changed to include functions so they can be recycled elsewhere, but that is future.		* Several previously serial tasks can be changed to include functions so they can be recycled elsewhere, but that is future.
			* apiKeys are working on the backend
			* initial testing for events require apiKey to be set as X-Api-Key in the headers for curl
			* JWT works
			* User access levels work

	== Frontend ==		== Frontend ==

Chubbard: /* Backend */

2023-08-23T21:41:21Z

Backend

← Older revision		Revision as of 14:41, 23 August 2023
Line 10:		Line 10:
	Composer is used for additional functionality, however most of the installed packages are not actually being used. These are going to have to be removed and get down to the core packages needed before posting the code publicly.		Composer is used for additional functionality, however most of the installed packages are not actually being used. These are going to have to be removed and get down to the core packages needed before posting the code publicly.
	* This is going to be migrated to PHP 8.3 as soon as reasonable to test		* This is going to be migrated to PHP 8.3 as soon as reasonable to test
	* Some additional custom classes were written to simplify some tasks that were more of a pain to deal with ~~suing~~ default classes than I liked.		* Some additional custom classes were written to simplify some tasks that were more of a pain to deal with using default classes than I liked.
	* locations: app/ templates/ src/Infrastructure/Shared/		* locations: app/ templates/ src/Infrastructure/Shared/
	* Several previously serial tasks can be changed to include functions so they can be recycled elsewhere, but that is future.		* Several previously serial tasks can be changed to include functions so they can be recycled elsewhere, but that is future.

Chubbard: /* Backend */

2023-07-14T21:56:49Z

Backend

← Older revision		Revision as of 14:56, 14 July 2023
Line 10:		Line 10:
	Composer is used for additional functionality, however most of the installed packages are not actually being used. These are going to have to be removed and get down to the core packages needed before posting the code publicly.		Composer is used for additional functionality, however most of the installed packages are not actually being used. These are going to have to be removed and get down to the core packages needed before posting the code publicly.
	* This is going to be migrated to PHP 8.3 as soon as reasonable to test		* This is going to be migrated to PHP 8.3 as soon as reasonable to test
			* Some additional custom classes were written to simplify some tasks that were more of a pain to deal with suing default classes than I liked.
			* locations: app/ templates/ src/Infrastructure/Shared/
			* Several previously serial tasks can be changed to include functions so they can be recycled elsewhere, but that is future.

	== Frontend ==		== Frontend ==

Chubbard: /* Metrics */

2023-07-14T21:53:05Z

Metrics

← Older revision		Revision as of 14:53, 14 July 2023
Line 44:		Line 44:
	# Graphite is running on 4core, 4GB RAM, 100GB drive KVM Guest with other apps running on it. Initially my thought was to use Graphite as the main graph engine, but thinking about small business, as well as being able to do future predictions I felt RRD was the best way to start this, and have Graphite supported but not the default graph engine.		# Graphite is running on 4core, 4GB RAM, 100GB drive KVM Guest with other apps running on it. Initially my thought was to use Graphite as the main graph engine, but thinking about small business, as well as being able to do future predictions I felt RRD was the best way to start this, and have Graphite supported but not the default graph engine.
	## The graphite support I have in place currently is going to have to be redone in the "template"style so that adhoc stuff can be more easily added in the future. right now it is a series of regexes and database hacks that I am not happy with.		## The graphite support I have in place currently is going to have to be redone in the "template"style so that adhoc stuff can be more easily added in the future. right now it is a series of regexes and database hacks that I am not happy with.
			# Beginning storage of application metric data as well to get a sense of devices >> service check load and latency for scaling
			# Reporting of application metrics will have to be baked in as a default report.

	== Templates ==		== Templates ==

Chubbard: /* Recommendations to reproduce a minimal install */

2023-07-14T21:49:18Z

Recommendations to reproduce a minimal install

← Older revision		Revision as of 14:49, 14 July 2023
Line 90:		Line 90:
	* Write notes on oddball changes to php.ini, and php packages installed via apt.		* Write notes on oddball changes to php.ini, and php packages installed via apt.
	** libapache2-mod-php7.4 php7.4 php7.4-cli php7.4-common php7.4-curl php7.4-fpm php7.4-gd php7.4-gmp php7.4-intl php7.4-json php7.4-mbstring php7.4-mysql php7.4-opcache php7.4-readline php7.4-rrd php7.4-snmp php7.4-xml php7.4-zip		** libapache2-mod-php7.4 php7.4 php7.4-cli php7.4-common php7.4-curl php7.4-fpm php7.4-gd php7.4-gmp php7.4-intl php7.4-json php7.4-mbstring php7.4-mysql php7.4-opcache php7.4-readline php7.4-rrd php7.4-snmp php7.4-xml php7.4-zip
			** some packages not used currently like SNMP and XML, but may be used in the future.
	* no Pecl used		* no Pecl used

Chubbard at 21:47, 14 July 2023

2023-07-14T21:47:55Z

@@ Line 65: / Line 65: @@
 * Also I FIRMLY believe if a machine is doing something a human MUST be able to duplicate the behavior.  Using shell commands makes this easier to work with.
 ** If a human cannot duplicate an event or failure, then you are guessing that it is legit.  Always have a way to confirm "truth" whenever possible.
 [[Category:NMS]]