FS
Documentation

Duty3G/Duty3G 5.1 Release Notes

This page was last modified 00:55, 17 August 2007.

From Documentation

< Duty3G(Difference between revisions)
Jump to: navigation, search
Revision as of 09:08, 20 September 2006
Moff (Talk | contribs)
(Features)
← Previous diff
Current revision
Moff (Talk | contribs)
(Schedules and Schedtime)
Line 3: Line 3:
==== Duty3G ==== ==== Duty3G ====
-Duty3G V5.1 is a job control and batch job scheduling application that provides network-wide job execution with comprehensive inter-task dependencies. It can manage the entire production control of your Data Center. You use COStask to:•submit or schedule pre-defined jobs•manage running jobs (hold/release/kill etc.)•monitor job output•handle and recover from error conditions.+[[Duty3G]] 5.1 encourages sound management practices by making it possible to perform the regular operations workload on UNIX, Linux and Windows servers in a way that is efficient, reliable, verifiable, compliant, and repeatable whilst protecting privileged user access. With duty3G you define the command or commands that carry out a process, you assign the privilege to the duty, and then assign the duty to the user.
<br> <br>
-==== New features in Duty3G V5.1 ====+ 
 +==== New features in duty3G 5.1 ====
Key features of the new release are: Key features of the new release are:
Line 12: Line 13:
'''Enhanced operations''' '''Enhanced operations'''
-*Enhanced schedules, for example, a Weekday schedule can now exclude public holidays.+*Enhanced schedules, for example, a Weekday schedule can exclude public holidays and end of month.
-*You can now assign duties to a class/folder, so the duty name no longer needs to be prefixed with a Class or Category. Now it is much easier to locate that ‘XYZ’ duty.+*Duties may be assigned to a ''duty list''. Duty lists are a way of grouping similar duties together, or a way of creating a ''to-do' type list.
-*You can now order duties in the order they should be performed, so the duty name no longer needs to be prefixed with a Sequence number+*Duties within a ''duty list'' can be placed in the order they should be performed.
-*You can now force the user to re-authenticate before running certain duties giving added security.+*A user can be requested to re-authenticate before running certain duties giving added security.
-*Duties can now be auto disabled and/or auto re-enabled on given dates. This is useful during system rollouts or migration projects.+*Duties can be auto disabled and/or auto re-enabled on given dates. This is useful during system roll-outs or migration projects.
-*Duties are now run asynchronously, meaning if you have a long running duty it no longer stops you from running another duty.+*A duty is run asynchronously, meaning if you have a long running duty, you can still run other duties.
-*As a duty is performed, that duty is now “locked” so no other user can run the same duty with possible undesirable results.+*As a duty is performed, that duty is now ''locked'' so no other user can run the same duty with possible undesirable results.
-*End user's can set their own start-up view (at-request or outstanding duties) and start-up Class, along with a reminder period before duties become overdue.+*End user's can set their own default start-up view (at-request or outstanding duties) and start-up ''duty list'', along with a reminder period before duties become overdue.
-*End user’s can now view upcoming scheduled duties for a selected day or date in the future – “What has to be done on Friday?”. This is also useful for Administrators to check that duties have been scheduled correctly, for example, making sure certain duties are not scheduled for Christmas Day.+*Upcoming scheduled duties for a selected day or date in the future can be viewed – “What has to be done on Friday?”. This is also useful for Administrators to check that duties have been scheduled correctly, for example, making sure certain duties are not scheduled for Christmas Day.
-*You can now filter your view of duties:+*You can filter your view of duties:
-:*for a selected class+:*for a selected duty list
:*that run on a selected host :*that run on a selected host
-:*for a selected users' role+:*for a selected users' role.
 +*The ''run'' history of a selected duty can be viewed over various date periods.
'''Improved auditing''' '''Improved auditing'''
Line 35: Line 37:
:*for selected mode :*for selected mode
*Duty audit trail entries are now colour coded to make it easier to spot abnormal entries. *Duty audit trail entries are now colour coded to make it easier to spot abnormal entries.
-*New duty compliance reports are generated daily and can be viewed at any time. These reports highlight failed, missed and skipped duties – exceptions that affect operations compliance. +*Duty compliance reports are generated daily and can be viewed at any time. These reports highlight failed, missed and skipped duties – exceptions that affect operations compliance.
'''Documentation''' '''Documentation'''
-*An HTML or text document can now be associated with a duty, so end users can see what Policies and Procedures the duty is supporting.+*A HTML or text document can be associated with a duty, so end users can see what Policies and Procedures the duty is supporting.
-*You can now link directly to online help (user guide), release notes and other documentation, and even report a bug via duty3G+*The user guide, release notes and other documentation can be viewed via your favourite browser.
<br> <br>
 +
== Installation Requirements == == Installation Requirements ==
==== Software prerequisites ==== ==== Software prerequisites ====
-To install and run Duty3G V5.1 on a host, you must have:+To [[Duty3G/User Guide/Appendix A — Installing duty3G#Installing duty3G | install]] and run duty3G 5.1 on a host, you must have:
-*COSmanager V4.2.5 or later already installed on the host (see the [[COSmanager/User Guide | COSmanager User Guide]] for instructions)+*COSmanager 4.2.5 or newer already installed on the host (see the [[COSmanager/User Guide | COSmanager User Guide]] for instructions)
*a [http://downloads.fs.com.au/index.php?prod=DTY duty3G distribution] *a [http://downloads.fs.com.au/index.php?prod=DTY duty3G distribution]
*a valid license key for this host (see your COSmanager distributor if you don’t have a valid license key) *a valid license key for this host (see your COSmanager distributor if you don’t have a valid license key)
-*sufficient [[disk space]]+*sufficient [[#Disk space required | disk space]]
*COSmanager Manager access, or equivalent *COSmanager Manager access, or equivalent
*the ability to open a root shell *the ability to open a root shell
 +
 +<br>
==== Disk space required ==== ==== Disk space required ====
-Running Remote Tasks on Windows/NTThe current COStask release supports running remote tasks on NT hosts which have the EBC (Enterprise Backup Client) V2.1 installed. This product may be purchased separately. Functional Software is likely to release an NT agent specially for COStask in the near future.+{| border="0" cellpadding="6" cellspacing="0"
 +! align="right" valign="top" width="150" | Software
 +| Approximately 1 MB in the duty3G home directory.
 +|-
 +! align="right" valign="top" | Temporary Files
 +| While installing duty3G: less than 1 MB, to hold a copy of the software distribution.<br>While duty3G is running: less than 1 MB in /tmp.
 +|-
 +! align="right" valign="top" | Audit Trail
 +| For the duty3G audit trail, about 10 - 50 MB in the system spool area. The actual amount will depend on the activity on your system (e.g. how many duties are run), and how often you archive and delete the log files.
 +|-
 +! align="right" valign="top" | Compliance Reports
 +| For the duty3G compliance reports, about 5 - 20 MB in the system spool area.
 +|}
 + 
 +<br>
 +==== Running Remote Duties on Windows ====
 + 
 +The current duty3G release supports running remote duties on Windows hosts which have the [[Backup3G/User Guide/EWC | EWC]] (Enterprise Windows Client) 3.1.1 installed. This product may be purchased separately.
 + 
 +<br>
 + 
 +== Upgrading COSduty 3.0 ==
 +[[Image:Duty upg install.png|frame|Figure 1 — Installation messages—upgrading from COSduty 3.0]]
 + 
 +#[http://downloads.fs.com.au/index.php?prod=DTY Download the distribution file] to <code>/tmp</code> on the target host.
 +#From the Configuration menu, select {{cnav| COSmanager configuration | Applications}}.
 +#Select {{cnav| Application | Install}}.
 +#Press Choose. You will see a list of the applications that can be installed. Choose the entry titled Duty3G 5.1, and press Accept.
 +#COSmanager copies the duty3G files from the distribution file to the target directory, updates the duty3G audit trail and creates the duty3g compliance report directory.
 +#To migrate your existing COSduty 3.0 database to the newly installed version press Copy. Your existing database is copied and updated with new table columns.
 +#To make the newly installed duty3G the default version press Accept, then press Continue.
 + 
 +:Any automatic duties are added or re-added to the ''cosmos'' crontab.
 + 
 +:This completes the upgrade installation. You must now restart COSmanager for the new version of duty3G to come into affect.
 + 
 +<br>
 + 
 +== Technical Notes: Using duty3G 5.1 ==
 + 
 +This section contains some technical notes and tips about using duty3G 5.1.
 + 
 +<br>
 +==== Temporary or trial licensing ====
 + 
 +Duty3G may be issued with a temporary license for use in trials or demonstrations. Temporary licenses have an in-built expiry date. You must obtain a permanent license or a new temporary license from your COSmanager distributor to keep using duty3G after the expiry date.
 + 
 +:{{Note|Duty3G won’t install if the license key is due to expire within the next 7 days. In this case you will need to obtain a new license key from your COSmanager distributor.}}
 + 
 +<br>
 + 
 +==== COSmanager framework version required for duty3G 5.1 ====
 + 
 +Duty3G 5.1 requires COSmanager 4.2.5 or newer.
 + 
 +<br>
 + 
 +==== Schedules and Schedtime ====
 + 
 +Duty3G 5.1 uses the newer, more generalised scheduling provided in COSmanager 4.2 releases. These include the datelist and schedule tables, which supersede the schedtime table (as used in COSduty 3.0). The schedtime table is now deprecated. It is important to note that the schedtime and schedule tables are maintained separately, and so changes to one table will not be reflected in the other. You should only maintain the schedule and datelist tables. You can do this via:
 +*{{cnav| Duty3G configuration | Tools | Schedules}}, or
 +*{{cnav| COSmanager configuration | Other tables | Schedule}}.
 + 
 +<br>
 + 
 +==== Audit Trails and Compliance Reports ====
 + 
 +When duty3G is installed, two new audit trails are created: ''duty_log'' and ''duty_compl''. By default, these are created in the system spool area (usually <code>/usr/spool</code> or <code>/var/spool</code>). The ''duty_log'' audit trail is the primary audit trail, recording all user actions, such as:
 +*running a duty, noting the exit status;
 +*marking a duty as done;
 +*any added user comments;
 +*re-authentication failures;
 +*attempts to run disabled duties.
 + 
 +The ''duty_compl'' audit trail is used to store all the [[#Daily Duty Compliance Reports | Daily Duty Compliance Reports]] created, by default, at midnight on a daily basis.
 + 
 +Depending on the volume of duties run, these directories may become large, so it is important that audit trail cycling be configured correctly for your site to prevent these files from growing unbounded. By default the audit trails are cycled:
 +:{|
 +! align="left" width="100" | ''duty_log''
 +| monthly, retaining up to 15 archive copies
 +|-
 +! align="left" width="100" | ''duty_compl''
 +| daily, retaining each report for up to one year.
 +|}
 + 
 +<br>
 + 
 +== New Features in this Release ==
 + 
 +==== Generalised calendaring for automatic duties ====
 + 
 +Duty3G V5.1 uses the new schedule and datelist tables which provide more features than the old schedtime table:
 + 
 +*You can create named datelists, which, as the name implies, contain lists of arbitrary dates which can be used to either be included or excluded from a schedule.
 +*You can write your own program or script to determine if the current date and time is to be included in the schedule.
 + 
 +:{{Note| As with schedtime, scheduling of automatic jobs is still implemented via CRON.}}
 + 
 +<br>
 + 
 +==== Grouping and ordering duties ====
 + 
 +Previously you may prefixed duties with a Class or Category (for example, ''STACKER: Inventory media'') so that like duties were listed together on the duty console. Now you can define a duty with a Duty List, or you can move a selected group of duties to a Duty List using {{cnav| Duty3G configuration | Duty | Move to duty list}}.
 + 
 +Previously, you may also have prefixed duties with a sequence number so that they will display in the duty console in the order they should be performed. Now you can re-order duties, using drag and drop, into what ever order you like using {{cnav| Duty3G configuration | Duty | Reorder duty list}}.
 + 
 +:{{Note| 1=You must first change your view for the duty list to be re-ordered using {{cnav| Duty3G configuration | View | For duty list}}.}}
 + 
 +:{{Note| Overdue duties will still display at the top of the duty list. Dependencies of duties will always display just above that duty.}}
 + 
 +<br>
 + 
 +==== Duty locking ====
 + 
 +<br>
 +==== Startup view ====
 + 
 +<br>
 +==== Disabling and enabling duties ====
 + 
 +<br>
 +==== Viewing upcomping duties ====
 + 
 +<br>
 +==== Re-authentication ====
 + 
 +<br>
 +==== Viewing the duty audit trail ====
 + 
 +<br>
 +==== Daily duty compliance reports ====
 + 
 +<br>
 +==== Notes facility ====
 + 
 +You can now attach a HTML or text file of documentation to a duty. This file can be viewed by the user from the duty console at any time.
 + 
 +:{{Note| There is no facility provided to create notes files—you can simply use your favourite text editor (vi, emacs etc.). Notes files should be created in the <code>duty_5.1/local/notes</code> directory.}}
 +<br>
 + 
 +== Known Problems in this Release ==
 + 
 +==== Duty3G Console Refresh ====
 + 
 +The duty3G console has been designed to refresh the data automatically within 5 seconds of any duty or status change. It has been observed on some platforms that very occasionally the duty3G console may miss a status change, and hence it does not refresh itself correctly. If you find this to be the case, select {{cnav| View | Outstanding}} (or whatever view you are in), which will force a refresh.
 + 
 +<br>

Current revision

Contents

Overview and Features

Duty3G

Duty3G 5.1 encourages sound management practices by making it possible to perform the regular operations workload on UNIX, Linux and Windows servers in a way that is efficient, reliable, verifiable, compliant, and repeatable whilst protecting privileged user access. With duty3G you define the command or commands that carry out a process, you assign the privilege to the duty, and then assign the duty to the user.


New features in duty3G 5.1

Key features of the new release are:

Enhanced operations

  • for a selected duty list
  • that run on a selected host
  • for a selected users' role.

Improved auditing

  • by selected time period
  • that have ended in error
  • for selected duty
  • for selected user
  • for selected mode

Documentation


Installation Requirements

Software prerequisites

To install and run duty3G 5.1 on a host, you must have:


Disk space required

Software Approximately 1 MB in the duty3G home directory.
Temporary Files While installing duty3G: less than 1 MB, to hold a copy of the software distribution.
While duty3G is running: less than 1 MB in /tmp.
Audit Trail For the duty3G audit trail, about 10 - 50 MB in the system spool area. The actual amount will depend on the activity on your system (e.g. how many duties are run), and how often you archive and delete the log files.
Compliance Reports For the duty3G compliance reports, about 5 - 20 MB in the system spool area.


Running Remote Duties on Windows

The current duty3G release supports running remote duties on Windows hosts which have the EWC (Enterprise Windows Client) 3.1.1 installed. This product may be purchased separately.


Upgrading COSduty 3.0

Figure 1 — Installation messages—upgrading from COSduty 3.0
Figure 1 — Installation messages—upgrading from COSduty 3.0
  1. Download the distribution file to /tmp on the target host.
  2. From the Configuration menu, select COSmanager configuration > Applications .
  3. Select Application > Install .
  4. Press Choose. You will see a list of the applications that can be installed. Choose the entry titled Duty3G 5.1, and press Accept.
  5. COSmanager copies the duty3G files from the distribution file to the target directory, updates the duty3G audit trail and creates the duty3g compliance report directory.
  6. To migrate your existing COSduty 3.0 database to the newly installed version press Copy. Your existing database is copied and updated with new table columns.
  7. To make the newly installed duty3G the default version press Accept, then press Continue.
Any automatic duties are added or re-added to the cosmos crontab.
This completes the upgrade installation. You must now restart COSmanager for the new version of duty3G to come into affect.


Technical Notes: Using duty3G 5.1

This section contains some technical notes and tips about using duty3G 5.1.


Temporary or trial licensing

Duty3G may be issued with a temporary license for use in trials or demonstrations. Temporary licenses have an in-built expiry date. You must obtain a permanent license or a new temporary license from your COSmanager distributor to keep using duty3G after the expiry date.

Note
Note
Duty3G won’t install if the license key is due to expire within the next 7 days. In this case you will need to obtain a new license key from your COSmanager distributor.


COSmanager framework version required for duty3G 5.1

Duty3G 5.1 requires COSmanager 4.2.5 or newer.


Schedules and Schedtime

Duty3G 5.1 uses the newer, more generalised scheduling provided in COSmanager 4.2 releases. These include the datelist and schedule tables, which supersede the schedtime table (as used in COSduty 3.0). The schedtime table is now deprecated. It is important to note that the schedtime and schedule tables are maintained separately, and so changes to one table will not be reflected in the other. You should only maintain the schedule and datelist tables. You can do this via:


Audit Trails and Compliance Reports

When duty3G is installed, two new audit trails are created: duty_log and duty_compl. By default, these are created in the system spool area (usually /usr/spool or /var/spool). The duty_log audit trail is the primary audit trail, recording all user actions, such as:

The duty_compl audit trail is used to store all the Daily Duty Compliance Reports created, by default, at midnight on a daily basis.

Depending on the volume of duties run, these directories may become large, so it is important that audit trail cycling be configured correctly for your site to prevent these files from growing unbounded. By default the audit trails are cycled:

duty_log monthly, retaining up to 15 archive copies
duty_compl daily, retaining each report for up to one year.


New Features in this Release

Generalised calendaring for automatic duties

Duty3G V5.1 uses the new schedule and datelist tables which provide more features than the old schedtime table:

Note
Note
As with schedtime, scheduling of automatic jobs is still implemented via CRON.


Grouping and ordering duties

Previously you may prefixed duties with a Class or Category (for example, STACKER: Inventory media) so that like duties were listed together on the duty console. Now you can define a duty with a Duty List, or you can move a selected group of duties to a Duty List using Duty3G configuration > Duty > Move to duty list .

Previously, you may also have prefixed duties with a sequence number so that they will display in the duty console in the order they should be performed. Now you can re-order duties, using drag and drop, into what ever order you like using Duty3G configuration > Duty > Reorder duty list .

Note
Note
You must first change your view for the duty list to be re-ordered using Duty3G configuration > View > For duty list .
Note
Note
Overdue duties will still display at the top of the duty list. Dependencies of duties will always display just above that duty.


Duty locking


Startup view


Disabling and enabling duties


Viewing upcomping duties


Re-authentication


Viewing the duty audit trail


Daily duty compliance reports


Notes facility

You can now attach a HTML or text file of documentation to a duty. This file can be viewed by the user from the duty console at any time.

Note
Note
There is no facility provided to create notes files—you can simply use your favourite text editor (vi, emacs etc.). Notes files should be created in the duty_5.1/local/notes directory.


Known Problems in this Release

Duty3G Console Refresh

The duty3G console has been designed to refresh the data automatically within 5 seconds of any duty or status change. It has been observed on some platforms that very occasionally the duty3G console may miss a status change, and hence it does not refresh itself correctly. If you find this to be the case, select View > Outstanding (or whatever view you are in), which will force a refresh.