Skip to content

refactor!: Change configuration file format to YAML#4456

Merged
lenny-goodell merged 2 commits intoedgexfoundry:mainfrom
lenny-goodell:yaml-config
Mar 20, 2023
Merged

refactor!: Change configuration file format to YAML#4456
lenny-goodell merged 2 commits intoedgexfoundry:mainfrom
lenny-goodell:yaml-config

Conversation

@lenny-goodell
Copy link
Member

@lenny-goodell lenny-goodell commented Mar 16, 2023 •
edited
Loading

BREAKING CHANGE: Configuration files are now in YAML format, Default file name is now configuration.yaml

closes # 4452

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-go/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

  • I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
  • I am not introducing a new dependency (add notes below if you are)
  • I have added unit tests for the new feature or bug fix (if not, why?) N/A
  • I have fully tested (add details below) this the new feature or bug fix (if not, why?)
  • I have opened a PR for the related docs change (if not, why?)
    TBD

Testing Instructions

run make docker
from compose builder run make run delayed-start dev
Verify all core/support/security services bootstrap successfully and contain the following log message:

msg="Loaded private configuration from ./res/configuration.yaml"

New Dependency Instructions (If applicable)

@lenny-goodell lenny-goodell force-pushed the yaml-config branch 2 times, most recently from 4b678ca to ed5b1e7 Compare March 16, 2023 18:41
@lenny-goodell lenny-goodell requested a review from farshidtz March 16, 2023 19:07
@codecov-commenter
Copy link

codecov-commenter commented Mar 16, 2023 •
edited
Loading

Codecov Report

Merging #4456 (28d8200) into main (b6ca322) will not change coverage.
The diff coverage is 0.00%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##             main    #4456   +/-   ##
=======================================
  Coverage   41.73%   41.73%           
=======================================
  Files         106      106           
  Lines        9749     9749           
=======================================
  Hits         4069     4069           
  Misses       5333     5333           
  Partials      347      347
Impacted Files Coverage Δ
...rnal/security/bootstrapper/command/flags_common.go 0.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

jim-wang-yutsung
jim-wang-yutsung previously approved these changes Mar 16, 2023
View reviewed changes
Copy link

@jim-wang-yutsung jim-wang-yutsung left a comment

Choose a reason for hiding this comment

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

LGTM

vli11
vli11 previously approved these changes Mar 16, 2023
View reviewed changes
marcpfuller
marcpfuller reviewed Mar 17, 2023
View reviewed changes
marcpfuller
marcpfuller previously approved these changes Mar 17, 2023
View reviewed changes
Copy link

@marcpfuller marcpfuller left a comment

Choose a reason for hiding this comment

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

LGTM

@lenny-goodell lenny-goodell marked this pull request as ready for review March 17, 2023 18:59
@bnevis-i
Copy link
Collaborator

bnevis-i commented Mar 17, 2023

In my testing, few of the containers stay running for more than a minute. overrides such as REGISTRY_HOST are not working:

level=INFO ts=2023-03-17T20:03:54.838229874Z app=core-data source=registry.go:85 msg="Using Registry (consul) from http://localhost:8500"
level=WARN ts=2023-03-17T20:03:54.838420073Z app=core-data source=registry.go:118 msg="registry is not available"

bnevis-i
bnevis-i previously approved these changes Mar 17, 2023
View reviewed changes
Copy link
Collaborator

@bnevis-i bnevis-i left a comment

Choose a reason for hiding this comment

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

Works for me with the following fix:

edgexfoundry/edgex-compose#353

farshidtz
farshidtz reviewed Mar 20, 2023
View reviewed changes
@lenny-goodell lenny-goodell requested a review from farshidtz March 20, 2023 16:15
@lenny-goodell lenny-goodell force-pushed the yaml-config branch 2 times, most recently from ba8bc36 to dbe6756 Compare March 20, 2023 17:23
refactor!: Change configuration file format to YAML
d085318 
BREAKING CHANGE: Configuration files are now in YAML format, Defualt file name is now configuration.yaml

closes # 4452

Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
bnevis-i
bnevis-i requested changes Mar 20, 2023
View reviewed changes
Copy link
Collaborator

@bnevis-i bnevis-i left a comment

Choose a reason for hiding this comment

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

I definitely agree with Farshid's observation that the camelCasing with the lowercase first letter is the preferred style for YAML.

I definitely think we shouldn't hard code jdoe@gmail.com into our scripts!

Though I would approve the PR with it in there, I also don't think we should be suggesting smtp.gmail.com either. I have my printer set up to scan to email via GMail, and no matter how many times I click "allow insecure logins" google turns it back on randomly and my scan to email feature is broken. Suggesting that Gmail is even close to a supportable outgoing SMTP server is just plain misleading.

@lenny-goodell
Copy link
Member Author

lenny-goodell commented Mar 20, 2023 •
edited
Loading

I definitely agree with Farshid's observation that the camelCasing with the lowercase first letter is the preferred style for YAML.

I googled preferred style for YAML and found there isn't one and found it is dependent on the project. I.e. python projects use lower case hyphenated names. This is why compose files uses lower case hyphenated names. ;-)

fix: Replaced gmail sample server and email with generic names to be …
d35c8a2 
…replaced.

Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 20, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
5.5% 5.5% Duplication

@lenny-goodell lenny-goodell merged commit fe5feeb into edgexfoundry:main Mar 20, 2023
@lenny-goodell lenny-goodell deleted the yaml-config branch March 20, 2023 21:06
@cloudxxx8 cloudxxx8 mentioned this pull request Apr 26, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bnevis-i bnevis-i bnevis-i approved these changes

@cloudxxx8 cloudxxx8 Awaiting requested review from cloudxxx8

@ejlee3 ejlee3 Awaiting requested review from ejlee3

@farshidtz farshidtz Awaiting requested review from farshidtz

@jim-wang-yutsung jim-wang-yutsung Awaiting requested review from jim-wang-yutsung

@vli11 vli11 Awaiting requested review from vli11

@marcpfuller marcpfuller Awaiting requested review from marcpfuller

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@lenny-goodell @codecov-commenter @bnevis-i @farshidtz @vli11 @jim-wang-yutsung @marcpfuller