Enportal/5.5/admin/enPortal installation/backup and recovery - Revision history

imported>Jason.nicholls: /* Loading Backups (archives) */

2015-04-07T09:14:46Z

Loading Backups (archives)

← Older revision		Revision as of 09:14, 7 April 2015
Line 96:		Line 96:
	# in a terminal, change into the <tt>[INSTALL_HOME]/server/bin</tt> directory		# in a terminal, change into the <tt>[INSTALL_HOME]/server/bin</tt> directory
	# run: <tt>portal ''<Load_Type>'' -jar ''<backup_archive.jar>''</tt>		# run: <tt>portal ''<Load_Type>'' -jar ''<backup_archive.jar>''</tt>
	# (Linux / UNIX) re-run <tt>post_install.sh</tt><br>This is required to ensure correct ownership, permissions, and any included scripts are set executable as jar archives do not store this information.		# (Linux / UNIX) re-run <tt>post_install.sh</tt><br>This is required to ensure correct system configuration and file ownership, permissions, and any included scripts are set executable as jar archives do not store this information.
	# start enPortal		# start enPortal

imported>Jason.nicholls: /* Loading Backups (archives) */

2015-04-07T09:13:09Z

Loading Backups (archives)

← Older revision		Revision as of 09:13, 7 April 2015
Line 96:		Line 96:
	# in a terminal, change into the <tt>[INSTALL_HOME]/server/bin</tt> directory		# in a terminal, change into the <tt>[INSTALL_HOME]/server/bin</tt> directory
	# run: <tt>portal ''<Load_Type>'' -jar ''<backup_archive.jar>''</tt>		# run: <tt>portal ''<Load_Type>'' -jar ''<backup_archive.jar>''</tt>
	# (Linux / UNIX) re-run <tt>post_install.sh</tt>		# (Linux / UNIX) re-run <tt>post_install.sh</tt><br>This is required to ensure correct ownership, permissions, and any included scripts are set executable as jar archives do not store this information.
	# start enPortal		# start enPortal

imported>Jason.nicholls: /* Customizing the Export */

2014-11-17T09:07:59Z

Customizing the Export

← Older revision		Revision as of 09:07, 17 November 2014
Line 55:		Line 55:
	Recommended best practice is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.		Recommended best practice is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.

	This file can be used for various overrides so it may exist for other purposes already. The key part is to define an <tt>export.custom.other</tt> property with a list of rules defining the ~~exported~~ files. This is a semi-colon (<tt>;</tt>) separated list, with the backslash character (<tt>\</tt>) used to split the list over multiple lines to improve readability. For example:		This file can be used for various overrides so it may exist for other purposes already. The key part is to define an <tt>export.custom.other</tt> property with a list of rules defining the files to export. This is a semi-colon (<tt>;</tt>) separated list, with the backslash character (<tt>\</tt>) used to split the list over multiple lines to improve readability. For example:

	<pre>		<pre>

imported>Jason.nicholls: /* Customizing the Export */

2014-11-17T09:06:52Z

Customizing the Export

← Older revision		Revision as of 09:06, 17 November 2014
Line 55:		Line 55:
	Recommended best practice is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.		Recommended best practice is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.

	This file can be used for various overrides so it may exist for other purposes already. The key part is to define an <tt>export.custom.other</tt> property with ~~the~~ list of rules defining the ~~export list~~. This is a semi-colon (<tt>;</tt>) separated list, with the backslash character (<tt>\</tt>) used to split the list over multiple lines to improve readability. For example:		This file can be used for various overrides so it may exist for other purposes already. The key part is to define an <tt>export.custom.other</tt> property with a list of rules defining the exported files. This is a semi-colon (<tt>;</tt>) separated list, with the backslash character (<tt>\</tt>) used to split the list over multiple lines to improve readability. For example:

	<pre>		<pre>

imported>Jason.nicholls: /* Customizing the Export */

2014-11-17T09:05:46Z

Customizing the Export

← Older revision		Revision as of 09:05, 17 November 2014
Line 55:		Line 55:
	Recommended best practice is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.		Recommended best practice is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.

	This file can be used for various overrides so it may exist for other purposes already. The key part is to define an <tt>export.custom.other</tt> property with the list of rules defining the export list, ~~for~~ example:		This file can be used for various overrides so it may exist for other purposes already. The key part is to define an <tt>export.custom.other</tt> property with the list of rules defining the export list. This is a semi-colon (<tt>;</tt>) separated list, with the backslash character (<tt>\</tt>) used to split the list over multiple lines to improve readability. For example:

	<pre>		<pre>
Line 68:		Line 68:
	In this example a DB driver, a icon registry file, a custom graphic, and the <tt>test_dir</tt> are specific paths to be exported. The last example specifies a path and file expression so that only files ending with <tt>.png</tt> are included.		In this example a DB driver, a icon registry file, a custom graphic, and the <tt>test_dir</tt> are specific paths to be exported. The last example specifies a path and file expression so that only files ending with <tt>.png</tt> are included.

	The ~~full~~ export rule ~~format~~ is noted below. The initial <tt>Path</tt> is not a regular expression and must match exactly a single file or directory. <tt>PathExpression</tt> and <tt>FileExpression</tt> are ''regular expressions'', not wildcards. The use of the <tt>exclude</tt> keyword is optional and implies the preceding expression should be excluded.		The format for each export rule is noted below. The initial <tt>Path</tt> is not a regular expression and must match exactly a single file or directory. <tt>PathExpression</tt> and <tt>FileExpression</tt> are ''regular expressions'', not wildcards. The use of the <tt>exclude</tt> keyword is optional and implies the preceding expression should be excluded.

	<pre>		<pre>

imported>Jason.nicholls: /* Customizing the Export */

2014-11-17T08:59:01Z

Customizing the Export

← Older revision		Revision as of 08:59, 17 November 2014
Line 55:		Line 55:
	Recommended best practice is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.		Recommended best practice is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.

	This file can be used for various overrides so it may exist for other purposes already. The key part is to define an <tt>export.custom.other</tt> property with the list of ~~files to be exported~~, so for example:		This file can be used for various overrides so it may exist for other purposes already. The key part is to define an <tt>export.custom.other</tt> property with the list of rules defining the export list, for example:

	<pre>		<pre>

imported>Jason.nicholls: /* Customizing the Export */

2014-11-17T08:57:38Z

Customizing the Export

← Older revision		Revision as of 08:57, 17 November 2014
Line 59:		Line 59:
	<pre>		<pre>
	# below is a list of additional files to export on a full backup		# below is a list of additional files to export on a full backup
	export.custom.other=${webapp.webinf}/lib/mysql-connector-java-5.1.~~19.jar;\~~		export.custom.other=${webapp.webinf}/lib/mysql-connector-java-5.1.34.jar;\
	~~${webapp.webinf}/lib/jtds-1.2.4~~.jar;\
	${webapp.xmlroot}/appboard/config/iconregistry/custom_icons.csv;\		${webapp.xmlroot}/appboard/config/iconregistry/custom_icons.csv;\
	${webapp.home}/visualizer/assets/images/custom_banner_logo.png;		${webapp.home}/visualizer/assets/images/custom_banner_logo.png;\
			${webapp.webinf}/test_dir;\
			${webapp.webinf}/image_dir,,,.*\.png
	</pre>		</pre>

	In this example ~~two~~ DB driver ~~files~~, a icon registry file, ~~and~~ a custom graphic ~~will~~ be included ~~in the export~~.		In this example a DB driver, a icon registry file, a custom graphic, and the <tt>test_dir</tt> are specific paths to be exported. The last example specifies a path and file expression so that only files ending with <tt>.png</tt> are included.

	~~To verify~~ the ~~export contains~~ the ~~files~~, perform a backup and ~~simply~~ unzip the ~~file~~ to ~~inspect (or rename~~ to <tt>.zip</tt>).		The full export rule format is noted below. The initial <tt>Path</tt> is not a regular expression and must match exactly a single file or directory. <tt>PathExpression</tt> and <tt>FileExpression</tt> are ''regular expressions'', not wildcards. The use of the <tt>exclude</tt> keyword is optional and implies the preceding expression should be excluded.

			<pre>
			<Path>,<PathExpression>,exclude,<FileExpression>,exclude,<FileExpression>,exclude,...
			</pre>


			After making changes to the set of excludes perform a backup and verify the resulting (.jar) archive contains the desired set of files. The archive can be uncompressed using unzip, depending on the unzip tool it may need to be renamed to end with <tt>.zip</tt>.

	=== Unattended Backups ===		=== Unattended Backups ===

imported>Jason.nicholls: /* Loading Backups (archives) */

2014-11-06T06:26:57Z

Loading Backups (archives)

← Older revision		Revision as of 06:26, 6 November 2014
Line 78:		Line 78:
	Loading backup archives is completed on the command line and the enPortal server must be shutdown beforehand.		Loading backup archives is completed on the command line and the enPortal server must be shutdown beforehand.
	Before proceeding with loading a backup, please be aware that this process is disruptive and will replace the existing configuration. For example, loading a ''Backup All'' archive will replace all existing enPortal and AppBoard content and configuration settings.		Before proceeding with loading a backup, please be aware that this process is disruptive and will replace the existing configuration. For example, loading a ''Backup All'' archive will replace all existing enPortal and AppBoard content and configuration settings.


			{{Warning\|Loading archives created from a newer version of enPortal onto an older version of enPortal is '''not supported'''. While it may be ''possible'' to load the archive it may lead to unknown configuration issues.}}


	To load an archive:		To load an archive:
Line 111:		Line 115:
	# Rename <tt>load-restore.txt.disabled</tt> to <tt>load-restore.txt</tt>.		# Rename <tt>load-restore.txt.disabled</tt> to <tt>load-restore.txt</tt>.
	# Start AppBoard.		# Start AppBoard.


	== Troubleshooting ==		== Troubleshooting ==

imported>David.moore: /* Creating Backups */

2014-08-06T16:14:17Z

Creating Backups

← Older revision		Revision as of 16:14, 6 August 2014
Line 22:		Line 22:
	To create backups, hover your mouse over the '''Advanced''' tab and select the ''Backup'' option.		To create backups, hover your mouse over the '''Advanced''' tab and select the ''Backup'' option.

	[[File:enportal-5.4-backup.png\|frame\|Advanced -> Backup]]		[[File:enportal-5.5-backup.png\|frame\|Advanced -> Backup]]


Line 74:		Line 74:

	<tt>/enportal/servlet/pd/vdir/home/role/portalAdministration/Menu/Admin/Advanced/Backup?requestType=execute&Submit=true</tt>		<tt>/enportal/servlet/pd/vdir/home/role/portalAdministration/Menu/Admin/Advanced/Backup?requestType=execute&Submit=true</tt>


	== Loading Backups (archives) ==		== Loading Backups (archives) ==

imported>Jason.nicholls at 12:43, 20 July 2014

2014-07-20T12:43:55Z

← Older revision		Revision as of 12:43, 20 July 2014
Line 1:		Line 1:
	[[Category:enPortal 5.5]]		[[Category:enPortal 5.5]]
	{{DISPLAYTITLE:enPortal Backup & Recovery}}		{{DISPLAYTITLE:enPortal Backup & Recovery}}
			==Overview==
	A typical enPortal deployment will consist of:		A typical enPortal deployment will consist of:

Line 6:		Line 7:
	# custom assets on the file system such as configuration files.		# custom assets on the file system such as configuration files.
	# external supporting pieces required for operation but not strictly part of enPortal.		# external supporting pieces required for operation but not strictly part of enPortal.
	~~<br>~~

	enPortal provides a configurable export system which will automatically capture all system configuration (1) and much of the custom assets (2). If custom assets are not captured then the export configuration can be modified to include them which would be considered a deployment best practice. Exporting the external supporting pieces (3) is beyond the scope of the product itself but should be considered from an overall perspective.		enPortal provides a configurable export system which will automatically capture all system configuration (1) and much of the custom assets (2). If custom assets are not captured then the export configuration can be modified to include them which would be considered a deployment best practice. Exporting the external supporting pieces (3) is beyond the scope of the product itself but should be considered from an overall perspective.
	~~<br>~~
	The reasons for performing backups are:		The reasons for performing backups are:

Line 16:		Line 16:
	* use a backup when upgrading enPortal itself.		* use a backup when upgrading enPortal itself.
	* provide a way for Edge to further investigate support issues - a backup archive may be requested.		* provide a way for Edge to further investigate support issues - a backup archive may be requested.
	~~<br>~~


Line 22:		Line 21:

	To create backups, hover your mouse over the '''Advanced''' tab and select the ''Backup'' option.		To create backups, hover your mouse over the '''Advanced''' tab and select the ''Backup'' option.
	~~<br>~~
	[[File:~~Enp5_4AdvMenu~~.~~PNG~~\|~~center\|1400px~~\|Backup ~~page~~]]		[[File:enportal-5.4-backup.png\|frame\|Advanced -> Backup]]
	~~<br>~~

	The Backup page allows the user to create new backups, and download or delete existing backups on the server file system.		The Backup page allows the user to create new backups, and download or delete existing backups on the server file system.
Line 31:		Line 30:

	=== Backup Options ===		=== Backup Options ===
	~~<br>~~		{\|class="wikitable"
	{\|class="wikitable~~" border="1" style="background-color:#eeeeee;~~"
	! Backup Type		! Backup Type
	! Description		! Description
Line 45:		Line 43:
	\| This is a special purpose backup that will export most server configuration and all enPortal configuration.		\| This is a special purpose backup that will export most server configuration and all enPortal configuration.
	\|}		\|}

	*''Backup AppBoard'' Option		*''Backup AppBoard'' Option
	The ''Backup AppBoard'' option backs up only AppBoard components, specifically: Stacks, Data Collections, and Data Sources. Everything else including server configuration, users, domains, roles, stack assignment, managed variables, and all enPortal specific custom export properties are '''not backed up'''.		The ''Backup AppBoard'' option backs up only AppBoard components, specifically: Stacks, Data Collections, and Data Sources. Everything else including server configuration, users, domains, roles, stack assignment, managed variables, and all enPortal specific custom export properties are '''not backed up'''.
Line 54:		Line 51:
	*''Backup Portal'' Option		*''Backup Portal'' Option
	Use the ''Backup Portal'' option to export all enPortal configuration in addition to most of the server configuration.		Use the ''Backup Portal'' option to export all enPortal configuration in addition to most of the server configuration.


	=== Customizing the Export ===		=== Customizing the Export ===

	Recommended best practice is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.		Recommended best practice is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied ''custom'' directories. Some files fall outside this pattern however and to handle these it's necessary to customize the export file set by creating a <tt>custom.properties</tt> file and placing it into the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt> directory.

Line 75:		Line 70:

	=== Unattended Backups ===		=== Unattended Backups ===

	The backup mechanism is only accessible via the web interface.		The backup mechanism is only accessible via the web interface.
	To perform an unattended backup, create a custom script to authenticate and call the following URL to generate the backup (example below calls the ''Backup All'' option):		To perform an unattended backup, create a custom script to authenticate and call the following URL to generate the backup (example below calls the ''Backup All'' option):

	<tt>/enportal/servlet/pd/vdir/home/role/portalAdministration/Menu/Admin/Advanced/Backup?requestType=execute&Submit=true</tt>		<tt>/enportal/servlet/pd/vdir/home/role/portalAdministration/Menu/Admin/Advanced/Backup?requestType=execute&Submit=true</tt>


	== Loading Backups (archives) ==		== Loading Backups (archives) ==

	Loading backup archives is completed on the command line and the enPortal server must be shutdown beforehand.		Loading backup archives is completed on the command line and the enPortal server must be shutdown beforehand.
	Before proceeding with loading a backup, please be aware that this process is disruptive and will replace the existing configuration. For example, loading a ''Backup All'' archive will replace all existing enPortal and AppBoard content and configuration settings.		Before proceeding with loading a backup, please be aware that this process is disruptive and will replace the existing configuration. For example, loading a ''Backup All'' archive will replace all existing enPortal and AppBoard content and configuration settings.
Line 93:		Line 87:
	# (Linux / UNIX) re-run <tt>post_install.sh</tt>		# (Linux / UNIX) re-run <tt>post_install.sh</tt>
	# start enPortal		# start enPortal
	~~<br>~~

	The applicable Load Types are defined below:		The applicable Load Types are defined below:

	{\|class="wikitable~~" border="1" style="background-color:#eeeeee;~~"		{\|class="wikitable"
	!Load Type		!Load Type
	!Description		!Description
Line 119:		Line 112:
	# Rename <tt>load-restore.txt.disabled</tt> to <tt>load-restore.txt</tt>.		# Rename <tt>load-restore.txt.disabled</tt> to <tt>load-restore.txt</tt>.
	# Start AppBoard.		# Start AppBoard.


	== Troubleshooting ==		== Troubleshooting ==
	~~<br>~~		{\|class="wikitable"
	{\|class="wikitable~~" border="1" style="background-color:#eeeeee;~~"
	!Issue		!Issue
	!Possible Causes		!Possible Causes