From 4f44b4f78837e67167adf1f165762e55cc7ee566 Mon Sep 17 00:00:00 2001 From: ngdav Date: Fri, 31 Mar 2023 18:01:27 -0400 Subject: [PATCH 1/6] add init autoscalercli to tools --- tools/.gitignore | 49 ++++++++++ tools/LICENSE | 202 +++++++++++++++++++++++++++++++++++++++++ tools/README.md | 67 ++++++++++++++ tools/autoscale.py | 132 +++++++++++++++++++++++++++ tools/example.json | 41 +++++++++ tools/requirements.txt | 1 + 6 files changed, 492 insertions(+) create mode 100644 tools/.gitignore create mode 100644 tools/LICENSE create mode 100644 tools/README.md create mode 100644 tools/autoscale.py create mode 100644 tools/example.json create mode 100644 tools/requirements.txt diff --git a/tools/.gitignore b/tools/.gitignore new file mode 100644 index 00000000..45885871 --- /dev/null +++ b/tools/.gitignore @@ -0,0 +1,49 @@ +# Auto-generated when isntalling Node packages, e.g. CF emulator +node_modules +package-lock.json + +# General +tmp +*.swp +*.swo +.DS_Store + +# https://www.gitignore.io/api/visualstudiocode +.vscode +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json + +### VisualStudioCode Patch ### +# Ignore all local history of files +.history + +# Misc +setenv.sh +out + +# Terraform +*.tfstate +*.tfstate.backup +*.tfstate.lock.info +*.tfplan +.terraform +terraform/*/build +terraform/*/*.json +terraform/*/*/build +terraform/*/*/*/build +terraform/*/*/*.json + +# Code coverage report +.nyc_output + +# Kubernetes manifests generated from templates +kubernetes/autoscaler-config/*.yaml +kubernetes/**/resourcegroup.yaml + +#python venv +env/ + +testing.json \ No newline at end of file diff --git a/tools/LICENSE b/tools/LICENSE new file mode 100644 index 00000000..56b796b1 --- /dev/null +++ b/tools/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2020 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. \ No newline at end of file diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 00000000..4fb3453c --- /dev/null +++ b/tools/README.md @@ -0,0 +1,67 @@ +# Spanner Autoscaler Commandline Configuration Tool + +This example python script allows replacing a Cloud Spanner Autoscaler configuration without use of the GCP Console. +It also allows retrieving the current configuration to stdout. + +The script needs to know the exactly Cloud Scheduler job it will be updating, as described by: +the name of the job, the project and the region it resides in. + +The file input will the same configuration as described in the poller [documentation](https://github.com/cloudspannerecosystem/autoscaler/blob/master/poller/README.md). + +## Requirements +* google-cloud-scheduler python package +``` +pip install google-cloud-scheduler +``` + + +## Usage +### retrieve +``` +usage: autoscale.py retrieve [-h] --jobname JOBNAME --jobproject JOBPROJECT --jobregion JOBREGION + +prints out the configuration in specified cloud scheduler job + +options: + -h, --help show this help message and exit + --jobname JOBNAME name of cloud scheduler job + --jobproject JOBPROJECT + project name of cloud scheduler job + --jobregion JOBREGION + region of cloud scheduler job +``` + +### replace +``` +usage: autoscale.py replace [-h] -f FILENAME --jobname JOBNAME --jobproject JOBPROJECT --jobregion JOBREGION + +replaces the existing configuration in specified cloud scheduler job + +options: + -h, --help show this help message and exit + -f FILENAME, --filename FILENAME + filename containing replacement config + --jobname JOBNAME name of cloud scheduler job + --jobproject JOBPROJECT + project name of cloud scheduler job + --jobregion JOBREGION + region of cloud scheduler job +``` + +## Licensing + +```lang-none +Copyright 2023 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. +``` diff --git a/tools/autoscale.py b/tools/autoscale.py new file mode 100644 index 00000000..517cbd47 --- /dev/null +++ b/tools/autoscale.py @@ -0,0 +1,132 @@ +""" Copyright 2023 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 argparse +import logging +import json +from google.cloud import scheduler_v1 as scheduler +from google.cloud.scheduler_v1 import PubsubTarget +from google.cloud.scheduler_v1 import Job +from google.protobuf import field_mask_pb2 + + + +def get_job(job): + """Prints the Spanner autoscaler configuration data""" + # Create a client + client = scheduler.CloudSchedulerClient() + + # Initialize request argument(s) + request = scheduler.GetJobRequest(name=job) + + # Make the request + response = client.get_job(request=request) + + # Handle the response + logging.debug(f"raw pubsub_target_data: {response.pubsub_target.data}") + config = json.loads(response.pubsub_target.data) + print(config) + +def get_pubsubtopic(job): + """returns pubsub_target topic name from existing configuration""" + # Create a client + client = scheduler.CloudSchedulerClient() + + # Initialize request argument(s) + request = scheduler.GetJobRequest(name=job) + + # Make the request + response = client.get_job(request=request) + + # Handle the response + logging.debug(f"raw pubsub_target_topic_name: {response.pubsub_target.topic_name}") + return response.pubsub_target.topic_name + +def update_job(jobname, payload): + """replaces the Spanner autoscaler configuration data""" + # Create Client + client = scheduler.CloudSchedulerClient() + + #Create Job + job = scheduler.Job(name=jobname) + + #Create new pubsubtarget and populate with existing topic, and new payload + pt = PubsubTarget() + pt.data = payload + #pull existing topic name + pt.topic_name = get_pubsubtopic(jobname) + job.pubsub_target = pt + + #create update mask + update_mask = field_mask_pb2.FieldMask(paths=['pubsub_target']) + request = scheduler.UpdateJobRequest(job=job,update_mask=update_mask) + + # Make the request + response = client.update_job(request=request) + # Handle the response + if response.state != Job.State.UPDATE_FAILED: + print(f"Job: {response.name} updated. Current status: {response.state.name}") + +def parse_json(inputfile): + """parses inputfile name and returns its as an encoded string """ + with open(inputfile) as file_object: + contents = file_object.read().encode("utf-8") + logging.debug(f"{inputfile} contains: \n{contents}") + return contents + + +def main(): + parser = argparse.ArgumentParser( + description='retrieve or replace Spanner Autoscaler configurations with a Cloud Scheduler job') + parser.add_argument('-v','--verbose', action='store_true',help='verbose output') + + subparser = parser.add_subparsers(dest="command", + help='what the program should do', required=True) + + retriever = subparser.add_parser("retrieve", + help='retrieve a configuration from specified cloud scheduler job', + description='prints out the configuration in specified cloud scheduler job') + retriever.add_argument("--jobname", help='name of cloud scheduler job', required=True) + retriever.add_argument("--jobproject", help='project name of cloud scheduler job',required=True) + retriever.add_argument("--jobregion", help='region of cloud scheduler job',required=True) + + replacer = subparser.add_parser("replace", + help='replaces the existing configuration in specified cloud scheduler job', + description="replaces the existing configuration in specified cloud scheduler job") + replacer.add_argument('-f', '--filename', help='filename containing replacement config',required=True) + replacer.add_argument("--jobname", help='name of cloud scheduler job', required=True) + replacer.add_argument("--jobproject", help='project name of cloud scheduler job',required=True) + replacer.add_argument("--jobregion", help='region of cloud scheduler job',required=True) + + + args = parser.parse_args() + if args.verbose: + logging.basicConfig(level=logging.DEBUG) + + # Construct the fully qualified job path. + job = f"projects/{args.jobproject}/locations/{args.jobregion}/jobs/{args.jobname}" + + if args.command == "replace": + update_job(job, parse_json(args.filename)) + #get_job(job) + elif args.command == "retrieve": + get_job(job) + # + + +if __name__ == "__main__": + main() diff --git a/tools/example.json b/tools/example.json new file mode 100644 index 00000000..f81554e0 --- /dev/null +++ b/tools/example.json @@ -0,0 +1,41 @@ +[ + { + "projectId": "basic-configuration", + "instanceId": "another-spanner1", + "scalerPubSubTopic": "projects/my-spanner-project/topics/spanner-scaling", + "units": "NODES", + "minSize": 5, + "maxSize": 30, + "scalingMethod": "DIRECT" + },{ + "projectId": "custom-threshold", + "instanceId": "spanner1", + "scalerPubSubTopic": "projects/my-spanner-project/topics/spanner-scaling", + "units": "PROCESSING_UNITS", + "minSize": 100, + "maxSize": 3000, + "metrics": [ + { + "name": "high_priority_cpu", + "regional_threshold": 40, + "regional_margin": 3 + } + ] + },{ + "projectId": "custom-metric", + "instanceId": "another-spanner1", + "scalerPubSubTopic": "projects/my-spanner-project/topics/spanner-scaling", + "units": "NODES", + "minSize": 5, + "maxSize": 30, + "scalingMethod": "LINEAR", + "metrics": [ + { + "name": "my_custom_metric", + "filter": "metric.type=\"spanner.googleapis.com/instance/resource/metric\"", + "regional_threshold": 40, + "multi_regional_threshold": 30 + } + ] + } +] \ No newline at end of file diff --git a/tools/requirements.txt b/tools/requirements.txt new file mode 100644 index 00000000..52312a6e --- /dev/null +++ b/tools/requirements.txt @@ -0,0 +1 @@ +google-cloud-scheduler>=2.9.1 \ No newline at end of file From a92dcb9939a6fd376718a958f02e96ea0aac0b2e Mon Sep 17 00:00:00 2001 From: ngdav <52801477+ngdav@users.noreply.github.com> Date: Tue, 4 Apr 2023 22:25:42 -0400 Subject: [PATCH 2/6] update the readme and minor housekeeping --- tools/LICENSE | 202 ------------------ tools/{ => autoscalercli}/README.md | 32 +-- .../autoscaler-config.py} | 6 +- tools/{ => autoscalercli}/requirements.txt | 0 tools/example.json | 41 ---- 5 files changed, 12 insertions(+), 269 deletions(-) delete mode 100644 tools/LICENSE rename tools/{ => autoscalercli}/README.md (63%) rename tools/{autoscale.py => autoscalercli/autoscaler-config.py} (95%) rename tools/{ => autoscalercli}/requirements.txt (100%) delete mode 100644 tools/example.json diff --git a/tools/LICENSE b/tools/LICENSE deleted file mode 100644 index 56b796b1..00000000 --- a/tools/LICENSE +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2020 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. \ No newline at end of file diff --git a/tools/README.md b/tools/autoscalercli/README.md similarity index 63% rename from tools/README.md rename to tools/autoscalercli/README.md index 4fb3453c..c69314ef 100644 --- a/tools/README.md +++ b/tools/autoscalercli/README.md @@ -1,12 +1,9 @@ -# Spanner Autoscaler Commandline Configuration Tool +# Autoscaler Commandline Configuration Tool -This example python script allows replacing a Cloud Spanner Autoscaler configuration without use of the GCP Console. +This example python script allows replacing an Autoscaler configuration without use of the GCP Console. It also allows retrieving the current configuration to stdout. -The script needs to know the exactly Cloud Scheduler job it will be updating, as described by: -the name of the job, the project and the region it resides in. -The file input will the same configuration as described in the poller [documentation](https://github.com/cloudspannerecosystem/autoscaler/blob/master/poller/README.md). ## Requirements * google-cloud-scheduler python package @@ -17,6 +14,8 @@ pip install google-cloud-scheduler ## Usage ### retrieve +To retrieve the existing configuration the script needs to know the exact Cloud Scheduler job identified by: +the name of the job, the project and the region it resides in. ``` usage: autoscale.py retrieve [-h] --jobname JOBNAME --jobproject JOBPROJECT --jobregion JOBREGION @@ -32,6 +31,11 @@ options: ``` ### replace +To replace the existing configuration the script needs to know the exact Cloud Scheduler job identified by: +the name of the job, the project and the region it resides in. + +The file input will the same configuration as described in the poller [documentation](https://github.com/cloudspannerecosystem/autoscaler/blob/master/poller/README.md). + ``` usage: autoscale.py replace [-h] -f FILENAME --jobname JOBNAME --jobproject JOBPROJECT --jobregion JOBREGION @@ -47,21 +51,3 @@ options: --jobregion JOBREGION region of cloud scheduler job ``` - -## Licensing - -```lang-none -Copyright 2023 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. -``` diff --git a/tools/autoscale.py b/tools/autoscalercli/autoscaler-config.py similarity index 95% rename from tools/autoscale.py rename to tools/autoscalercli/autoscaler-config.py index 517cbd47..9f8881fe 100644 --- a/tools/autoscale.py +++ b/tools/autoscalercli/autoscaler-config.py @@ -26,7 +26,7 @@ def get_job(job): - """Prints the Spanner autoscaler configuration data""" + """Prints the autoscaler configuration data""" # Create a client client = scheduler.CloudSchedulerClient() @@ -57,7 +57,7 @@ def get_pubsubtopic(job): return response.pubsub_target.topic_name def update_job(jobname, payload): - """replaces the Spanner autoscaler configuration data""" + """replaces the autoscaler configuration data""" # Create Client client = scheduler.CloudSchedulerClient() @@ -91,7 +91,7 @@ def parse_json(inputfile): def main(): parser = argparse.ArgumentParser( - description='retrieve or replace Spanner Autoscaler configurations with a Cloud Scheduler job') + description='retrieve or replace autoscaler configurations with a Cloud Scheduler job') parser.add_argument('-v','--verbose', action='store_true',help='verbose output') subparser = parser.add_subparsers(dest="command", diff --git a/tools/requirements.txt b/tools/autoscalercli/requirements.txt similarity index 100% rename from tools/requirements.txt rename to tools/autoscalercli/requirements.txt diff --git a/tools/example.json b/tools/example.json deleted file mode 100644 index f81554e0..00000000 --- a/tools/example.json +++ /dev/null @@ -1,41 +0,0 @@ -[ - { - "projectId": "basic-configuration", - "instanceId": "another-spanner1", - "scalerPubSubTopic": "projects/my-spanner-project/topics/spanner-scaling", - "units": "NODES", - "minSize": 5, - "maxSize": 30, - "scalingMethod": "DIRECT" - },{ - "projectId": "custom-threshold", - "instanceId": "spanner1", - "scalerPubSubTopic": "projects/my-spanner-project/topics/spanner-scaling", - "units": "PROCESSING_UNITS", - "minSize": 100, - "maxSize": 3000, - "metrics": [ - { - "name": "high_priority_cpu", - "regional_threshold": 40, - "regional_margin": 3 - } - ] - },{ - "projectId": "custom-metric", - "instanceId": "another-spanner1", - "scalerPubSubTopic": "projects/my-spanner-project/topics/spanner-scaling", - "units": "NODES", - "minSize": 5, - "maxSize": 30, - "scalingMethod": "LINEAR", - "metrics": [ - { - "name": "my_custom_metric", - "filter": "metric.type=\"spanner.googleapis.com/instance/resource/metric\"", - "regional_threshold": 40, - "multi_regional_threshold": 30 - } - ] - } -] \ No newline at end of file From 9d7602ac2b2b4ad1f3c036eb63cc00d43fafaa66 Mon Sep 17 00:00:00 2001 From: ngdav <52801477+ngdav@users.noreply.github.com> Date: Tue, 4 Apr 2023 22:26:59 -0400 Subject: [PATCH 3/6] consolidate .gitignore files --- .gitignore | 3 +++ tools/.gitignore | 49 ------------------------------------------------ 2 files changed, 3 insertions(+), 49 deletions(-) delete mode 100644 tools/.gitignore diff --git a/.gitignore b/.gitignore index 9d9f79ec..ff7b9bbb 100644 --- a/.gitignore +++ b/.gitignore @@ -42,3 +42,6 @@ terraform/*/*/*.json # Kubernetes manifests generated from templates kubernetes/autoscaler-config/*.yaml kubernetes/**/resourcegroup.yaml + +#python venv +env/ \ No newline at end of file diff --git a/tools/.gitignore b/tools/.gitignore deleted file mode 100644 index 45885871..00000000 --- a/tools/.gitignore +++ /dev/null @@ -1,49 +0,0 @@ -# Auto-generated when isntalling Node packages, e.g. CF emulator -node_modules -package-lock.json - -# General -tmp -*.swp -*.swo -.DS_Store - -# https://www.gitignore.io/api/visualstudiocode -.vscode -.vscode/* -!.vscode/settings.json -!.vscode/tasks.json -!.vscode/launch.json -!.vscode/extensions.json - -### VisualStudioCode Patch ### -# Ignore all local history of files -.history - -# Misc -setenv.sh -out - -# Terraform -*.tfstate -*.tfstate.backup -*.tfstate.lock.info -*.tfplan -.terraform -terraform/*/build -terraform/*/*.json -terraform/*/*/build -terraform/*/*/*/build -terraform/*/*/*.json - -# Code coverage report -.nyc_output - -# Kubernetes manifests generated from templates -kubernetes/autoscaler-config/*.yaml -kubernetes/**/resourcegroup.yaml - -#python venv -env/ - -testing.json \ No newline at end of file From 02ea563a79146db25d928077b2be424b3a6e98b8 Mon Sep 17 00:00:00 2001 From: ngdav <52801477+ngdav@users.noreply.github.com> Date: Tue, 4 Apr 2023 22:38:33 -0400 Subject: [PATCH 4/6] fix mdlint --- tools/autoscalercli/README.md | 42 ++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/tools/autoscalercli/README.md b/tools/autoscalercli/README.md index c69314ef..f60ffb6b 100644 --- a/tools/autoscalercli/README.md +++ b/tools/autoscalercli/README.md @@ -1,23 +1,29 @@ -# Autoscaler Commandline Configuration Tool - -This example python script allows replacing an Autoscaler configuration without use of the GCP Console. -It also allows retrieving the current configuration to stdout. - +# Autoscaler Commandline Configuration Tool +This example python script allows replacing an Autoscaler configuration without +use of the GCP Console. It also allows retrieving the current configuration to +stdout. ## Requirements + * google-cloud-scheduler python package -``` + +```bash pip install google-cloud-scheduler ``` ## Usage + ### retrieve -To retrieve the existing configuration the script needs to know the exact Cloud Scheduler job identified by: -the name of the job, the project and the region it resides in. -``` -usage: autoscale.py retrieve [-h] --jobname JOBNAME --jobproject JOBPROJECT --jobregion JOBREGION + +To retrieve the existing configuration the script needs to know the exact Cloud +Scheduler job identified by: +the name of the job, the project and the region it resides in. + +```bash +usage: autoscale.py retrieve [-h] --jobname JOBNAME --jobproject JOBPROJECT + --jobregion JOBREGION prints out the configuration in specified cloud scheduler job @@ -31,13 +37,17 @@ options: ``` ### replace -To replace the existing configuration the script needs to know the exact Cloud Scheduler job identified by: -the name of the job, the project and the region it resides in. -The file input will the same configuration as described in the poller [documentation](https://github.com/cloudspannerecosystem/autoscaler/blob/master/poller/README.md). +To replace the existing configuration the script needs to know the exact Cloud +Scheduler job identified by: +the name of the job, the project and the region it resides in. -``` -usage: autoscale.py replace [-h] -f FILENAME --jobname JOBNAME --jobproject JOBPROJECT --jobregion JOBREGION +The file input will the same configuration as described in the poller +[documentation](https://github.com/cloudspannerecosystem/autoscaler/blob/master/poller/README.md). + +```bash +usage: autoscale.py replace [-h] -f FILENAME --jobname JOBNAME + --jobproject JOBPROJECT --jobregion JOBREGION replaces the existing configuration in specified cloud scheduler job @@ -50,4 +60,4 @@ options: project name of cloud scheduler job --jobregion JOBREGION region of cloud scheduler job -``` +``` \ No newline at end of file From 940b4d13b0d7d564f7757325c6a5975eae201a5c Mon Sep 17 00:00:00 2001 From: ngdav <52801477+ngdav@users.noreply.github.com> Date: Thu, 13 Apr 2023 11:39:03 -0400 Subject: [PATCH 5/6] fix mdlint --- tools/autoscalercli/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/tools/autoscalercli/README.md b/tools/autoscalercli/README.md index f60ffb6b..9554d9b1 100644 --- a/tools/autoscalercli/README.md +++ b/tools/autoscalercli/README.md @@ -1,7 +1,7 @@ # Autoscaler Commandline Configuration Tool This example python script allows replacing an Autoscaler configuration without -use of the GCP Console. It also allows retrieving the current configuration to +use of the GCP Console. It also allows retrieving the current configuration to stdout. ## Requirements @@ -12,7 +12,6 @@ stdout. pip install google-cloud-scheduler ``` - ## Usage ### retrieve @@ -60,4 +59,4 @@ options: project name of cloud scheduler job --jobregion JOBREGION region of cloud scheduler job -``` \ No newline at end of file +``` From 32734f2e91c06c0090e05624641fddf96286349d Mon Sep 17 00:00:00 2001 From: ngdav <52801477+ngdav@users.noreply.github.com> Date: Thu, 13 Apr 2023 11:41:06 -0400 Subject: [PATCH 6/6] fix mdlint --- tools/autoscalercli/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/autoscalercli/README.md b/tools/autoscalercli/README.md index 9554d9b1..703ef4f7 100644 --- a/tools/autoscalercli/README.md +++ b/tools/autoscalercli/README.md @@ -6,7 +6,7 @@ stdout. ## Requirements -* google-cloud-scheduler python package +* google-cloud-scheduler python package ```bash pip install google-cloud-scheduler