Skip to content

update to good-citizen defaults#73

Merged
javierbertoli merged 5 commits intosaltstack-formulas:masterfrom
netmanagers:master
Jul 23, 2020
Merged

update to good-citizen defaults#73
javierbertoli merged 5 commits intosaltstack-formulas:masterfrom
netmanagers:master

Conversation

@javierbertoli
Copy link
Member

@javierbertoli javierbertoli commented Jul 23, 2020

PR progress checklist (to be filled in by reviewers)

  • Changes to documentation are appropriate (or tick if not required)
  • Changes to tests are appropriate (or tick if not required)
  • Reviews completed

What type of PR is this?

Primary type

  • [build] Changes related to the build system
  • [chore] Changes to the build process or auxiliary tools and libraries such as documentation generation
  • [ci] Changes to the continuous integration configuration
  • [feat] A new feature
  • [fix] A bug fix
  • [perf] A code change that improves performance
  • [refactor] A code change that neither fixes a bug nor adds a feature
  • [revert] A change used to revert a previous commit
  • [style] Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)

Secondary type

  • [docs] Documentation changes
  • [test] Adding missing or correcting existing tests

Does this PR introduce a BREAKING CHANGE?

No.

Related issues and/or pull requests

#72
#63

Describe the changes you're proposing

This PR implements

  • the changes requested to Update pillar.example to good-citizen defaults #63 that had gone stale.
  • updates the default version to python3
  • update the default server to ACMEv2 as ACMEv1 EOLed (should close [BUG] ACMEv1 enf of life #72)
  • implements the possibility to set config as a map and not only a string. This allows us to define default values in defaults.yaml. Added tests to check that the change is backward compatible

Pillar / config required to test the proposed changes

Debug log showing how the proposed changes work

Documentation checklist

  • Updated the README (e.g. Available states).
  • Updated pillar.example.

Testing checklist

  • Included in Kitchen (i.e. under state_top).
  • Covered by new/existing tests (e.g. InSpec, Serverspec, etc.).
  • Updated the relevant test pillar.

Additional context

@javierbertoli javierbertoli requested review from aboe76, alxwr and myii July 23, 2020 11:34
@pull-assistant
Copy link

pull-assistant bot commented Jul 23, 2020 •
edited
Loading

Score: 0.93

Best reviewed: commit by commit

Optimal code review plan

     docs(defaults): update pillar.example to good-citizen defaults

     feat(config): add sane defaults

     fix(server): change server to ACMEv2

     feat(package): update default to py3

     fix(package): amazonlinux defaults to python2

Powered by Pull Assistant. Last update b889678 ... 926c779. Read the comment docs.

noelmcloughlin
noelmcloughlin approved these changes Jul 23, 2020
View reviewed changes
Copy link

@noelmcloughlin noelmcloughlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @javierbertoli go ahead and merge if Travis is passing.

One question - should letsencrypt/files/cli.ini.jinja be letsencrypt/files/default/cli.ini.jinja?

@javierbertoli javierbertoli force-pushed the master branch 2 times, most recently from b477abe to 4b0a26c Compare July 23, 2020 12:13
@javierbertoli
Copy link
Member Author

javierbertoli commented Jul 23, 2020

One question - should letsencrypt/files/cli.ini.jinja be letsencrypt/files/default/cli.ini.jinja?

Possibly, yes. But as the formula is not yet in-sync with template, I'm just fixing those long standing issues with defaults and the new server change that was mentioned in #72.

I guess a new PR with a heavier refactor will come later 😄

jinnatar and others added 5 commits July 23, 2020 09:35
@jinnatar @javierbertoli
docs(defaults): update pillar.example to good-citizen defaults
b889678 
Specifying `renew-by-default` in the config, regardless of True / False enables the flag.
This causes certbot to force-renew on every timer run and means you will hit the rate-limit
fairly quickly. A safer default is `keep-until-expiring` where the renew will only be done
when it's actually advisable.

`expand` allows an expanded domain list to renew correctly without forking a new domainset.
This is something that most users will want.
@javierbertoli
feat(config): add sane defaults
d9afac9 
Also specify `config` as a hash to make it easier to provide the config from
multiple pillar values.  Maintain backward compatibility (supplying `config` as
a string) so that the formula continues to work as expected if a `config`
string is already available.

BREAKING CHANGE: `config` can now be provided as a hash or a string; defaults
are modified and, while sane and desirable, do change the behavior of the
formula.
@javierbertoli
fix(server): change server to ACMEv2
1fc79b8 
closes saltstack-formulas#72 (ACMEv1 eol)
@javierbertoli
feat(package): update default to py3
4c93c11
@javierbertoli
fix(package): amazonlinux defaults to python2
926c779
@javierbertoli
Copy link
Member Author

javierbertoli commented Jul 23, 2020

Merging as it got approved and the commitlint error is not related to the PR.

@javierbertoli javierbertoli merged commit d39113a into saltstack-formulas:master Jul 23, 2020
This was referenced Jul 23, 2020
Closed
Closed
@saltstack-formulas-travis
Copy link

saltstack-formulas-travis commented Jul 23, 2020

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aboe76 aboe76 Awaiting requested review from aboe76

@alxwr alxwr Awaiting requested review from alxwr

@myii myii Awaiting requested review from myii

1 more reviewer

@noelmcloughlin noelmcloughlin noelmcloughlin approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

released

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[BUG] ACMEv1 enf of life

4 participants

@javierbertoli @saltstack-formulas-travis @noelmcloughlin @jinnatar