feat: Autoscaler #1077
There are no files selected for viewing
This file contains 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 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 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 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,153 @@ | ||
| // Copyright 2022 Google LLC | ||
| // | ||
| // Licensed 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 | ||
| // | ||
| // https://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. | ||
|
|
||
| import * as protos from '../../protos/protos'; | ||
| import { | ||
| BasicClusterConfig, | ||
| ICluster, | ||
| SetClusterMetadataOptions, | ||
| } from '../cluster'; | ||
| import {google} from '../../protos/protos'; | ||
|
|
||
| export class ClusterUtils { | ||
| static noConfigError = | ||
| 'Must specify either serve_nodes or all of the autoscaling configurations (min_serve_nodes, max_serve_nodes, and cpu_utilization_percent).'; | ||
| static allConfigError = | ||
| 'Cannot specify both serve_nodes and autoscaling configurations (min_serve_nodes, max_serve_nodes, and cpu_utilization_percent).'; | ||
| static incompleteConfigError = | ||
| 'All of autoscaling configurations must be specified at the same time (min_serve_nodes, max_serve_nodes, and cpu_utilization_percent).'; | ||
|
|
||
| static validateClusterMetadata( | ||
| metadata: SetClusterMetadataOptions | BasicClusterConfig | ||
| ): void { | ||
| if (metadata.nodes) { | ||
| if ( | ||
| metadata.minServeNodes || | ||
| metadata.maxServeNodes || | ||
| metadata.cpuUtilizationPercent | ||
| ) { | ||
| throw new Error(this.allConfigError); | ||
| } | ||
| } else { | ||
| if ( | ||
| metadata.minServeNodes || | ||
| metadata.maxServeNodes || | ||
| metadata.cpuUtilizationPercent | ||
| ) { | ||
| if ( | ||
| !( | ||
| metadata.minServeNodes && | ||
| metadata.maxServeNodes && | ||
| metadata.cpuUtilizationPercent | ||
| ) | ||
| ) { | ||
| throw new Error(this.incompleteConfigError); | ||
| } | ||
| } else { | ||
| throw new Error(this.noConfigError); | ||
| } | ||
| } | ||
| } | ||
| static getUpdateMask(metadata: SetClusterMetadataOptions): string[] { | ||
| const updateMask: string[] = []; | ||
| if (metadata.nodes) { | ||
| updateMask.push('serve_nodes'); | ||
| if ( | ||
| !( | ||
| metadata.minServeNodes || | ||
| metadata.maxServeNodes || | ||
| metadata.cpuUtilizationPercent | ||
| ) | ||
| ) { | ||
| updateMask.push('cluster_config.cluster_autoscaling_config'); | ||
| } | ||
| } | ||
| if (metadata.minServeNodes) { | ||
| updateMask.push( | ||
| 'cluster_config.cluster_autoscaling_config.autoscaling_limits.min_serve_nodes' | ||
| ); | ||
| } | ||
| if (metadata.maxServeNodes) { | ||
| updateMask.push( | ||
| 'cluster_config.cluster_autoscaling_config.autoscaling_limits.max_serve_nodes' | ||
| ); | ||
| } | ||
| if (metadata.cpuUtilizationPercent) { | ||
| updateMask.push( | ||
| 'cluster_config.cluster_autoscaling_config.autoscaling_targets.cpu_utilization_percent' | ||
| ); | ||
| } | ||
| return updateMask; | ||
| } | ||
|
|
||
| static getClusterBaseConfig( | ||
| metadata: SetClusterMetadataOptions | BasicClusterConfig, | ||
| location: string | undefined | null, | ||
| name: string | undefined | ||
| ): google.bigtable.admin.v2.ICluster { | ||
| let clusterConfig; | ||
| if ( | ||
| metadata.cpuUtilizationPercent || | ||
| metadata.minServeNodes || | ||
| metadata.maxServeNodes | ||
|
There was a problem hiding this comment. what happens if only one of these are set? Let's say There was a problem hiding this comment. When we use this in There was a problem hiding this comment. When creating instances we now validate inputs. |
||
| ) { | ||
| clusterConfig = { | ||
| clusterAutoscalingConfig: { | ||
| autoscalingTargets: { | ||
| cpuUtilizationPercent: metadata.cpuUtilizationPercent, | ||
| }, | ||
| autoscalingLimits: { | ||
| minServeNodes: metadata.minServeNodes, | ||
| maxServeNodes: metadata.maxServeNodes, | ||
| }, | ||
| }, | ||
| }; | ||
| } | ||
| return Object.assign( | ||
| {}, | ||
| name ? {name} : null, | ||
| location ? {location} : null, | ||
| clusterConfig ? {clusterConfig} : null, | ||
| metadata.nodes ? {serveNodes: metadata.nodes} : null | ||
| ); | ||
| } | ||
|
|
||
| static getClusterFromMetadata( | ||
| metadata: SetClusterMetadataOptions, | ||
| location: string | undefined | null, | ||
| name: string | ||
| ): google.bigtable.admin.v2.ICluster { | ||
| const cluster: ICluster | SetClusterMetadataOptions = Object.assign( | ||
| {}, | ||
| this.getClusterBaseConfig(metadata, location, name), | ||
| metadata | ||
| ); | ||
| delete (cluster as SetClusterMetadataOptions).nodes; | ||
| delete (cluster as SetClusterMetadataOptions).minServeNodes; | ||
| delete (cluster as SetClusterMetadataOptions).maxServeNodes; | ||
| delete (cluster as SetClusterMetadataOptions).cpuUtilizationPercent; | ||
| return cluster as ICluster; | ||
| } | ||
|
|
||
| static getRequestFromMetadata( | ||
| metadata: SetClusterMetadataOptions, | ||
| location: string | undefined | null, | ||
| name: string | ||
| ): protos.google.bigtable.admin.v2.IPartialUpdateClusterRequest { | ||
| return { | ||
| cluster: this.getClusterFromMetadata(metadata, location, name), | ||
| updateMask: {paths: this.getUpdateMask(metadata)}, | ||
| }; | ||
| } | ||
| } | ||
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.
is this considered breaking if we change something from required to optional? I'm guessing it would be the other way around, but want to confirm :)
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.
Here we are changing something from required to optional so that would make it not a breaking change since users can still pass just
nodesin. This is where we makenodesoptional because instead the user can provide autoscaling parameters. These parameters will be validated against a new validation function and an error will be thrown if an invalid combination of parameters are provided.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 would not consider switching from required to optional for TypeScript breaking 👍