Bug 1311366 - [Docs] [Director] Add an example of how to set the TimeZone parameter, and address a typo
Summary: [Docs] [Director] Add an example of how to set the TimeZone parameter, and ad...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 8.0 (Liberty)
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ga
: 8.0 (Liberty)
Assignee: Martin Lopes
QA Contact: RHOS Documentation Team
URL:
Whiteboard:
Depends On: 1238460
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-02-24 04:58 UTC by Andrew Dahms
Modified: 2016-04-13 04:53 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-04-13 04:53:45 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Andrew Dahms 2016-02-24 04:58:40 UTC
The following changes must be made in the Director Usage and Installation guide:

* Add an example of the TimeZone parameter outlined in BZ#1238460.

* In Section 8.1, the 'Important' box is missing 'is' in the opening sentence.

Comment 1 Martin Lopes 2016-03-08 02:02:24 UTC
Wrote draft text:



== Configure the Overcloud Time Zone

You can use the `TimeZone` parameter in a Heat template to set the time zone of your Overcloud deployment. If you leave the `TimeZone` parameter blank, the Overcloud will default to `UTC` time:

----
  TimeZone:
    default: 'UTC'
    description: The timezone to be set on compute nodes.
    type: string
----

Director recognizes the standard timezone names defined in the timezone database _/usr/share/zoneinfo/_. For example, if you wanted to set your time zone to `Japan`, you would examine the contents of _/usr/share/zoneinfo_ to locate a suitable entry:

----
$ ls /usr/share/zoneinfo/
Africa      Asia       Canada   Cuba   EST      GB       GMT-0      HST      iso3166.tab  Kwajalein  MST      NZ-CHAT   posix       right      Turkey     UTC       Zulu
America     Atlantic   CET      EET    EST5EDT  GB-Eire  GMT+0      Iceland  Israel       Libya      MST7MDT  Pacific   posixrules  ROC        UCT        WET
Antarctica  Australia  Chile    Egypt  Etc      GMT      Greenwich  Indian   Jamaica      MET        Navajo   Poland    PRC         ROK        Universal  W-SU
Arctic      Brazil     CST6CDT  Eire   Europe   GMT0     Hongkong   Iran     Japan        Mexico     NZ       Portugal  PST8PDT     Singapore  US         zone.tab
----

The output listed above includes time zone files, and directories containing additional time zone files. For example, `Japan` is an individual time zone file in this result, but `Africa` is a directory containing additional time zone files:

----
$ ls /usr/share/zoneinfo/Africa/
Abidjan      Algiers  Bamako  Bissau       Bujumbura   Ceuta    Dar_es_Salaam  El_Aaiun  Harare        Kampala   Kinshasa    Lome        Lusaka  Maseru     Monrovia  Niamey       Porto-Novo  Tripoli
Accra        Asmara   Bangui  Blantyre     Cairo       Conakry  Djibouti       Freetown  Johannesburg  Khartoum  Lagos       Luanda      Malabo  Mbabane    Nairobi   Nouakchott   Sao_Tome    Tunis
Addis_Ababa  Asmera   Banjul  Brazzaville  Casablanca  Dakar    Douala         Gaborone  Juba          Kigali    Libreville  Lubumbashi  Maputo  Mogadishu  Ndjamena  Ouagadougou  Timbuktu    Windhoek
----

Once you have determined the time zone to use, you can enter its name into the Heat template for processing:

----
  TimeZone:
    default: 'Japan'
    description: The timezone to be set on compute nodes.
    type: string
----

Comment 2 Martin Lopes 2016-03-08 02:06:09 UTC
Hi Dan, can you tech review comment 1?

Comment 3 Dan Macpherson 2016-03-23 04:20:45 UTC
This isn't quite accurate. The TimeZone resource is already defined in the Heat Template collection. What you need to do to set this parameter is to create an environment file (e.g. timezone.yaml) with the following:

----
parameter_defaults:
  TimeZone: 'Japan'
----

Then include this file when you run a deployment. For example:

----
$ openstack overcloud deploy --templates -e timezone.yaml
----

This overrides the default (UTC) in the core Heat template collection.

It's not a good idea to change the core Heat Template collection directly.

Comment 4 Mike McCune 2016-03-28 23:08:19 UTC
This bug was accidentally moved from POST to MODIFIED via an error in automation, please see mmccune with any questions

Comment 5 Martin Lopes 2016-03-30 04:39:57 UTC
Hi Dan, updated the draft. Is this closer to what you're expecting?


== Configure the Overcloud Time Zone

You can set the time zone of your Overcloud deployment using the `TimeZone` parameter in an environment file. If you leave the `TimeZone` parameter blank, the Overcloud will default to `UTC` time.

Director recognizes the standard timezone names defined in the timezone database _/usr/share/zoneinfo/_. For example, if you wanted to set your time zone to `Japan`, you would examine the contents of _/usr/share/zoneinfo_ to locate a suitable entry:

----
$ ls /usr/share/zoneinfo/
Africa      Asia       Canada   Cuba   EST      GB       GMT-0      HST      iso3166.tab  Kwajalein  MST      NZ-CHAT   posix       right      Turkey     UTC       Zulu
America     Atlantic   CET      EET    EST5EDT  GB-Eire  GMT+0      Iceland  Israel       Libya      MST7MDT  Pacific   posixrules  ROC        UCT        WET
Antarctica  Australia  Chile    Egypt  Etc      GMT      Greenwich  Indian   Jamaica      MET        Navajo   Poland    PRC         ROK        Universal  W-SU
Arctic      Brazil     CST6CDT  Eire   Europe   GMT0     Hongkong   Iran     Japan        Mexico     NZ       Portugal  PST8PDT     Singapore  US         zone.tab
----

The output listed above includes time zone files, and directories containing additional time zone files. For example, `Japan` is an individual time zone file in this result, but `Africa` is a directory containing additional time zone files:

----
$ ls /usr/share/zoneinfo/Africa/
Abidjan      Algiers  Bamako  Bissau       Bujumbura   Ceuta    Dar_es_Salaam  El_Aaiun  Harare        Kampala   Kinshasa    Lome        Lusaka  Maseru     Monrovia  Niamey       Porto-Novo  Tripoli
Accra        Asmara   Bangui  Blantyre     Cairo       Conakry  Djibouti       Freetown  Johannesburg  Khartoum  Lagos       Luanda      Malabo  Mbabane    Nairobi   Nouakchott   Sao_Tome    Tunis
Addis_Ababa  Asmera   Banjul  Brazzaville  Casablanca  Dakar    Douala         Gaborone  Juba          Kigali    Libreville  Lubumbashi  Maputo  Mogadishu  Ndjamena  Ouagadougou  Timbuktu    Windhoek
----

Once you have determined the time zone to use, you can enter its name into an environment file processing. For example, add the entry in a file named 'timezone.yaml' to set your timezone to `Japan`:

----
parameter_defaults:
  TimeZone: 'Japan'
----

Next, use the overcloud deploy process to run the template and apply the setting:

----
$ openstack overcloud deploy --templates -e timezone.yaml
----

Comment 6 Dan Macpherson 2016-04-01 15:12:44 UTC
Looks good to me.

Comment 10 Dan Macpherson 2016-04-04 07:43:33 UTC
Verified. Nice work!

Comment 11 Andrew Dahms 2016-04-13 04:53:45 UTC
This content is now live on the Customer Portal.

Closing.


Note You need to log in before you can comment on or make changes to this bug.