Use hazelcast.yaml when hazelcast.xml is not available #20003

frant-hartm · 2021-12-01T08:46:38Z

Users sometimes prefer to use yaml configuration.
When the hazelcast.xml is not available in the config folder then
hazelcast.yaml is tried.
If hazelcast.yaml is not available error message is shown with guidance
what to do.

Fixes #19727

Checklist:

Labels (Team:, Type:, Source:, Module:) and Milestone set
Label Add to Release Notes or Not Release Notes content set
Request reviewers if possible
Send backports/forwardports if fix needs to be applied to past/future releases

Users sometimes prefer to use yaml configuration. When the hazelcast.xml is not available in the config folder then hazelcast.yaml is tried. If hazelcast.yaml is not available error message is shown with guidance what to do. Fixes hazelcast#19727

ldziedziul · 2021-12-01T09:06:55Z

distribution/src/bin-filemode-755/hz-start

+    fi
+
+    if [ ! -f "$HAZELCAST_HOME/$HAZELCAST_CONFIG" ]; then
+        echo "Configuration file is missing. Create hazelcast.xml or hazelcast.yaml in $HAZELCAST_HOME/config or set the HAZELCAST_CONFIG environment variable."


I'm not sure if we should exit. According to https://docs.hazelcast.com/hazelcast/5.0/configuration/checking-configuration we should check for ".yml" as well and if none is present then load the default configuration

Good point about the yml file. I will add that.

Otherwise, the doc is for embedded use. I am not sure we want to follow the same procedure for our server distribution. Maybe it should be updated what is done for server instead?

Is there a reason why we should have different behavior on server distribution? I could imagine it could be surprising for customers using embedded versions while migrating to the server distribution. Also, it brings additional effort on documentation

I don't think it makes sense for the distribution to try the options done for embedded:

classpath - do we want to encourage users to put config inside custom jars? I don't think so.

working directory - currently that's HAZELCAST_HOME if you run hz-start, but we don't have it documented

the default config in hazelcast jar is not suitable for server distribution (e.g. it opens on all interfaces, instead of just loopback)

fair enough

hz-devops-test · 2021-12-01T10:00:19Z

The job Hazelcast-pr-builder of your PR failed. (Hazelcast internal details: build log, artifacts).
Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log file

--------------------------
-------TEST FAILURE-------
--------------------------
[INFO] Results:
[INFO] 
[ERROR] Failures: 
[ERROR]   Log4jLoggerTest.logEvent_withLogLevelOff_shouldNotLog:131 [Expected 0 log events but got 1] 
Expecting:
 <1>
to be equal to:
 <0>
but was not.
[INFO] 
[ERROR] Tests run: 46543, Failures: 1, Errors: 0, Skipped: 1012
[INFO] 
[ERROR] There are test failures.

frant-hartm · 2021-12-01T10:05:19Z

run-lab-run

kwart

Ah, I think we're missing changes in the batch file.

hz-devops-test · 2021-12-01T15:41:47Z

The job Hazelcast-pr-builder of your PR failed. (Hazelcast internal details: build log, artifacts).
Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log file

--------------------------
-------TEST FAILURE-------
--------------------------
[INFO] Results:
[INFO] 
[ERROR] Failures: 
[ERROR]   ClientMapPartitionLostListenerTest.test_mapPartitionLostListener_invoked_fromOtherNode:133->assertProxyExistsEventually:163->HazelcastTestSupport.assertTrueEventually:1362->HazelcastTestSupport.assertTrueEventually:1260 There is no proxy with name 5ed8ab7e-acad-4c77-9c69-c500e1e21a47 created (yet)
[INFO] 
[ERROR] Tests run: 46543, Failures: 1, Errors: 0, Skipped: 1012
[INFO] 
[ERROR] There are test failures.

kwart · 2021-12-01T16:01:46Z

distribution/src/bin-regular/hz-start.bat

@@ -41,7 +41,16 @@ IF NOT "%JAVA_VERSION%" == "8" (

 REM HAZELCAST_CONFIG holds path to the configuration file. The path is relative to the Hazelcast installation (HAZELCAST_HOME).
 if "x%HAZELCAST_CONFIG%" == "x" (
-    set HAZELCAST_CONFIG=config/hazelcast.xml


I think we want to keep this line.

Yes, that was a mistake.

I changed the slash though, so it still shows as deleted, but it's added below.

* Allow absolute paths in HAZELCAST_CONFIG environment variable (#19908) Allow absolute paths in HAZELCAST_CONFIG and HAZELCAST_CLIENT_CONFIG environment variables * Use hazelcast.yaml when hazelcast.xml is not available Users sometimes prefer to use yaml configuration. When the hazelcast.xml is not available in the config folder then hazelcast.yaml is tried. If hazelcast.yaml is not available error message is shown with guidance what to do. Backport of #20003 and #19908 (for clean backport) Fixes #19727 Co-authored-by: Yüce Tekol <yucetekol@gmail.com>

* Use hazelcast.yaml when hazelcast.xml is not available Users sometimes prefer to use yaml configuration. When the hazelcast.xml is not available in the config folder then hazelcast.yaml is tried. If hazelcast.yaml is not available error message is shown with guidance what to do. Fixes hazelcast#19727

frant-hartm added Type: Enhancement Team: Core Source: Internal PR or issue was opened by an employee Add to Release Notes Module: Scripts labels Dec 1, 2021

frant-hartm added this to the 5.1 milestone Dec 1, 2021

frant-hartm requested review from kwart and ldziedziul December 1, 2021 08:46

frant-hartm mentioned this pull request Dec 1, 2021

Use hazelcast.yaml when hazelcast.xml is not available [5.0.z] #20004

Merged

4 tasks

ldziedziul reviewed Dec 1, 2021

View reviewed changes

Add check for yml file as well

209a36b

ldziedziul approved these changes Dec 1, 2021

View reviewed changes

kwart approved these changes Dec 1, 2021

View reviewed changes

kwart requested changes Dec 1, 2021

View reviewed changes

frant-hartm added 2 commits December 1, 2021 13:14

Update bat script as well

8bc4e7b

Fix the bat file

66fb6ce

kwart reviewed Dec 1, 2021

View reviewed changes

One more fix - should be working now as expected

6e397da

kwart approved these changes Dec 2, 2021

View reviewed changes

frant-hartm merged commit 6750b72 into hazelcast:master Dec 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use hazelcast.yaml when hazelcast.xml is not available #20003

Use hazelcast.yaml when hazelcast.xml is not available #20003

frant-hartm commented Dec 1, 2021 •

edited

Loading

ldziedziul Dec 1, 2021

frant-hartm Dec 1, 2021

ldziedziul Dec 1, 2021

frant-hartm Dec 1, 2021

ldziedziul Dec 1, 2021

hz-devops-test commented Dec 1, 2021

frant-hartm commented Dec 1, 2021

kwart left a comment

hz-devops-test commented Dec 1, 2021

kwart Dec 1, 2021

frant-hartm Dec 1, 2021

frant-hartm Dec 1, 2021 •

edited

Loading

Use hazelcast.yaml when hazelcast.xml is not available #20003

Use hazelcast.yaml when hazelcast.xml is not available #20003

Conversation

frant-hartm commented Dec 1, 2021 • edited Loading

ldziedziul Dec 1, 2021

Choose a reason for hiding this comment

frant-hartm Dec 1, 2021

Choose a reason for hiding this comment

ldziedziul Dec 1, 2021

Choose a reason for hiding this comment

frant-hartm Dec 1, 2021

Choose a reason for hiding this comment

ldziedziul Dec 1, 2021

Choose a reason for hiding this comment

hz-devops-test commented Dec 1, 2021

frant-hartm commented Dec 1, 2021

kwart left a comment

Choose a reason for hiding this comment

hz-devops-test commented Dec 1, 2021

kwart Dec 1, 2021

Choose a reason for hiding this comment

frant-hartm Dec 1, 2021

Choose a reason for hiding this comment

frant-hartm Dec 1, 2021 • edited Loading

Choose a reason for hiding this comment

frant-hartm commented Dec 1, 2021 •

edited

Loading

frant-hartm Dec 1, 2021 •

edited

Loading