7.6. SGD Installations

This section describes the files that are included in an SGD installation. Information on backing up and restoring your SGD installation is also included.

This section includes the following topics:

7.6.1. About Your SGD Installation

The standard installation directory for SGD is /opt/tarantella.

During SGD installation, you have the option of specifying a different installation directory.

You can find out your installation directory from the command line, as follows:

  • Oracle Solaris platforms. Use the command:

    $ pkgparam `pkginfo 'tta.*' | cut -d' ' -f2` INSTDIR
  • Linux system platforms. Use the command:

    $ rpm -qi tta | grep Relocations

The SGD installation directory contains the following subdirectories:

  • bin

  • etc

  • lib

  • var

  • webserver

The following sections describe the contents of each of these subdirectories, and what each subdirectory is used for.

See also Section 7.6.2, “Backing Up and Restoring an SGD Installation”.

7.6.1.1. bin Directory

The bin directory contains the scripts, binaries, and server-side Java technology needed to run SGD.

7.6.1.2. etc Directory

The etc directory contains configuration files that control the behavior of SGD and applications displayed through SGD. It contains the subdirectories listed in the following table.

Subdirectory

Contents

etc/data

The following configuration files:

  • Character application object configuration files:

    • Attribute maps (attrmap.txt)

    • Color maps (colormap.txt)

  • Printing configuration files:

    • Host name maps (hostnamemap.txt)

    • Printer driver maps (default.printerinfo.txt)

    • Printer driver to printer type mappings (printertypes.txt)

    • Printer to user-friendly name mappings (printernamemap.txt)

  • Timezone configuration files

  • Supported CA certificates (cacerts.txt)

etc/data/share/X11/xkb

etc/data/keymaps

XKB implementation files.

Keyboard map files for terminal emulators.

etc/data/share/fonts/X11

etc/fonts

X Window System fonts and additional fonts installed with SGD.

etc/pkg

Information about installed SGD packages, for example version compatibility and dependencies.

etc/templates

A complete copy of the standard files that are installed in the etc/data directory and the var/serverresources directory.

7.6.1.3. lib Directory

The lib directory contains shared libraries used by the SGD server and shared libraries that you might need when installing the SGD Client on certain platforms.

7.6.1.4. var Directory

The var directory contains the files that are used by the web server and the files that the SGD server copies to other members of the array. The var directory contains many subdirectories, and the important ones are listed in the following table.

Subdirectory

Contents

var/docroot

The HTML pages used by the SGD web server.

var/tsp

Server SSL certificates, keys, and CA certificates.

var/ens

The local repository, containing the objects in the organizational hierarchy.

var/log

SGD server log files.

var/print

The print queue and First In First Out (FIFO).

var/serverresources/expect

SGD login scripts.

var/spool

Files on their way to the print queue.

7.6.1.5. webserver Directory

The webserver directory contains the scripts, binaries, and server-side Java technology needed to run the SGD web server, web services, and the webtop. The important subdirectories are listed in the following table.

Subdirectory

Contents

apache

All the files needed to configure and run the SGD web server.

tomcat

All the files needed to configure and run the Tomcat JSP technology and Java Servlet extension servlet container.

tomcat/tomcat-version/webapps/axis

Files needed to run SGD web services. The webtop uses web services.

tomcat/tomcat-version/webapps/sgd

Files needed to run the webtop, including the SGD Client.

tomcat/tomcat-version/shared/lib

tomcat/tomcat-version/shared/classes

7.6.2. Backing Up and Restoring an SGD Installation

This section describes how to back up an SGD installation, so that you can repair SGD in the event that a component or an entire installation becomes damaged.

Before using the procedures on this page, it is helpful if you are familiar with the layout of the SGD installation. See Section 7.6.1, “About Your SGD Installation”.

This section includes the following topics:

7.6.2.1. How to Make a Full Backup of an SGD Installation

To be able to restore an SGD installation or to be able to repair some individual SGD components, you need a full backup.

While making the backup, do not run any command-line tools or use the Administration Console.

  1. Log on as superuser (root) on the SGD host.

  2. (Optional) Stop the SGD server.

    It is best if you stop the SGD server while making the backup. However, if this is not possible, do the backup when the server is least loaded.

  3. Back up the SGD log files.

    # tarantella archive
  4. Back up the entire SGD installation directory on each SGD server in the array.

    Use the cpio command. Some long file names used in SGD may cause problems with other backup utilities, such as tar.

    See Section 7.6.1, “About Your SGD Installation” for details of the SGD installation directory.

    SGD also uses the following configuration files, which only need to be backed up if you are using them and you have modified them:

    • The /etc/ttaprinter.conf file – This file contains the lpr defaults

    • The /etc/sdace.txt and /var/ace/data files – These files contain RSA SecurID settings

    • Web server password files – If you have created these files for use with the SGD web server, and they are stored outside the SGD installation directory

  5. Verify the backup.

    Restore an archived SGD backup, to verify that the backup process works correctly. This is described in Section 7.6.2.2, “How to Do a Full Restore of an SGD Installation”.

7.6.2.2. How to Do a Full Restore of an SGD Installation

If you are unable to restore a damaged SGD component or you are unsure about the extent of the damage to your system, you must do a full restore of your SGD installation.

To do a full restore, you must have a full backup. See Section 7.6.2.1, “How to Make a Full Backup of an SGD Installation” for details of how to back up an SGD installation.

Ensure that no users are logged in to the SGD server, and that there are no application sessions, including suspended application sessions, running on the SGD server.

  1. Log on as superuser (root) on the SGD host.

  2. Stop the SGD server.

  3. Uninstall SGD.

    # tarantella uninstall --purge
    Note

    If this fails, you might have to manually remove the SGD package. Use the rpm -e tta command on Linux platforms, and the pkgrm tta command on Oracle Solaris platforms.

  4. Delete the SGD installation directory.

    # rm -rf /opt/tarantella
  5. Reinstall SGD and any patches, if applicable.

    This installs the printer queue, rc scripts and package database.

  6. Stop the SGD server.

  7. Delete the SGD installation directory.

    # rm -rf /opt/tarantella
  8. Reinstate the SGD installation from the backup.

    Note

    Make sure you restore from the server's backup. Also, check that the DNS name of the host has not changed.

  9. Restart the SGD server.

7.6.2.3. Restoring a Damaged SGD Component

For the purposes of restoring a damaged installation, SGD can be divided up into the following components:

  • Binaries, scripts, and template files

  • Login scripts

  • Server configuration

  • Global configuration

  • The local repository

  • Automatic log archives

  • SGD printing

  • The SGD web server, web services, and the webtop

The following sections describe how to back up each of these components.

7.6.2.3.1. Binaries, Scripts, and Template Files

The binaries, scripts, and template files are only modified as part of an installation, patch, or custom engineering work. These files do not change very often.

You can restore these files from a backup or another installation, as follows:

  • The binaries are in the /opt/tarantella/bin/bin directory

  • The scripts are in the /opt/tarantella/bin/scripts directory

  • The template files are in the /opt/tarantella/etc/templates directory

7.6.2.3.2. Login Scripts

The Login Scripts control the interaction between SGD and the application servers, for example, by logging a user in.

How you recover login scripts depends on whether or not you are using customized login scripts.

If you are not using customized login scripts, you can restore these files from another installation, a backup, or from the /opt/tarantella/etc/templates directory.

If you are using customized login scripts, you must only restore these files from a backup.

The login scripts are in the /opt/tarantella/var/serverresources/expect directory.

7.6.2.3.3. Server Configuration

Server configuration covers all the properties for an SGD server that are not shared with the other SGD servers in the array, such as the server DNS name and server tuning.

As this configuration is unique to a particular SGD host, it must only be restored from a backup taken from that host.

The server-specific configuration is in the /opt/tarantella/var/serverconfig/local directory.

If you are using SGD security services, you must also restore the following:

  • /opt/tarantella/var/tsp

  • /opt/tarantella/var/info/certs

  • /opt/tarantella/var/info/key

7.6.2.3.4. Global Configuration

Global configuration covers all the properties that are the same for all the SGD servers in the array, for example the names of the other array members.

To restore the global configuration for an SGD server, you must only restore from a backup of the primary SGD server.

The global configuration is in the /opt/tarantella/var/serverconfig/global directory.

7.6.2.3.5. The Local Repository

The local repository, formerly called the Enterprise Naming Scheme (ENS) datastore, is shared across all SGD servers in the array. This is the organizational hierarchy that contains all the information about users, applications, and application servers. This information changes very often.

Restore the local repository from the backup of the primary SGD server.

The local repository is in the /opt/tarantella/var/ens directory.

7.6.2.3.6. Automatic Log Archives

By default, SGD archives its log files each week at 3 a.m. on Sunday, using a cron job.

If the root user's crontab becomes corrupt, or the archiving does not take place, use the tarantella setup command to restore the default setting, or to change the time and day that the archiving takes place.

The log files are archived in the /opt/tarantella/var/log directory.

7.6.2.3.7. SGD Printing

When you install SGD, it configures an SGD printer queue.

If the printer queue is not present, you can restore it using either of the following methods:

The printer queue is in the /opt/tarantella/var/print directory.

7.6.2.3.8. SGD Web Server, Web Services, and the Webtop

The configuration of the SGD web server, SGD web services, and the webtop is unique to a particular SGD host and must only be restored from a backup taken from that host.

The configuration for the SGD web server is in the /opt/tarantella/webserver/apache/apache-version directory. You might also have web server password files, which can be stored in other locations.

The configuration for SGD web services is in the /opt/tarantella/webserver/tomcat/tomcat-version directory.

The files used for the webtop are in the /opt/tarantella/webserver/tomcat/tomcat-version/webapps/sgd directory.