Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Basic OpenResty support #268

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

faudebert
Copy link

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

This PR relies on #267 which should be thus considered before. In this PR only introduce the last 2 commits.

Describe the changes you're proposing

This pull-request attempts to reintroduce (basic) OpenResty support within the NGINX formula.

Pillar / config required to test the proposed changes

Set nginx:install_from_openresty: True and use the formula as usual.

Debug log showing how the proposed changes work

Having set nginx:install_from_openresty: True, check apply.log to see salt-call output on a clean Debian Stretch host.

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

I don't know why previous OpenResty support was dropped. I hope this might be of any interest.

@faudebert faudebert requested a review from sticky-note as a code owner July 2, 2020 10:55
@pull-assistant
Copy link

pull-assistant bot commented Jul 2, 2020

Copy link
Member

@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. Separate PRs would be easier to eyeball, but if Travis CI is passing should be good to go

@faudebert
Copy link
Author

LGTM. Separate PRs would be easier to eyeball, but if Travis CI is passing should be good to go

Thanks for your feedback.

Tried to follow the guideline regarding having two distinct refactor & feat pull-requests. I've created #267 which only contains refactor changes but current feat PR relies on it. Maybe having this pull-request base pointing at #267 branch would be clearer?

@noelmcloughlin
Copy link
Member

I was just passing by (I don't maintain this repo) but yes, maybe I should have reviewed #267 first. Anyway LGTM.

This is already done mostly everywhere and covers few remaining
locations.
Allow to rename the meta-state without having to change substates
references. This might be useful one wants to use this formula with a
(renamed) fork within the same environment.
This might be useful if one wants to use this formula with a (renamed)
fork within the same environment.

Note this also permits to override pillar namespace by defining
'{meta-state name}:pillar:namespace: str'.
Allow to install OpenResty from their official repository by
introducing 'install_from_openresty' pillar.
@faudebert faudebert force-pushed the upstream/openresty branch from 0769e3e to f455b72 Compare August 3, 2020 08:35
@faudebert
Copy link
Author

Rebased on opendatasoft:upstream/generic-namespaces from #267.

@myii
Copy link
Member

myii commented Aug 3, 2020

@sticky-note Would you mind looking at this and #267? Please let us know if time is short and we'll look at some way of getting these reviewed.


@faudebert From a reviewing perspective, smaller PRs are much easier to review, so usually get done much quicker. Even single-line changes can have significant impacts, the further we extend, the more cautious we get. We'll probably have to do that here where we leave these two PRs in place and then work through the proposals in smaller blocks in further PRs.

For example, we've already got a new standard emerging for map.jinja that has been implemented by @baby-gnu in these formulas:

We've had quite a few discussions about this in the Formulas' working group meetings, such as here:

We're also implementing a new verification standard to use before refactoring any map.jinja, which involves using InSpec testing to make sure the map is produced the same before and after:

It would be important to bring those in here first before refactoring map.jinja.

These are just some points to help you see where we are currently. Please feel free to continue the discussion. We value your contribution and feedback, it just requires a structured approach to review.

@daks
Copy link
Member

daks commented Aug 7, 2020

I'll look at this one once #267 is merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants