Skip to content

[FLINK-37515] Basic support for Blue/Green deployments #969

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
55 changes: 55 additions & 0 deletions docs/content/docs/custom-resource/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,23 @@ This serves as a full reference for FlinkDeployment and FlinkSessionJob custom r
| Parameter | Type | Docs |
| ----------| ---- | ---- |

### FlinkBlueGreenDeploymentConfigOptions
**Class**: org.apache.flink.kubernetes.operator.api.spec.FlinkBlueGreenDeploymentConfigOptions

**Description**: Configuration options to be used by the Flink Blue/Green Deployments.

| Parameter | Type | Docs |
| ----------| ---- | ---- |

### FlinkBlueGreenDeploymentSpec
**Class**: org.apache.flink.kubernetes.operator.api.spec.FlinkBlueGreenDeploymentSpec

**Description**: Spec that describes a Flink application with blue/green deployment capabilities.

| Parameter | Type | Docs |
| ----------| ---- | ---- |
| template | org.apache.flink.kubernetes.operator.api.spec.FlinkDeploymentTemplateSpec | |

### FlinkDeploymentSpec
**Class**: org.apache.flink.kubernetes.operator.api.spec.FlinkDeploymentSpec

Expand All @@ -78,6 +95,17 @@ This serves as a full reference for FlinkDeployment and FlinkSessionJob custom r
| logConfiguration | java.util.Map<java.lang.String,java.lang.String> | Log configuration overrides for the Flink deployment. Format logConfigFileName -> configContent. |
| mode | org.apache.flink.kubernetes.operator.api.spec.KubernetesDeploymentMode | Deployment mode of the Flink cluster, native or standalone. |

### FlinkDeploymentTemplateSpec
**Class**: org.apache.flink.kubernetes.operator.api.spec.FlinkDeploymentTemplateSpec

**Description**: Template Spec that describes a Flink application managed by the blue/green controller.

| Parameter | Type | Docs |
| ----------| ---- | ---- |
| metadata | io.fabric8.kubernetes.api.model.ObjectMeta | |
| configuration | java.util.Map<java.lang.String,java.lang.String> | |
| spec | org.apache.flink.kubernetes.operator.api.spec.FlinkDeploymentSpec | |

### FlinkSessionJobSpec
**Class**: org.apache.flink.kubernetes.operator.api.spec.FlinkSessionJobSpec

Expand Down Expand Up @@ -290,6 +318,33 @@ This serves as a full reference for FlinkDeployment and FlinkSessionJob custom r
| UNKNOWN | Checkpoint format unknown, if the checkpoint was not triggered by the operator. |
| description | org.apache.flink.configuration.description.InlineElement | |

### FlinkBlueGreenDeploymentState
**Class**: org.apache.flink.kubernetes.operator.api.status.FlinkBlueGreenDeploymentState

**Description**: Enumeration of the possible states of the blue/green transition.

| Value | Docs |
| ----- | ---- |
| INITIALIZING_BLUE | We use this state while initializing for the first time, always with a "Blue" deployment type. |
| ACTIVE_BLUE | Identifies the system is running normally with a "Blue" deployment type. |
| ACTIVE_GREEN | Identifies the system is running normally with a "Green" deployment type. |
| TRANSITIONING_TO_BLUE | Identifies the system is transitioning from "Green" to "Blue". |
| TRANSITIONING_TO_GREEN | Identifies the system is transitioning from "Blue" to "Green". |

### FlinkBlueGreenDeploymentStatus
**Class**: org.apache.flink.kubernetes.operator.api.status.FlinkBlueGreenDeploymentStatus

**Description**: Last observed status of the Flink Blue/Green deployment.

| Parameter | Type | Docs |
| ----------| ---- | ---- |
| jobStatus | org.apache.flink.kubernetes.operator.api.status.JobStatus | |
| blueGreenState | org.apache.flink.kubernetes.operator.api.status.FlinkBlueGreenDeploymentState | The state of the blue/green transition. |
| lastReconciledSpec | java.lang.String | Last reconciled (serialized) deployment spec. |
| lastReconciledTimestamp | java.lang.String | Timestamp of last reconciliation. |
| abortTimestamp | java.lang.String | Computed from abortGracePeriodMs, timestamp after which the deployment should be aborted. |
| deploymentReadyTimestamp | java.lang.String | Timestamp when the deployment became READY/STABLE. Used to determine when to delete it. |

### FlinkDeploymentReconciliationStatus
**Class**: org.apache.flink.kubernetes.operator.api.status.FlinkDeploymentReconciliationStatus

Expand Down
21 changes: 21 additions & 0 deletions flink-kubernetes-operator-api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ under the License.
<include>flinkdeployments.flink.apache.org-v1.yml</include>
<include>flinksessionjobs.flink.apache.org-v1.yml</include>
<include>flinkstatesnapshots.flink.apache.org-v1.yml</include>
<include>flinkbluegreendeployments.flink.apache.org-v1.yml</include>
</includes>
<filtering>false</filtering>
</resource>
Expand All @@ -236,6 +237,8 @@ under the License.
<classpath refid="maven.compile.classpath"/>
<arg value="file://${rootDir}/helm/flink-kubernetes-operator/crds/flinkdeployments.flink.apache.org-v1.yml"/>
<arg value="https://github.com/raw/apache/flink-kubernetes-operator/release-1.9.0/helm/flink-kubernetes-operator/crds/flinkdeployments.flink.apache.org-v1.yml"/>
<arg value="https://github.com/raw/apache/flink-kubernetes-operator/release-1.10.0/helm/flink-kubernetes-operator/crds/flinkdeployments.flink.apache.org-v1.yml"/>
<arg value="https://github.com/raw/apache/flink-kubernetes-operator/release-1.11.0/helm/flink-kubernetes-operator/crds/flinkdeployments.flink.apache.org-v1.yml"/>
</java>
</target>
</configuration>
Expand All @@ -253,6 +256,24 @@ under the License.
<classpath refid="maven.compile.classpath"/>
<arg value="file://${rootDir}/helm/flink-kubernetes-operator/crds/flinksessionjobs.flink.apache.org-v1.yml"/>
<arg value="https://github.com/raw/apache/flink-kubernetes-operator/release-1.9.0/helm/flink-kubernetes-operator/crds/flinksessionjobs.flink.apache.org-v1.yml"/>
<arg value="https://github.com/raw/apache/flink-kubernetes-operator/release-1.10.0/helm/flink-kubernetes-operator/crds/flinksessionjobs.flink.apache.org-v1.yml"/>
<arg value="https://github.com/raw/apache/flink-kubernetes-operator/release-1.11.0/helm/flink-kubernetes-operator/crds/flinksessionjobs.flink.apache.org-v1.yml"/>
</java>
</target>
</configuration>
</execution>
<execution>
<id>flinkbgdeployments-remove-scale-subresource</id>
<phase>package</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<target>
<java classname="org.apache.flink.kubernetes.operator.api.utils.RemoveScaleSubResource"
fork="true" failonerror="true">
<classpath refid="maven.compile.classpath"/>
<arg value="${rootDir}/helm/flink-kubernetes-operator/crds/flinkbluegreendeployments.flink.apache.org-v1.yml"/>
</java>
</target>
</configuration>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.flink.kubernetes.operator.api;

import org.apache.flink.annotation.Experimental;
import org.apache.flink.kubernetes.operator.api.spec.FlinkBlueGreenDeploymentSpec;
import org.apache.flink.kubernetes.operator.api.status.FlinkBlueGreenDeploymentStatus;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.fabric8.kubernetes.api.model.Namespaced;
import io.fabric8.kubernetes.client.CustomResource;
import io.fabric8.kubernetes.model.annotation.Group;
import io.fabric8.kubernetes.model.annotation.ShortNames;
import io.fabric8.kubernetes.model.annotation.Version;

/** Custom resource definition that represents a deployments with Blue/Green rollout capability. */
@Experimental
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonDeserialize()
@Group(CrdConstants.API_GROUP)
@Version(CrdConstants.API_VERSION)
@ShortNames({"flinkbgdep"})
public class FlinkBlueGreenDeployment
extends CustomResource<FlinkBlueGreenDeploymentSpec, FlinkBlueGreenDeploymentStatus>
implements Namespaced {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.flink.kubernetes.operator.api.bluegreen;

import org.apache.flink.kubernetes.operator.api.FlinkDeployment;

/**
* Enumeration of the two possible Flink Blue/Green deployment types. Only one of each type will be
* present at all times for a particular job.
*/
public enum DeploymentType {
/** Identifier for the first or "Blue" deployment type. */
BLUE,

/** Identifier for the second or "Green" deployment type. */
GREEN;

public static final String LABEL_KEY = "flink/blue-green-deployment-type";

public static DeploymentType fromDeployment(FlinkDeployment flinkDeployment) {
String typeAnnotation = flinkDeployment.getMetadata().getLabels().get(LABEL_KEY);
return DeploymentType.valueOf(typeAnnotation);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.flink.kubernetes.operator.api.spec;

import org.apache.flink.configuration.ConfigOption;
import org.apache.flink.configuration.ConfigOptions;

/** Configuration options to be used by the Flink Blue/Green Deployments. */
public class FlinkBlueGreenDeploymentConfigOptions {

public static final String BLUE_GREEN_CONF_PREFIX = "bluegreen.";

public static final int MIN_ABORT_GRACE_PERIOD_MS = 120000; // 2 mins

public static ConfigOptions.OptionBuilder operatorConfig(String key) {
return ConfigOptions.key(BLUE_GREEN_CONF_PREFIX + key);
Copy link
Contributor

Choose a reason for hiding this comment

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

The prefix should be KubernetesOperatorConfigOptions.K8S_OP_CONF_PREFIX + BLUE_GREEN_CONF_PREFIX

}

public static final ConfigOption<Integer> ABORT_GRACE_PERIOD_MS =
operatorConfig("abortGracePeriodMs")
Copy link
Contributor

Choose a reason for hiding this comment

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

Config options should not be camel cased but yaml-key style. Look at KubernetesOperatorConfigOptions
abort.grace-period

Also this config should be Duration type

.intType()
.defaultValue(0)
.withDescription(
"The max time to wait for a deployment to become ready before aborting it, in milliseconds. Cannot be smaller than 2 minutes.");

public static final ConfigOption<Integer> RECONCILIATION_RESCHEDULING_INTERVAL_MS =
operatorConfig("reconciliationReschedulingIntervalMs")
Copy link
Contributor

Choose a reason for hiding this comment

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

Should be duration type and reconciliation.reschedule.interval or reconciliation.reschedule-interval

.intType()
.defaultValue(15000) // 15 seconds
.withDescription(
"Configurable delay in milliseconds to use when the operator reschedules a reconciliation.");

public static final ConfigOption<Integer> DEPLOYMENT_DELETION_DELAY_MS =
operatorConfig("deploymentDeletionDelayMs")
Copy link
Contributor

Choose a reason for hiding this comment

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

Should be duration and deployment-deletion.delay

.intType()
.defaultValue(0)
.withDescription(
"Configurable delay before deleting a deployment after being marked done.");
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.flink.kubernetes.operator.api.spec;

import org.apache.flink.annotation.Experimental;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/** Spec that describes a Flink application with blue/green deployment capabilities. */
@Experimental
@Data
@NoArgsConstructor
@AllArgsConstructor
@JsonIgnoreProperties(ignoreUnknown = true)
public class FlinkBlueGreenDeploymentSpec {

private FlinkDeploymentTemplateSpec template;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.flink.kubernetes.operator.api.spec;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.fabric8.kubernetes.api.model.ObjectMeta;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.SuperBuilder;

import java.util.LinkedHashMap;
import java.util.Map;

/** Template Spec that describes a Flink application managed by the blue/green controller. */
@AllArgsConstructor
@NoArgsConstructor
@Data
@SuperBuilder
public class FlinkDeploymentTemplateSpec {

@JsonProperty("metadata")
private ObjectMeta metadata;

@JsonProperty("configuration")
private Map<String, String> configuration;

@JsonProperty("spec")
private FlinkDeploymentSpec spec;

@JsonIgnore
private Map<String, Object> additionalProperties = new LinkedHashMap<String, Object>();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.flink.kubernetes.operator.api.status;

/** Enumeration of the possible states of the blue/green transition. */
public enum FlinkBlueGreenDeploymentState {

/**
* We use this state while initializing for the first time, always with a "Blue" deployment
* type.
*/
INITIALIZING_BLUE,

/** Identifies the system is running normally with a "Blue" deployment type. */
ACTIVE_BLUE,

/** Identifies the system is running normally with a "Green" deployment type. */
ACTIVE_GREEN,

/** Identifies the system is transitioning from "Green" to "Blue". */
TRANSITIONING_TO_BLUE,

/** Identifies the system is transitioning from "Blue" to "Green". */
TRANSITIONING_TO_GREEN,

Choose a reason for hiding this comment

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

what state are we in during shutdown?

}
Loading
Loading