This repository has been archived by the owner on Jul 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(samples): add usage samples to show handling of LRO response Ope…
…ration (#519) * improvements: add samples * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * test: add tests for the samples * fix: merge conflict * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * cleanup: rearrange region tags * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix: replace beforeEach with before * fix: failing test cases * cleanup: rearrange code lines * test: fix the timeout and race issues in tests * cleanup: rename fn * fix: mocha test definition * cleanup: change console log * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix: failing test due package * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix: linting errors * fix: add netowkr as arg * lint: fix test js * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * test: add ci network to test * cleanup: ammend as per PR comments * cleanup: remove unused dep * fix: test case * doc: add explanation to the test util file * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * doc: fix typos * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * lint: fix errors * fix: move after block Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
1 parent
e09cc06
commit 7e4c76e
Showing
10 changed files
with
627 additions
and
22 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| // 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 | ||
| // | ||
| // 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. | ||
|
|
||
| 'use strict'; | ||
|
|
||
| /** | ||
| * Entrypoint into the sample. Expects three arguments to the program. | ||
| * 1. The name to give to the new GKE cluster | ||
| * 2. The GCP Zone to use | ||
| * 3. The GCP VPC Network to use | ||
| * | ||
| * > node create_cluster.js <CLUSTER_NAME> <GCP_ZONE> <GCP_VPC_NETWORK> | ||
| */ | ||
| async function main( | ||
| clusterName = 'Name to be given to the GKE cluster', | ||
| clusterZone = 'Location where the cluster is to be created', | ||
| clusterNetwork = 'VPC network to which the cluster nodes will be attached to' | ||
| ) { | ||
| // [START gke_create_cluster] | ||
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const clusterName = 'sample-gke-cluster'; | ||
| // const clusterZone = 'us-central1-c'; | ||
| // const clusterNetwork = 'default' | ||
|
|
||
| // load the google-cloud nodejs library for GKE | ||
| const container = require('@google-cloud/container'); | ||
| // assign the operation status enum to a variable for easy access | ||
| const STATUS_ENUM = container.protos.google.container.v1.Operation.Status; | ||
| // define fib(0) for the fibonacci series we use for delay calculation | ||
| let prevFibonacciDelay = 0; | ||
|
|
||
| /** | ||
| * This function calls the `getOperation` API to fetch the details of a specific | ||
| * operation and checks for its completion. It returns the defined function | ||
| * wrapped in a Promise. The function it defines takes in a google cloud client | ||
| * along with the unique identifier of the operation we want to check. | ||
| * | ||
| * The response to the defined function is a 'Promise.reject' if the operation | ||
| * is still not complete and a 'Promise.resolve' if it is complete. | ||
| * | ||
| * @param {container.vq.ClusterManagerClient} client the google cloud API client used to submit the request | ||
| * @param {string} opId the unique identifier of the operation we want to check | ||
| * @returns a Promise that wraps the status check function | ||
| */ | ||
| const checkOpStatus = (client, opId) => { | ||
| const getOpFn = async (resolve, reject) => { | ||
| const [longRunningOp] = await client.getOperation({name: opId}); | ||
| const DONE = STATUS_ENUM[STATUS_ENUM.DONE]; | ||
| if (longRunningOp.status === DONE) { | ||
| resolve('Cluster creation completed.'); | ||
| } else { | ||
| reject('Cluster creation not complete.'); | ||
| } | ||
| }; | ||
| return new Promise(getOpFn); | ||
| }; | ||
|
|
||
| /** | ||
| * This method calls the Promise function (`checkOpStatus()`) to check the | ||
| * status of an operation and schedules a retry if the operation is still not | ||
| * completed. The retry delay is modelled as a fibonacci sequence. | ||
| * | ||
| * @param {container.v1.ClusterManagerClient} client the google cloud API client used to submit the request | ||
| * @param {string} opId the unique identifier of the operation we want to check | ||
| * @param {number} delay the delay with which the next retry is to be scheduled | ||
| * @param {number} maxtries maximum number of retry attempts to go before giving up | ||
| * @param {number} retryCount the current number of retried attempted | ||
| */ | ||
| function checkStatusWithRetry(client, opId, delay, maxtries, retryCount = 1) { | ||
| checkOpStatus(client, opId) | ||
| .then(status => { | ||
| // success scenario | ||
| console.log(status); | ||
| }) | ||
| .catch(status => { | ||
| // fail (not yet complete) scenario | ||
| if (retryCount < maxtries) { | ||
| console.log(`${status} will try after ${delay / 1000}s delay...`); | ||
| const newDelay = getFibonacciDelay(delay); | ||
| setTimeout( | ||
| () => | ||
| checkStatusWithRetry( | ||
| client, | ||
| opId, | ||
| newDelay, | ||
| maxtries, | ||
| retryCount + 1 | ||
| ), | ||
| delay | ||
| ); | ||
| } else { | ||
| console.log(`${status} max retries reached, giving up.`); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * A simple function that returns the next number in a fibonacci sequence that | ||
| * has the given argument as f(n-1) and the global variable `prevFibonacciDelay` | ||
| * as f(n - 2). This function is used to simulate a fibonacci sequence for the | ||
| * backing off (delay) time used when retrying. | ||
| * | ||
| * @param {number} delay the previous delay in the sequence | ||
| * @returns the next delay before retrying | ||
| */ | ||
| function getFibonacciDelay(delay) { | ||
| const newDelay = prevFibonacciDelay + delay; | ||
| prevFibonacciDelay = delay; | ||
| return newDelay; | ||
| } | ||
|
|
||
| /** | ||
| * This method creates a GKE cluster with the name indicated by `clusterName` | ||
| * in the zone indicated by `clusterZone`. The cluster will use the network | ||
| * pointed to by `clusterNetwork`. | ||
| */ | ||
| async function createCluster() { | ||
| // Create the Cluster Manager Client | ||
| const client = new container.v1.ClusterManagerClient(); | ||
| const gcpProject = await client.getProjectId(); | ||
| const clusterLocation = `projects/${gcpProject}/locations/${clusterZone}`; | ||
| const request = { | ||
| parent: clusterLocation, | ||
| cluster: { | ||
| name: clusterName, | ||
| network: clusterNetwork, | ||
| initialNodeCount: 2, | ||
| nodeConfig: { | ||
| machineType: 'e2-standard-2', | ||
| }, | ||
| }, | ||
| }; | ||
| // invoke the create cluster API using the client | ||
| const [createOperation] = await client.createCluster(request); | ||
| // extract the unique identifier of the operation to checkback status | ||
| const opIdentifier = `${clusterLocation}/operations/${createOperation.name}`; | ||
| // initial delay before retry in milli seconds | ||
| const retryDelay = 1000; | ||
| // maximum number of times to check for operation completion before giving up | ||
| const maxRetryCount = 20; | ||
| // schedule polling to check if the creation operation is completed | ||
| checkStatusWithRetry(client, opIdentifier, retryDelay, maxRetryCount); | ||
| } | ||
|
|
||
| // Create a new GKE cluster | ||
| createCluster(); | ||
| // [END gke_create_cluster] | ||
| } | ||
|
|
||
| process.on('unhandledRejection', err => { | ||
| console.error(err.message); | ||
| process.exitCode = 1; | ||
| }); | ||
|
|
||
| // program starts here | ||
| main(...process.argv.slice(2)); |
Oops, something went wrong.