├── .repo-metadata.json ├── LICENSE ├── README.rst └── SECURITY.md /.repo-metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "compute", 3 | "name_pretty": "Compute Engine", 4 | "product_documentation": "https://cloud.google.com/compute/", 5 | "client_documentation": "https://cloud.google.com/python/docs/reference/compute/latest", 6 | "issue_tracker": "https://issuetracker.google.com/issues/new?component=187134&template=0", 7 | "release_level": "stable", 8 | "language": "python", 9 | "library_type": "GAPIC_AUTO", 10 | "repo": "googleapis/python-compute", 11 | "distribution_name": "google-cloud-compute", 12 | "api_id": "compute.googleapis.com", 13 | "codeowner_team": "@googleapis/api-compute", 14 | "default_version": "v1", 15 | "api_shortname": "compute", 16 | "api_description": "delivers virtual machines running in Google's innovative data centers and worldwide fiber network. Compute Engine's tooling and workflow support enable scaling from single instances to global, load-balanced cloud computing. Compute Engine's VMs boot quickly, come with persistent disk storage, deliver consistent performance and are available in many configurations." 17 | } 18 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | :**NOTE**: **This github repository is archived. The repository contents and history have moved to** `google-cloud-python`_. 2 | 3 | .. _google-cloud-python: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-compute 4 | 5 | 6 | Python Client for Compute Engine 7 | ================================================= 8 | 9 | |stable| |pypi| |versions| 10 | 11 | `Compute Engine API`_: Create and runs virtual machines on Google Cloud Platform. 12 | 13 | - `Client Library Documentation`_ 14 | - `Product Documentation`_ 15 | 16 | .. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg 17 | :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability 18 | .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-compute.svg 19 | :target: https://pypi.org/project/google-cloud-compute/ 20 | .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-compute.svg 21 | :target: https://pypi.org/project/google-cloud-compute/ 22 | .. _Compute Engine API: https://cloud.google.com/compute/ 23 | .. _Client Library Documentation: https://cloud.google.com/python/docs/reference/compute/latest 24 | .. _Product Documentation: https://cloud.google.com/compute/ 25 | 26 | Quick Start 27 | ----------- 28 | 29 | In order to use this library, you first need to go through the following steps: 30 | 31 | 1. `Select or create a Cloud Platform project.`_ 32 | 2. `Enable billing for your project.`_ 33 | 3. `Enable the Compute Engine API.`_ 34 | 4. `Setup Authentication.`_ 35 | 36 | .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project 37 | .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project 38 | .. _Enable the Compute Engine API.: https://cloud.google.com/compute/ 39 | .. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html 40 | 41 | Installation 42 | ~~~~~~~~~~~~ 43 | 44 | Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to 45 | create isolated Python environments. The basic problem it addresses is one of 46 | dependencies and versions, and indirectly permissions. 47 | 48 | With `virtualenv`_, it's possible to install this library without needing system 49 | install permissions, and without clashing with the installed system 50 | dependencies. 51 | 52 | .. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ 53 | 54 | 55 | Mac/Linux 56 | ^^^^^^^^^ 57 | 58 | .. code-block:: console 59 | 60 | pip install virtualenv 61 | virtualenv 62 | source /bin/activate 63 | /bin/pip install google-cloud-compute 64 | 65 | 66 | Windows 67 | ^^^^^^^ 68 | 69 | .. code-block:: console 70 | 71 | pip install virtualenv 72 | virtualenv 73 | \Scripts\activate 74 | \Scripts\pip.exe install google-cloud-compute 75 | 76 | 77 | Authentication and Authorization 78 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 79 | This client library supports authentication via `Google Application Default Credentials`_ 80 | , or by providing a JSON key file for a Service Account. See examples below. 81 | 82 | `Google Application Default Credentials`_ (ADC) is the recommended way to authorize and authenticate 83 | clients. Here is an example of a client using ADC to authenticate: 84 | 85 | .. code-block:: python 86 | 87 | from google.cloud import compute_v1 88 | 89 | networks_client = compute_v1.NetworksClient() 90 | for network in networks_client.list(project='YOUR_PROJECT'): 91 | print(network) 92 | 93 | 94 | You can use a file with credentials to authenticate and authorize, such as a JSON key 95 | file associated with a Google service account. You can create service account keys and 96 | download them using the Google Cloud Console. For more information, see 97 | `Creating and managing Service Account keys`_. 98 | 99 | The library used to create the credentials objects is ``google-auth``. This example uses 100 | the Networks Client, but the same steps apply to the other clients in this package. 101 | Example: 102 | 103 | .. code-block:: python 104 | 105 | from google.oauth2 import service_account 106 | from google.cloud import compute_v1 107 | 108 | credentials = service_account.Credentials.from_service_account_file( 109 | '/path/to/key.json') 110 | 111 | networks_client = compute_v1.NetworksClient(credentials=credentials) 112 | for network in networks_client.list(project='YOUR_PROJECT'): 113 | print(network) 114 | 115 | 116 | When you don't want to store secrets on disk, you can create credentials 117 | from in-memory JSON and use the ``from_service_account_info`` method. You can also limit the use of 118 | your credentials only to specified scopes. For more information about OAuth 2.0 scopes for Google APIs, 119 | see `Scopes documentation page`_. Example: 120 | 121 | .. code-block:: python 122 | 123 | import json 124 | 125 | from google.oauth2 import service_account 126 | from google.cloud import compute_v1 127 | 128 | json_acct_info = json.loads(function_to_get_json_creds()) 129 | credentials = service_account.Credentials.from_service_account_info( 130 | json_acct_info) 131 | 132 | scoped_credentials = credentials.with_scopes( 133 | ['https://www.googleapis.com/auth/cloud-platform']) 134 | 135 | networks_client = compute_v1.NetworksClient(credentials=scoped_credentials) 136 | for network in networks_client.list(project='YOUR_PROJECT'): 137 | print(network) 138 | 139 | .. _Google Application Default Credentials: https://cloud.google.com/docs/authentication/production 140 | .. _Creating and managing Service Account keys: https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating 141 | .. _Scopes documentation page: https://developers.google.com/identity/protocols/oauth2/scopes 142 | 143 | Long Running Operations 144 | ~~~~~~~~~~~~~~~~~~~~~~~ 145 | Long-Running Operations (LROs), like the many ``insert()`` operations, can be handled using 146 | the ``ExtendedOperation`` object that is returned when the LRO is started. 147 | 148 | You can wait for the completion of an operation using its ``result()`` method. This method accepts 149 | a ``timeout`` argument, specifying how long you want your process to wait for completion of the 150 | operation (in seconds). When the call to ``result()`` times out, the operation is not automatically 151 | cancelled. At any time, you can check whether the operation is complete by using its ``done()`` method. 152 | 153 | A sample method to handle LROs featuring error and warning reporting can be found in the Python 154 | code samples repository: `GoogleCloudPlatform/python-docs-samples`_ 155 | 156 | .. _GoogleCloudPlatform/python-docs-samples: https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/compute/client_library/snippets/operations/wait_for_extended_operation.py 157 | 158 | 159 | Code Samples 160 | ~~~~~~~~~~~~ 161 | You can find useful code samples that will demonstrate the usage of this library on `the 162 | Google Cloud samples page`_. 163 | 164 | .. _the Google Cloud samples page: https://cloud.google.com/docs/samples?language=python&product=computeengine 165 | 166 | 167 | 168 | PyCharm/JetBrains IDEs 169 | ~~~~~~~~~~~~~~~~~~~~~~ 170 | This library has now grown in size past the `JetBrains default size limit of ~2.5Mb`_. 171 | As a result, code completion in JetBrains products can fail to work with the classes from our library. To 172 | fix this, you need to update the ``idea.max.intellisense.filesize`` setting in custom properties 173 | (Help -> Edit custom properties...). Just add the line ``idea.max.intellisense.filesize = 10000`` to change this 174 | limit to ~10Mb. 175 | 176 | .. _JetBrains default size limit of ~2.5Mb: https://www.jetbrains.com/help/pycharm/file-idea-properties.html 177 | 178 | Next Steps 179 | ~~~~~~~~~~ 180 | 181 | - Read the `Client Library Documentation`_ for Compute Engine API 182 | to see other available methods on the client. 183 | - Read the `Compute Engine API Product documentation`_ to learn 184 | more about the product and see How-to Guides. 185 | - View this `README`_ to see the full list of Cloud 186 | APIs that we cover. 187 | 188 | .. _Compute Engine API Product documentation: https://cloud.google.com/compute/docs/api/libraries 189 | .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst 190 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | To report a security issue, please use [g.co/vulnz](https://g.co/vulnz). 4 | 5 | The Google Security Team will respond within 5 working days of your report on g.co/vulnz. 6 | 7 | We use g.co/vulnz for our intake, and do coordination and disclosure here using GitHub Security Advisory to privately discuss and fix the issue. 8 | --------------------------------------------------------------------------------