[FLINK-37515] Basic support for Blue/Green deployments #969
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 {} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 { | ||
schongloo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| /** Identifier for the first or "Blue" deployment type. */ | ||
| BLUE, | ||
schongloo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /** 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); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| import java.time.Duration; | ||
|
|
||
| /** Configuration options to be used by the Flink Blue/Green Deployments. */ | ||
| public class FlinkBlueGreenDeploymentConfigOptions { | ||
|
|
||
| public static final String K8S_OP_CONF_PREFIX = "kubernetes.operator."; | ||
|
|
||
| public static final String BLUE_GREEN_CONF_PREFIX = K8S_OP_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); | ||
gyfora marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| public static final ConfigOption<Duration> ABORT_GRACE_PERIOD = | ||
| operatorConfig("abort.grace-period") | ||
| .durationType() | ||
| .defaultValue(Duration.ofMillis(MIN_ABORT_GRACE_PERIOD_MS)) | ||
| .withDescription( | ||
| "The max time to wait in milliseconds for a deployment to become ready before aborting it. Cannot be smaller than 2 minutes."); | ||
|
|
||
| public static final ConfigOption<Duration> RECONCILIATION_RESCHEDULING_INTERVAL = | ||
| operatorConfig("reconciliation.reschedule-interval") | ||
| .durationType() | ||
| .defaultValue(Duration.ofMillis(15000)) // 15 seconds | ||
| .withDescription( | ||
| "Configurable delay in milliseconds to use when the operator reschedules a reconciliation."); | ||
|
There was a problem hiding this comment. I suggest including some advice as to what to set this to in different circumstances. Same for deployment-deletion.delay |
||
|
|
||
| public static final ConfigOption<Duration> DEPLOYMENT_DELETION_DELAY = | ||
|
There was a problem hiding this comment. These configs are not being used. Is there an intent to use them later ? |
||
| operatorConfig("deployment-deletion.delay") | ||
| .durationType() | ||
| .defaultValue(Duration.ofMillis(0)) | ||
| .withDescription( | ||
| "Configurable delay in milliseconds before deleting a deployment after being marked done."); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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>(); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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, | ||
schongloo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /** 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, | ||
|
There was a problem hiding this comment. what state are we in during shutdown? There was a problem hiding this comment. The (old) deployments are deleted once the new ones are RUNNING and STABLE, this is the last step during the TRANSITION_TO_* state. |
||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should define the Blue Green deployment concept some where in the docs, ideally with diagrams.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've (temporarily) added a diagram to the PR description of the actual state machine, we can find it a final location later.
Also the pages for both FLIP-503 and FLIP-504 have higher level (simplified) concept diagrams.
Does this help?