-
Notifications
You must be signed in to change notification settings - Fork 478
[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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The prefix should be |
||
} | ||
|
||
public static final ConfigOption<Integer> ABORT_GRACE_PERIOD_MS = | ||
operatorConfig("abortGracePeriodMs") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 Also this config should be |
||
.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") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should be duration type and |
||
.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") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should be duration and |
||
.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, | ||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what state are we in during shutdown? |
||
} |
Uh oh!
There was an error while loading. Please reload this page.