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

[FLINK-27163] Add label for the session job to help list the session … #215

Closed
wants to merge 2 commits into from
Closed

[FLINK-27163] Add label for the session job to help list the session … #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
916c6c1
[FLINK-27613] Add label for the session job to help list the session …
May 14, 2022
af88aea
fix by comments
May 15, 2022
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
23 changes: 23 additions & 0 deletions ...org/apache/flink/kubernetes/operator/reconciler/sessionjob/FlinkSessionJobReconciler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,14 @@

import javax.annotation.Nullable;

import java.util.HashMap;
import java.util.Optional;

/** The reconciler for the {@link FlinkSessionJob}. */
public class FlinkSessionJobReconciler implements Reconciler<FlinkSessionJob> {

private static final Logger LOG = LoggerFactory.getLogger(FlinkSessionJobReconciler.class);
public static final String LABEL_TARGET_SESSION = "target.session";

private final FlinkConfigManager configManager;
private final KubernetesClient kubernetesClient;
Expand Down Expand Up @@ -76,6 +78,8 @@ public void reconcile(FlinkSessionJob flinkSessionJob, Context context) throws E
OperatorUtils.getSecondaryResource(
flinkSessionJob, context, configManager.getOperatorConfiguration());

patchInternalLabel(flinkSessionJob);

// if session cluster is not ready, we can't do reconcile for the job.
if (!helper.sessionClusterReady(flinkDepOptional)) {
return;
Expand Down Expand Up @@ -211,4 +215,23 @@ private void triggerSavepoint(FlinkSessionJob sessionJob, Configuration effectiv
sessionJob.getStatus().getJobStatus().getSavepointInfo(),
effectiveConfig);
}

private void patchInternalLabel(FlinkSessionJob flinkSessionJob) {
var labels = flinkSessionJob.getMetadata().getLabels();
if (labels == null) {
labels = new HashMap<>();
}
if (!flinkSessionJob
.getSpec()
.getDeploymentName()
.equals(labels.get(LABEL_TARGET_SESSION))) {
labels.put(LABEL_TARGET_SESSION, flinkSessionJob.getSpec().getDeploymentName());
flinkSessionJob.getMetadata().setLabels(labels);
kubernetesClient
.resources(FlinkSessionJob.class)
.inNamespace(flinkSessionJob.getMetadata().getNamespace())
.withName(flinkSessionJob.getMetadata().getName())
.patch(flinkSessionJob);
}
}
}
5 changes: 5 additions & 0 deletions flink-kubernetes-operator/src/test/java/org/apache/flink/kubernetes/operator/TestUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
import org.apache.flink.kubernetes.operator.metrics.MetricManager;
import org.apache.flink.kubernetes.operator.observer.deployment.ObserverFactory;
import org.apache.flink.kubernetes.operator.reconciler.deployment.ReconcilerFactory;
import org.apache.flink.kubernetes.operator.reconciler.sessionjob.FlinkSessionJobReconciler;
import org.apache.flink.kubernetes.operator.utils.StatusHelper;
import org.apache.flink.kubernetes.operator.utils.ValidatorUtils;
import org.apache.flink.metrics.testutils.MetricListener;
Expand Down Expand Up @@ -131,6 +132,10 @@ public static FlinkSessionJob buildSessionJob() {
new ObjectMetaBuilder()
.withName(TEST_SESSION_JOB_NAME)
.withNamespace(TEST_NAMESPACE)
.withLabels(
Map.of(
FlinkSessionJobReconciler.LABEL_TARGET_SESSION,
TEST_DEPLOYMENT_NAME))
.build());
sessionJob.setSpec(
FlinkSessionJobSpec.builder()
Expand Down
36 changes: 36 additions & 0 deletions ...apache/flink/kubernetes/operator/reconciler/sessionjob/FlinkSessionJobReconcilerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,16 @@
import org.apache.flink.kubernetes.operator.TestingFlinkService;
import org.apache.flink.kubernetes.operator.config.FlinkConfigManager;
import org.apache.flink.kubernetes.operator.config.KubernetesOperatorConfigOptions;
import org.apache.flink.kubernetes.operator.crd.CrdConstants;
import org.apache.flink.kubernetes.operator.crd.FlinkSessionJob;
import org.apache.flink.kubernetes.operator.crd.spec.JobState;
import org.apache.flink.kubernetes.operator.crd.spec.UpgradeMode;
import org.apache.flink.kubernetes.operator.crd.status.JobStatus;
import org.apache.flink.kubernetes.operator.reconciler.ReconciliationUtils;

import io.fabric8.kubernetes.client.KubernetesClient;
import io.fabric8.kubernetes.client.server.mock.EnableKubernetesMockClient;
import io.fabric8.kubernetes.client.server.mock.KubernetesMockServer;
import io.javaoperatorsdk.operator.api.reconciler.Context;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
Expand All @@ -43,9 +47,12 @@
import static org.junit.jupiter.api.Assertions.assertTrue;

/** Tests for {@link FlinkSessionJobReconciler}. */
@EnableKubernetesMockClient(crud = true)
public class FlinkSessionJobReconcilerTest {

private final FlinkConfigManager configManager = new FlinkConfigManager(new Configuration());
private KubernetesMockServer mockServer;
private KubernetesClient kubernetesClient;

@Test
public void testSubmitAndCleanUp() throws Exception {
Expand Down Expand Up @@ -420,4 +427,33 @@ public void testJobUpgradeIgnorePendingSavepoint() throws Exception {
spSessionJob.getStatus().getJobStatus().getSavepointInfo().getTriggerId());
assertEquals(JobState.SUSPENDED.name(), spSessionJob.getStatus().getJobStatus().getState());
}

@Test
public void testSetSessionLabel() throws Exception {
TestingFlinkService flinkService = new TestingFlinkService();
FlinkSessionJob sessionJob = TestUtils.buildSessionJob();
sessionJob.getMetadata().getLabels().clear();

FlinkSessionJobReconciler reconciler =
new FlinkSessionJobReconciler(kubernetesClient, flinkService, configManager);

var path =
String.format(
"/apis/%s/%s/namespaces/%s/%s/%s",
CrdConstants.API_GROUP,
CrdConstants.API_VERSION,
sessionJob.getMetadata().getNamespace(),
sessionJob.getPlural(),
sessionJob.getMetadata().getName());

mockServer.expect().get().withPath(path).andReturn(200, sessionJob).once();
mockServer.expect().patch().withPath(path).andReturn(200, sessionJob).once();
reconciler.reconcile(sessionJob, TestUtils.createEmptyContext());
Assertions.assertEquals(
TestUtils.TEST_DEPLOYMENT_NAME,
sessionJob
.getMetadata()
.getLabels()
.get(FlinkSessionJobReconciler.LABEL_TARGET_SESSION));
}
}