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.

Sign up for GitHub

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

[hotfix] Fix the issue related to mounting the Logback configuration … #25995

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+58 −9
Open

[hotfix] Fix the issue related to mounting the Logback configuration … #25995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions .../main/java/org/apache/flink/kubernetes/kubeclient/decorators/FlinkConfMountDecorator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,7 @@
import java.util.Map;
import java.util.stream.Collectors;

import static org.apache.flink.kubernetes.utils.Constants.CONFIG_FILE_LOG4J_NAME;
import static org.apache.flink.kubernetes.utils.Constants.CONFIG_FILE_LOGBACK_NAME;
import static org.apache.flink.kubernetes.utils.Constants.CONFIG_FILE_NAME_LIST;
import static org.apache.flink.kubernetes.utils.Constants.CONFIG_MAP_PREFIX;
import static org.apache.flink.kubernetes.utils.Constants.FLINK_CONF_VOLUME;
import static org.apache.flink.util.Preconditions.checkNotNull;
Expand Down Expand Up @@ -179,15 +178,14 @@ String getFlinkConfData(List<String> confData) throws IOException {

private List<File> getLocalLogConfFiles() {
final String confDir = kubernetesComponentConf.getConfigDirectory();
final File logbackFile = new File(confDir, CONFIG_FILE_LOGBACK_NAME);
final File log4jFile = new File(confDir, CONFIG_FILE_LOG4J_NAME);

List<File> localLogConfFiles = new ArrayList<>();
if (logbackFile.exists()) {
localLogConfFiles.add(logbackFile);
}
if (log4jFile.exists()) {
localLogConfFiles.add(log4jFile);

for (String fileName : CONFIG_FILE_NAME_LIST) {
Copy link
Contributor

Choose a reason for hiding this comment

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

can we have a junit for this this please.

Copy link
Author

Choose a reason for hiding this comment

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

Thank you for your suggestions. I have made improvements. Please review.

final File file = new File(confDir, fileName);
if (file.exists()) {
localLogConfFiles.add(file);
}
}

return localLogConfFiles;
Expand Down
13 changes: 13 additions & 0 deletions flink-kubernetes/src/main/java/org/apache/flink/kubernetes/utils/Constants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@

package org.apache.flink.kubernetes.utils;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/** Constants for kubernetes. */
public class Constants {

Expand All @@ -30,6 +34,15 @@ public class Constants {

public static final String CONFIG_FILE_LOGBACK_NAME = "logback-console.xml";
public static final String CONFIG_FILE_LOG4J_NAME = "log4j-console.properties";
public static final List<String> CONFIG_FILE_NAME_LIST = Arrays.asList(
"logback.xml",
Jam804 marked this conversation as resolved.
Show resolved Hide resolved
"log4j.properties",
"logback-console.xml",
"log4j-console.properties",
"logback-session.xml",
"log4j-session.properties",
"log4j-cli.properties"
);
public static final String ENV_FLINK_LOG_DIR = "FLINK_LOG_DIR";

public static final String MAIN_CONTAINER_NAME = "flink-main-container";
Expand Down
38 changes: 38 additions & 0 deletions ...t/java/org/apache/flink/kubernetes/kubeclient/decorators/FlinkConfMountDecoratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
import org.junit.jupiter.api.Test;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
Expand All @@ -47,6 +48,7 @@
import static org.apache.flink.kubernetes.kubeclient.decorators.FlinkConfMountDecorator.getFlinkConfConfigMapName;
import static org.apache.flink.kubernetes.utils.Constants.CONFIG_FILE_LOG4J_NAME;
import static org.apache.flink.kubernetes.utils.Constants.CONFIG_FILE_LOGBACK_NAME;
import static org.apache.flink.kubernetes.utils.Constants.CONFIG_FILE_NAME_LIST;
import static org.assertj.core.api.Assertions.assertThat;

/** General tests for the {@link FlinkConfMountDecorator}. */
Expand Down Expand Up @@ -233,6 +235,42 @@ void testDecoratedFlinkPodWithLog4jAndLogback() throws IOException {
.isEqualTo(expectedVolumes);
}

@Test
void testDecoratedFlinkPodWithAllLog4jAndLogback() throws IOException {

for (String fileName : CONFIG_FILE_NAME_LIST) {
KubernetesTestUtils.createTemporyFile("some data", flinkConfDir, fileName);
}

final FlinkPod resultFlinkPod = flinkConfMountDecorator.decorateFlinkPod(baseFlinkPod);

final List<KeyToPath> expectedKeyToPaths = new ArrayList<>();
for (String fileName : CONFIG_FILE_NAME_LIST) {
KeyToPath keyToPath = new KeyToPathBuilder()
.withKey(fileName)
.withPath(fileName)
.build();
expectedKeyToPaths.add(keyToPath);
}
expectedKeyToPaths.add(
new KeyToPathBuilder()
.withKey(FLINK_CONF_FILENAME)
.withPath(FLINK_CONF_FILENAME)
.build());

final List<Volume> expectedVolumes =
Collections.singletonList(
new VolumeBuilder()
.withName(Constants.FLINK_CONF_VOLUME)
.withNewConfigMap()
.withName(getFlinkConfConfigMapName(CLUSTER_ID))
.withItems(expectedKeyToPaths)
.endConfigMap()
.build());
assertThat(resultFlinkPod.getPodWithoutMainContainer().getSpec().getVolumes())
.isEqualTo(expectedVolumes);
}

@Test
void testDecoratedFlinkContainer() {
final Container resultMainContainer =
Expand Down