Re: Please review control and templates for tryton-server
* Justin B Rye: " Re: Please review control and templates for tryton-server"
(Tue, 13 Sep 2022 18:52:05 +0100):
Hello Justin,
thanks for your prompt reply!
> Mathias Behrle:
> > I have created several new packages providing a guided support for the
> > installation of tryton-server. The repository can be found at
> >
> > https://salsa.debian.org/tryton-team/tryton-server/-/tree/debian-bullseye-6.0
> >
> > As I am not a native English speaker, I would be glad to receive some
> > feedback for the control and templates files. Best would be to get evtl.
> > MRs for current working branch debian-bullseye-6.0 or patches or just
> > comments, as you see fit.
>
> I'm starting with comments on the templates and hoping to work up
> towards MRs later - first I might need some help with understanding
> them.
Just tell me if you want to do MRs or if I should merge your proposed changes
along the discussion.
> > Template: tryton-server-uwsgi/enable-cron
>
> (Somehow I've ended up doing these in slightly jumbled order.)
>
> > Type: boolean
> > Default: false
> > _Description: Configure cron for the Tryton server?
>
> The template name implies that the choice isn't whether they should be
> left uncustomised, it's whether they should run at all. So:
>
> _Description: Set up Tryton server cron jobs?
Indeed the Tryton server cron runs separately from the main server and it is
this process that is set up. It is comparable to the system cron, but handles
internally scheduled jobs for Tryton. So 'Set up Tryton server cron jobs?' is
misleading, because the individual cron jobs have to be configured/activated
separately in each database. Perhaps 'Set up a Tryton server cron process?'
> > There exist several Tryton server cron jobs that mainly run periodically
> > some maintenance tasks on the database. They can be configured with the
> > clients.
>
> Tryton server has several cron jobs that can be activated to perform
> periodic maintenance on the database. They can be configured using the
> Tryton clients.
Perfect.
> (I may be misinterpreting the second sentence.)
>
> > .
> > Note: Only one cron server should be enabled per database.
>
> Wait, is it really talking about Tryton running its own cron-daemon
> *server*? That also seems to be what the package description implies,
> but why on earth would anybody want to do that? (Is it maybe some
> misleadingly named task-scheduling subprocess of the Tryton server?)
> I'm going to assume for now that this should be something like
>
> Note: Only one maintenance cron job should be enabled per database.
>
> But maybe this is the kind of instruction that belongs in whatever
> interface is going to be used to pick the ones that will run?
It is indeed only one cron server that should be started per database.
Otherwise tasks will run twice or conflict and interfere with each other.
> > Template: tryton-server-postgresql/db-admin-email
> > Type: string
> > Default: root@localhost
> > _Description: Email address for the admin user:
> > This email address receives all kind of administrative messages for the
> > admin user.
>
> Make it clear we're asking the reader to *tell* us that address.
>
> Please specify the email address that should receive administrative
> messages from the Tryton server.
>
> > .
> > The value should be a FQDN (Full Qualified Domain Name).
>
> Well, that's not true; "gmail.com." is a FQDN, but it won't work here,
> and on the other hand "root@localhost" isn't but will. If this is
> just trying to say "it won't work if it isn't valid" then it probably
> isn't worth saying, unless maybe we do it in passing:
>
> Please specify a valid email address that should receive administrative
> messages from the Tryton server.
Yes, perfect.
> > Template: tryton-server-uwsgi/enable-workers
> > Type: boolean
> > Default: false
> > _Description: Configure workers for the Tryton server?
>
> Again it means "enable", not "customise":
>
> _Description: Set up Tryton server workers?
Yes.
> > Some Tryton server tasks may be performed in the background
> > asynchronically by workers in a task queue.
>
> Slight reshuffle:
>
> Some Tryton server tasks can be performed asynchronously in the
> background by workers in a task queue.
Yes.
> > If workers are configured those tasks (like e.g. the processing of sales,
> > invoices or purchases) can be automatically performed by workers. They
> > do not wait for completion in the clients thus removing the need of
> > waiting and doing serialized steps.
>
> Well, obviously not waiting eliminates some waiting, but it's not
> quite clear what's going on with the serialised steps... maybe:
>
> If enabled, the workers can automatically perform tasks such as the
> processing of sales, invoices, or purchases without waiting for the
> clients to finish, thus removing the need for serialisation.
The serialized steps are mostly workflow steps that when called manually take
some time to complete. Pushing those tasks to a worker doesn't block the client
until the process has finished but allows to continue almost immediately. The
serialized process is just handled by another process.
> > Template: tryton-server-all-in-one/postal-code-countries
> > Type: multiselect
> > Choices: Afghanistan - AF, Albania - AL, Algeria - DZ, American Samoa - AS,
> > Andorra - AD, Angola - AO, Anguilla - AI, Antarctica - AQ, Antigua and
> > Barbuda - AG, Argentina - AR, Armenia - AM, Aruba - AW, Australia - AU,
> > Austria - AT, Azerbaijan - AZ, Bahamas - BS, Bahrain - BH, Bangladesh - BD,
> > Barbados - BB, Belarus - BY, Belgium - BE, Belize - BZ, Benin - BJ, Bermuda
> > - BM, Bhutan - BT, Bolivia Plurinational State of - BO, Bonaire Sint
> > Eustatius and Saba - BQ, Bosnia and Herzegovina - BA, Botswana - BW, Bouvet
> > Island - BV, Brazil - BR, British Indian Ocean Territory - IO, Brunei
> > Darussalam - BN, Bulgaria - BG, Burkina Faso - BF, Burundi - BI, Cabo Verde
> > - CV, Cambodia - KH, Cameroon - CM, Canada - CA, Cayman Islands - KY,
> > Central African Republic - CF, Chad - TD, Chile - CL, China - CN, Christmas
> > Island - CX, Cocos (Keeling) Islands - CC, Colombia - CO, Comoros - KM,
> > Congo The Democratic Republic of the - CD, Congo - CG, Cook Islands - CK,
> > Costa Rica - CR, Croatia - HR, Cuba - CU, Curaçao - CW, Cyprus - CY,
> > Czechia - CZ, Côte dIvoire - CI, Denmark - DK, Djibouti - DJ, Dominica -
> > DM, Dominican Republic - DO, Ecuador - EC, Egypt - EG, El Salvador - SV,
> > Equatorial Guinea - GQ, Eritrea - ER, Estonia - EE, Eswatini - SZ, Ethiopia
> > - ET, Falkland Islands (Malvinas) - FK, Faroe Islands - FO, Fiji - FJ,
> > Finland - FI, France - FR, French Guiana - GF, French Polynesia - PF,
> > French Southern Territories - TF, Gabon - GA, Gambia - GM, Georgia - GE,
> > Germany - DE, Ghana - GH, Gibraltar - GI, Greece - GR, Greenland - GL,
> > Grenada - GD, Guadeloupe - GP, Guam - GU, Guatemala - GT, Guernsey - GG,
> > Guinea - GN, Guinea-Bissau - GW, Guyana - GY, Haiti - HT, Heard Island and
> > McDonald Islands - HM, Holy See (Vatican City State) - VA, Honduras - HN,
> > Hong Kong - HK, Hungary - HU, Iceland - IS, India - IN, Indonesia - ID,
> > Iran Islamic Republic of - IR, Iraq - IQ, Ireland - IE, Isle of Man - IM,
> > Israel - IL, Italy - IT, Jamaica - JM, Japan - JP, Jersey - JE, Jordan -
> > JO, Kazakhstan - KZ, Kenya - KE, Kiribati - KI, Korea Democratic Peoples
> > Republic of - KP, Korea Republic of - KR, Kuwait - KW, Kyrgyzstan - KG,
> > Lao Peoples Democratic Republic - LA, Latvia - LV, Lebanon - LB, Lesotho -
> > LS, Liberia - LR, Libya - LY, Liechtenstein - LI, Lithuania - LT,
> > Luxembourg - LU, Macao - MO, Madagascar - MG, Malawi - MW, Malaysia - MY,
> > Maldives - MV, Mali - ML, Malta - MT, Marshall Islands - MH, Martinique -
> > MQ, Mauritania - MR, Mauritius - MU, Mayotte - YT, Mexico - MX, Micronesia
> > Federated States of - FM, Moldova Republic of - MD, Monaco - MC, Mongolia
> > - MN, Montenegro - ME, Montserrat - MS, Morocco - MA, Mozambique - MZ,
> > Myanmar - MM, Namibia - NA, Nauru - NR, Nepal - NP, Netherlands - NL, New
> > Caledonia - NC, New Zealand - NZ, Nicaragua - NI, Niger - NE, Nigeria - NG,
> > Niue - NU, Norfolk Island - NF, North Macedonia - MK, Northern Mariana
> > Islands - MP, Norway - NO, Oman - OM, Pakistan - PK, Palau - PW, Palestine
> > State of - PS, Panama - PA, Papua New Guinea - PG, Paraguay - PY, Peru -
> > PE, Philippines - PH, Pitcairn - PN, Poland - PL, Portugal - PT, Puerto
> > Rico - PR, Qatar - QA, Romania - RO, Russian Federation - RU, Rwanda - RW,
> > Réunion - RE, Saint Barthélemy - BL, Saint Helena Ascension and Tristan da
> > Cunha - SH, Saint Kitts and Nevis - KN, Saint Lucia - LC, Saint Martin
> > (French part) - MF, Saint Pierre and Miquelon - PM, Saint Vincent and the
> > Grenadines - VC, Samoa - WS, San Marino - SM, Sao Tome and Principe - ST,
> > Saudi Arabia - SA, Senegal - SN, Serbia - RS, Seychelles - SC, Sierra Leone
> > - SL, Singapore - SG, Sint Maarten (Dutch part) - SX, Slovakia - SK,
> > Slovenia - SI, Solomon Islands - SB, Somalia - SO, South Africa - ZA, South
> > Georgia and the South Sandwich Islands - GS, South Sudan - SS, Spain - ES,
> > Sri Lanka - LK, Sudan - SD, Suriname - SR, Svalbard and Jan Mayen - SJ,
> > Sweden - SE, Switzerland - CH, Syrian Arab Republic - SY, Taiwan Province
> > of China - TW, Tajikistan - TJ, Tanzania United Republic of - TZ, Thailand
> > - TH, Timor-Leste - TL, Togo - TG, Tokelau - TK, Tonga - TO, Trinidad and
> > Tobago - TT, Tunisia - TN, Turkey - TR, Turkmenistan - TM, Turks and Caicos
> > Islands - TC, Tuvalu - TV, Uganda - UG, Ukraine - UA, United Arab Emirates
> > - AE, United Kingdom - GB, United States - US, United States Minor Outlying
> > Islands - UM, Uruguay - UY, Uzbekistan - UZ, Vanuatu - VU, Venezuela
> > Bolivarian Republic of - VE, Viet Nam - VN, Virgin Islands British - VG,
> > Virgin Islands U.S. - VI, Wallis and Futuna - WF, Western Sahara - EH,
> > Yemen - YE, Zambia - ZM, Zimbabwe - ZW, Åland Islands - AX
>
> Should all these get translations using the "__Choices" mechanism?
No, I don't think so.
> (Sorted from A to Å by official name, with the UK and Ukraine
> confusingly using GB and UA? Oh well, I probably can't fix that.)
There was some discussion about the best format for this list. And yes, we
can't fix ISO country codes... ;)
> > _Description: Import of postal codes
> > Please select all countries for which postal codes should be imported
> > .
> > Preconfigured postal codes offer automatic completion features in the
> > address management. .
> > Note: The availability of codes depends on their existence on
> > geonames.org.
>
> I deduce that if I ask it to "import" "United Kingdom - GB", it will
> create a PostgreSQL table full of UK postal codes taken from
> geonames.org. Are they fetched at compile time or during this
> installation stage? There isn't really enough information here to let
> a reader work out what the costs would be if they enabled *all* of
> them.
I never tried to import all of them, there is also only a part available at
geonames.org. In terms of database size there shouldn't be the slightest
problem, in terms of installation time this could mean quite some time
(minutes, but not hours).
> _Description: Postal codes
> Please select all countries for which postal codes should be imported
> into the database. This allows the address management system to
> offer automatic completion features.
> .
> Note: The availability of codes depends on their existence on geonames.org.
Yes.
> > Template: tryton-server-postgresql/db-admin-password
> > Type: string
> > _Description: Initial admin password for Tryton:
> > The Tryton database will be populated with an initial superuser, named
> > 'admin', and the password you provide here will be used as the initial
> > password of this superuser. This password will be required for the first
> > login.
>
> "Welcome to Tryton, population: 1". Simplifying slightly:
>
> A superuser account named "admin" will be created for the Tryton database.
> Please specify the password that this account should require for the
> initial login.
Perfect.
> > .
> > If left empty a random password will be used. You can reset this password
> > from the command line with
> > .
> > $ sudo -u tryton trytond-admin -c /etc/tryton/trytond.conf --password -d
> > <your_database_name> .
> > Note: The initialization of the database may take some time, please be
> > patient.
>
> Very pedantic tweaks:
>
> If it is left empty a random password will be used. You can reset this
> password from the command line with
> .
> $ sudo -u tryton trytond-admin -c /etc/tryton/trytond.conf --password -d
> <your_database_name> .
> Note: The initialization of the database may take some time; please be
> patient.
Good.
> Hmm, well, I expect I've completely misunderstood at least one of
> them, but here are some attached revised versions.
>
> I nearly missed the package descriptions in the control file! The
> content looks mostly good, though the short descriptions need work
> and there's some inconsistent capitalisation - no time to go through
> commenting now, I'll just attach a first-draft modified version.
Thanks for your work so far!
Mathias
--
Mathias Behrle
PGP/GnuPG key availabable from any keyserver, ID: 0xD6D09BE48405BBF6
AC29 7E5C 46B9 D0B6 1C71 7681 D6D0 9BE4 8405 BBF6
Reply to: