|
| 1 | +/** |
| 2 | + * Copyright 2025 Google LLC |
| 3 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | + * you may not use this file except in compliance with the License. |
| 5 | + * You may obtain a copy of the License at |
| 6 | + * |
| 7 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | + * |
| 9 | + * Unless required by applicable law or agreed to in writing, software |
| 10 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | + * See the License for the specific language governing permissions and |
| 13 | + * limitations under the License. |
| 14 | + */ |
| 15 | + |
| 16 | +// sample-metadata: |
| 17 | +// title: Creates a instance with asymmetric autoscaling config. |
| 18 | +// usage: node instance-with-asymmetric-autoscaling-config.js <INSTANCE_ID> <PROJECT_ID> |
| 19 | + |
| 20 | +'use strict'; |
| 21 | + |
| 22 | +function main(instanceId = 'my-instance', projectId = 'my-project-id') { |
| 23 | + async function createInstanceWithAsymmetricAutoscalingConfig() { |
| 24 | + // [START spanner_create_instance_with_asymmetric_autoscaling_config] |
| 25 | + // Imports the Google Cloud client library |
| 26 | + const {Spanner, protos} = require('@google-cloud/spanner'); |
| 27 | + |
| 28 | + /** |
| 29 | + * TODO(developer): Uncomment the following lines before running the sample. |
| 30 | + */ |
| 31 | + // const projectId = 'my-project-id'; |
| 32 | + // const instanceId = 'my-instance'; |
| 33 | + |
| 34 | + // Creates a client |
| 35 | + const spanner = new Spanner({ |
| 36 | + projectId: projectId, |
| 37 | + }); |
| 38 | + |
| 39 | + // Get the instance admin client |
| 40 | + const instanceAdminClient = spanner.getInstanceAdminClient(); |
| 41 | + |
| 42 | + const autoscalingConfig = |
| 43 | + protos.google.spanner.admin.instance.v1.AutoscalingConfig.create({ |
| 44 | + // Only one of minNodes/maxNodes or minProcessingUnits/maxProcessingUnits can be set. |
| 45 | + autoscalingLimits: |
| 46 | + protos.google.spanner.admin.instance.v1.AutoscalingConfig.AutoscalingLimits.create( |
| 47 | + { |
| 48 | + minNodes: 1, |
| 49 | + maxNodes: 2, |
| 50 | + } |
| 51 | + ), |
| 52 | + // highPriorityCpuUtilizationPercent and storageUtilizationPercent are both |
| 53 | + // percentages and must lie between 0 and 100. |
| 54 | + autoscalingTargets: |
| 55 | + protos.google.spanner.admin.instance.v1.AutoscalingConfig.AutoscalingTargets.create( |
| 56 | + { |
| 57 | + highPriorityCpuUtilizationPercent: 65, |
| 58 | + storageUtilizationPercent: 95, |
| 59 | + } |
| 60 | + ), |
| 61 | + // The read-only replicas listed in the asymmetric autoscaling options scale independently |
| 62 | + // from other replicas. |
| 63 | + asymmetricAutoscalingOptions: [ |
| 64 | + protos.google.spanner.admin.instance.v1.AutoscalingConfig.AsymmetricAutoscalingOption.create( |
| 65 | + { |
| 66 | + replicaSelection: |
| 67 | + protos.google.spanner.admin.instance.v1.ReplicaSelection.create( |
| 68 | + { |
| 69 | + location: 'europe-west1', |
| 70 | + } |
| 71 | + ), |
| 72 | + } |
| 73 | + ), |
| 74 | + protos.google.spanner.admin.instance.v1.AutoscalingConfig.AsymmetricAutoscalingOption.create( |
| 75 | + { |
| 76 | + replicaSelection: |
| 77 | + protos.google.spanner.admin.instance.v1.ReplicaSelection.create( |
| 78 | + { |
| 79 | + location: 'europe-west4', |
| 80 | + } |
| 81 | + ), |
| 82 | + } |
| 83 | + ), |
| 84 | + protos.google.spanner.admin.instance.v1.AutoscalingConfig.AsymmetricAutoscalingOption.create( |
| 85 | + { |
| 86 | + replicaSelection: |
| 87 | + protos.google.spanner.admin.instance.v1.ReplicaSelection.create( |
| 88 | + { |
| 89 | + location: 'asia-east1', |
| 90 | + } |
| 91 | + ), |
| 92 | + } |
| 93 | + ), |
| 94 | + ], |
| 95 | + }); |
| 96 | + |
| 97 | + // Creates a new instance with autoscaling configuration and asymmetric autoscaling option |
| 98 | + // When autoscalingConfig is enabled, nodeCount and processingUnits fields |
| 99 | + // need not be specified. |
| 100 | + try { |
| 101 | + console.log( |
| 102 | + `Creating instance ${instanceAdminClient.instancePath( |
| 103 | + projectId, |
| 104 | + instanceId |
| 105 | + )}.` |
| 106 | + ); |
| 107 | + const [operation] = await instanceAdminClient.createInstance({ |
| 108 | + instanceId: instanceId, |
| 109 | + parent: instanceAdminClient.projectPath(projectId), |
| 110 | + instance: { |
| 111 | + config: instanceAdminClient.instanceConfigPath( |
| 112 | + projectId, |
| 113 | + 'nam-eur-asia3' |
| 114 | + ), |
| 115 | + displayName: 'Display name for the instance.', |
| 116 | + autoscalingConfig: autoscalingConfig, |
| 117 | + labels: { |
| 118 | + cloud_spanner_samples: 'true', |
| 119 | + created: Math.round(Date.now() / 1000).toString(), // current time |
| 120 | + }, |
| 121 | + // Feature MULTI_REGION is available only for ENTERPRISE_PLUS edition |
| 122 | + edition: |
| 123 | + protos.google.spanner.admin.instance.v1.Instance.Edition |
| 124 | + .ENTERPRISE_PLUS, |
| 125 | + }, |
| 126 | + }); |
| 127 | + |
| 128 | + console.log(`Waiting for operation on ${instanceId} to complete...`); |
| 129 | + await operation.promise(); |
| 130 | + console.log(`Created instance ${instanceId}.`); |
| 131 | + |
| 132 | + // get instance metadata |
| 133 | + const [metadata] = await instanceAdminClient.getInstance({ |
| 134 | + name: instanceAdminClient.instancePath(projectId, instanceId), |
| 135 | + }); |
| 136 | + console.log( |
| 137 | + `Autoscaling configurations of ${instanceId} are: ` + |
| 138 | + '\n' + |
| 139 | + `Min nodes: ${metadata.autoscalingConfig.autoscalingLimits.minNodes} ` + |
| 140 | + 'nodes.' + |
| 141 | + '\n' + |
| 142 | + `Max nodes: ${metadata.autoscalingConfig.autoscalingLimits.maxNodes}` + |
| 143 | + ' nodes.' + |
| 144 | + '\n' + |
| 145 | + `High priority cpu utilization percent: ${metadata.autoscalingConfig.autoscalingTargets.highPriorityCpuUtilizationPercent}.` + |
| 146 | + '\n' + |
| 147 | + `Storage utilization percent: ${metadata.autoscalingConfig.autoscalingTargets.storageUtilizationPercent}.` + |
| 148 | + '\n' + |
| 149 | + `Asymmetric Autoscaling Options: ${ |
| 150 | + metadata.autoscalingConfig.asymmetricAutoscalingOptions && |
| 151 | + metadata.autoscalingConfig.asymmetricAutoscalingOptions.length > 0 |
| 152 | + ? metadata.autoscalingConfig.asymmetricAutoscalingOptions |
| 153 | + .map(option => |
| 154 | + option.replicaSelection && option.replicaSelection.location |
| 155 | + ? option.replicaSelection.location |
| 156 | + : 'N/A' |
| 157 | + ) |
| 158 | + .join(', ') |
| 159 | + : 'None' |
| 160 | + }` |
| 161 | + ); |
| 162 | + } catch (err) { |
| 163 | + console.error('ERROR:', err); |
| 164 | + } |
| 165 | + // [END spanner_create_instance_with_asymmetric_autoscaling_config] |
| 166 | + } |
| 167 | + createInstanceWithAsymmetricAutoscalingConfig(); |
| 168 | +} |
| 169 | + |
| 170 | +process.on('unhandledRejection', err => { |
| 171 | + console.error(err.message); |
| 172 | + process.exitCode = 1; |
| 173 | +}); |
| 174 | +main(...process.argv.slice(2)); |
0 commit comments