tcr-vagrant-google 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +17 -0
- data/CHANGELOG.md +20 -0
- data/CONTRIB.md +64 -0
- data/Gemfile +24 -0
- data/LICENSE +201 -0
- data/README.md +237 -0
- data/Rakefile +35 -0
- data/example_box/README.md +13 -0
- data/example_box/metadata.json +3 -0
- data/google.box +0 -0
- data/lib/vagrant-google.rb +31 -0
- data/lib/vagrant-google/action.rb +140 -0
- data/lib/vagrant-google/action/connect_google.rb +49 -0
- data/lib/vagrant-google/action/is_created.rb +31 -0
- data/lib/vagrant-google/action/message_already_created.rb +29 -0
- data/lib/vagrant-google/action/message_not_created.rb +29 -0
- data/lib/vagrant-google/action/message_will_not_destroy.rb +29 -0
- data/lib/vagrant-google/action/read_ssh_info.rb +54 -0
- data/lib/vagrant-google/action/read_state.rb +59 -0
- data/lib/vagrant-google/action/run_instance.rb +145 -0
- data/lib/vagrant-google/action/sync_folders.rb +87 -0
- data/lib/vagrant-google/action/terminate_instance.rb +40 -0
- data/lib/vagrant-google/action/timed_provision.rb +34 -0
- data/lib/vagrant-google/action/warn_networks.rb +32 -0
- data/lib/vagrant-google/config.rb +265 -0
- data/lib/vagrant-google/errors.rb +32 -0
- data/lib/vagrant-google/plugin.rb +86 -0
- data/lib/vagrant-google/provider.rb +63 -0
- data/lib/vagrant-google/util/timer.rb +30 -0
- data/lib/vagrant-google/version.rb +18 -0
- data/locales/en.yml +105 -0
- data/spec/vagrant-google/config_spec.rb +202 -0
- data/tcr-vagrant-google.gemspec +75 -0
- metadata +173 -0
data/.gitignore
ADDED
data/CHANGELOG.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# 0.1.4 (October 2014)
|
2
|
+
|
3
|
+
* Add option for disk size [franzs]
|
4
|
+
* Add tags [ptone]
|
5
|
+
* Updated default for latest Debian image
|
6
|
+
|
7
|
+
# 0.1.3 (July 2014)
|
8
|
+
|
9
|
+
* Updated all image references
|
10
|
+
* Fixed fog deprecation warning
|
11
|
+
* Updated example box `google.box`
|
12
|
+
* Got spec tests passing again
|
13
|
+
|
14
|
+
# 0.1.1 (October 11, 2013)
|
15
|
+
|
16
|
+
* Fixed bug with instance ready/SSH
|
17
|
+
|
18
|
+
# 0.1.0 (August 14, 2013)
|
19
|
+
|
20
|
+
* Initial release.
|
data/CONTRIB.md
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
# How to become a contributor and submit your own code
|
2
|
+
|
3
|
+
## Contributor License Agreements
|
4
|
+
|
5
|
+
We'd love to accept your sample apps and patches! Before we can take them, we
|
6
|
+
have to jump a couple of legal hurdles.
|
7
|
+
|
8
|
+
Please fill out either the individual or corporate Contributor License Agreement
|
9
|
+
(CLA).
|
10
|
+
|
11
|
+
* If you are an individual writing original source code and you're sure you
|
12
|
+
own the intellectual property, then you'll need to sign an [individual CLA]
|
13
|
+
(https://developers.google.com/open-source/cla/individual).
|
14
|
+
* If you work for a company that wants to allow you to contribute your work,
|
15
|
+
then you'll need to sign a [corporate CLA]
|
16
|
+
(https://developers.google.com/open-source/cla/corporate).
|
17
|
+
|
18
|
+
Follow either of the two links above to access the appropriate CLA and
|
19
|
+
instructions for how to sign and return it. Once we receive it, we'll be able to
|
20
|
+
accept your pull requests.
|
21
|
+
|
22
|
+
## Contributing A Patch
|
23
|
+
|
24
|
+
1. Submit an issue describing your proposed change to the repo in question.
|
25
|
+
1. The repo owner will respond to your issue promptly.
|
26
|
+
1. If your proposed change is accepted, and you haven't already done so, sign a
|
27
|
+
Contributor License Agreement (see details above).
|
28
|
+
1. Fork the desired repo, develop and test your code changes.
|
29
|
+
1. Ensure that your code adheres to the existing style in the sample to which
|
30
|
+
you are contributing. Refer to the
|
31
|
+
[Google Cloud Platform Samples Style Guide]
|
32
|
+
(https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the
|
33
|
+
recommended coding standards for this organization.
|
34
|
+
1. Ensure that your code has an appropriate set of unit tests which all pass.
|
35
|
+
1. Submit a pull request.
|
36
|
+
|
37
|
+
## Contributing A New Sample App
|
38
|
+
|
39
|
+
1. Submit an issue to the GoogleCloudPlatform/Template repo describing your
|
40
|
+
proposed sample app.
|
41
|
+
1. The Template repo owner will respond to your enhancement issue promptly.
|
42
|
+
Instructional value is the top priority when evaluating new app proposals for
|
43
|
+
this collection of repos.
|
44
|
+
1. If your proposal is accepted, and you haven't already done so, sign a
|
45
|
+
Contributor License Agreement (see details above).
|
46
|
+
1. Create your own repo for your app following this naming convention:
|
47
|
+
* {product}-{app-name}-{language}
|
48
|
+
* products: appengine, compute, storage, bigquery, prediction, cloudsql
|
49
|
+
* example: appengine-guestbook-python
|
50
|
+
* For multi-product apps, concatenate the primary products, like this:
|
51
|
+
compute-appengine-demo-suite-python.
|
52
|
+
* For multi-language apps, concatenate the primary languages like this:
|
53
|
+
appengine-sockets-python-java-go.
|
54
|
+
|
55
|
+
1. Clone the README.md, CONTRIB.md and LICENSE files from the
|
56
|
+
GoogleCloudPlatform/Template repo.
|
57
|
+
1. Ensure that your code adheres to the existing style in the sample to which
|
58
|
+
you are contributing. Refer to the
|
59
|
+
[Google Cloud Platform Samples Style Guide]
|
60
|
+
(https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the
|
61
|
+
recommended coding standards for this organization.
|
62
|
+
1. Ensure that your code has an appropriate set of unit tests which all pass.
|
63
|
+
1. Submit a request to fork your repo in GoogleCloudPlatform organizationt via
|
64
|
+
your proposal issue.
|
data/Gemfile
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# Copyright 2013 Google Inc. All Rights Reserved.
|
2
|
+
#
|
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
|
+
source "https://rubygems.org"
|
16
|
+
|
17
|
+
gemspec
|
18
|
+
|
19
|
+
group :development do
|
20
|
+
# We depend on Vagrant for development, but we don't add it as a
|
21
|
+
# gem dependency because we expect to be installed within the
|
22
|
+
# Vagrant environment itself using `vagrant plugin`.
|
23
|
+
gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git", :tag => "v1.2.7"
|
24
|
+
end
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,237 @@
|
|
1
|
+
# Vagrant Google Compute Engine (GCE) Provider
|
2
|
+
|
3
|
+
This is a [Vagrant](http://www.vagrantup.com) 1.2+ plugin that adds an
|
4
|
+
[Google Compute Engine](http://cloud.google.com/compute/) (GCE) provider to
|
5
|
+
Vagrant, allowing Vagrant to control and provision instances in GCE.
|
6
|
+
|
7
|
+
**NOTE:** This plugin requires Vagrant 1.2+,
|
8
|
+
|
9
|
+
## Features
|
10
|
+
|
11
|
+
* Boot Google Compute Engine instances.
|
12
|
+
* SSH into the instances.
|
13
|
+
* Provision the instances with any built-in Vagrant provisioner.
|
14
|
+
* Minimal synced folder support via `rsync`.
|
15
|
+
* Define zone-specific configurations so Vagrant can manage machines in
|
16
|
+
multiple zones.
|
17
|
+
|
18
|
+
## Usage
|
19
|
+
|
20
|
+
Install using standard Vagrant 1.1+ plugin installation methods. After
|
21
|
+
installing, `vagrant up` and specify the `google` provider. For example,
|
22
|
+
|
23
|
+
```sh
|
24
|
+
$ vagrant plugin install vagrant-google
|
25
|
+
...
|
26
|
+
$ vagrant up --provider=google
|
27
|
+
...
|
28
|
+
```
|
29
|
+
|
30
|
+
Of course, prior to this you'll need to obtain a GCE-compatible box file for
|
31
|
+
Vagrant. You may also need to ensure you have a ruby-dev and other utilities
|
32
|
+
such as GNU make installed prior to installing the plugin.
|
33
|
+
|
34
|
+
## Google Cloud Platform Setup
|
35
|
+
|
36
|
+
Prior to using this plugin, you will first need to make sure you have a
|
37
|
+
Google Cloud Platform account, enable Google Compute Engine, and create a
|
38
|
+
Service Account for API Access.
|
39
|
+
|
40
|
+
1. Log in with your Google Account and go to
|
41
|
+
[Google Cloud Platform](https://cloud.google.com) and click on the
|
42
|
+
`Try it now` button.
|
43
|
+
1. Create a new project and remember to record the `Project ID` you
|
44
|
+
specify.
|
45
|
+
1. Next, visit the [Developers Console](https://console.developers.google.com)
|
46
|
+
make sure to enable the `Google Compute Engine` service for your project
|
47
|
+
If prompted, review and agree to the terms of service.
|
48
|
+
1. While still in the Developers Console, go to `API & AUTH`, `Credentials`
|
49
|
+
section and click the `Create new Client ID` button. In the pop-up dialog,
|
50
|
+
select the `Service Account` radio button and the click the `Create Client ID`
|
51
|
+
button.
|
52
|
+
1. When prompted, select the `Download private key` button and make sure
|
53
|
+
to save this file in a secure and reliable location. This key file
|
54
|
+
will be used to authorize all Vagrant commands available in this plugin.
|
55
|
+
1. Still on the same page, find the newly created `Service Account` text
|
56
|
+
block on the API Access page. Record the `Email address` (it should end
|
57
|
+
with `@developer.gserviceaccount.com`) associated with the new Service
|
58
|
+
Account you just created. You will need this email address and the
|
59
|
+
location of the private key file to properly configure this Vagrant plugin.
|
60
|
+
|
61
|
+
## Quick Start
|
62
|
+
|
63
|
+
After installing the plugin (instructions above), the quickest way to get
|
64
|
+
started is to actually use a dummy Google box and specify all the details
|
65
|
+
manually within a `config.vm.provider` block. So first, add the Google box
|
66
|
+
using any name you want:
|
67
|
+
|
68
|
+
```sh
|
69
|
+
$ vagrant box add gce https://github.com/mitchellh/vagrant-google/raw/master/google.box
|
70
|
+
...
|
71
|
+
```
|
72
|
+
|
73
|
+
And then make a Vagrantfile that looks like the following, filling in
|
74
|
+
your information where necessary.
|
75
|
+
|
76
|
+
```ruby
|
77
|
+
Vagrant.configure("2") do |config|
|
78
|
+
config.vm.box = "gce"
|
79
|
+
|
80
|
+
config.vm.provider :google do |google, override|
|
81
|
+
google.google_project_id = "YOUR_GOOGLE_CLOUD_PROJECT_ID"
|
82
|
+
google.google_client_email = "YOUR_SERVICE_ACCOUNT_EMAIL_ADDRESS"
|
83
|
+
google.google_key_location = "/PATH/TO/YOUR/PRIVATE_KEY.p12"
|
84
|
+
|
85
|
+
override.ssh.username = "USERNAME"
|
86
|
+
override.ssh.private_key_path = "~/.ssh/id_rsa"
|
87
|
+
#override.ssh.private_key_path = "~/.ssh/google_compute_engine"
|
88
|
+
end
|
89
|
+
|
90
|
+
end
|
91
|
+
```
|
92
|
+
|
93
|
+
And then run `vagrant up --provider=google`.
|
94
|
+
|
95
|
+
This will start an Debian 7 (Wheezy) instance in the us-central1-f zone,
|
96
|
+
with an n1-standard-1 machine, and the "default" network within your project.
|
97
|
+
And assuming your SSH information was filled in properly within your
|
98
|
+
Vagrantfile, SSH and provisioning will work as well.
|
99
|
+
|
100
|
+
Note that normally a lot of this boilerplate is encoded within the box file,
|
101
|
+
but the box file used for the quick start, the "google" box, has no
|
102
|
+
preconfigured defaults.
|
103
|
+
|
104
|
+
## Box Format
|
105
|
+
|
106
|
+
Every provider in Vagrant must introduce a custom box format. This provider
|
107
|
+
introduces `google` boxes. You can view an example box in the
|
108
|
+
[example_box/](https://github.com/mitchellh/vagrant-google/tree/master/example_box).
|
109
|
+
That directory also contains instructions on how to build a box.
|
110
|
+
|
111
|
+
The box format is basically just the required `metadata.json` file along with
|
112
|
+
a `Vagrantfile` that does default settings for the provider-specific
|
113
|
+
configuration for this provider.
|
114
|
+
|
115
|
+
## Configuration
|
116
|
+
|
117
|
+
This provider exposes quite a few provider-specific configuration options:
|
118
|
+
|
119
|
+
* `google_client_email` - The Client Email address for your Service Account.
|
120
|
+
* `google_key_location` - The location to the private key file matching your
|
121
|
+
Service Account.
|
122
|
+
* `google_project_id` - The Project ID for your Google Cloud Platform account.
|
123
|
+
* `image` - The image name to use when booting your instance.
|
124
|
+
* `instance_ready_timeout` - The number of seconds to wait for the instance
|
125
|
+
to become "ready" in GCE. Defaults to 20 seconds.
|
126
|
+
* `machine_type` - The machine type to use. The default is "n1-standard-1".
|
127
|
+
* `disk_size` - The disk size in GB. The default is 10.
|
128
|
+
* `metadata` - Custom key/value pairs of metadata to add to the instance.
|
129
|
+
* `name` - The name of your instance. The default is "i-yyyyMMddHH". Example 2014/10/01 10:00:00 is "i-2014100101".
|
130
|
+
* `network` - The name of the network to use for the instance. Default is
|
131
|
+
"default".
|
132
|
+
* `tags` - An array of tags to apply to this instance.
|
133
|
+
* `zone` - The zone name where the instance will be created.
|
134
|
+
|
135
|
+
These can be set like typical provider-specific configuration:
|
136
|
+
|
137
|
+
```ruby
|
138
|
+
Vagrant.configure("2") do |config|
|
139
|
+
# ... other stuff
|
140
|
+
|
141
|
+
config.vm.provider :google do |google|
|
142
|
+
google.google_project_id = "my_project"
|
143
|
+
google.google_client_email = "hashstring@example.com"
|
144
|
+
google.google_key_location = "/tmp/private-key.p12"
|
145
|
+
end
|
146
|
+
end
|
147
|
+
```
|
148
|
+
|
149
|
+
In addition to the above top-level configs, you can use the `zone_config`
|
150
|
+
method to specify zone-specific overrides within your Vagrantfile. Note
|
151
|
+
that the top-level `zone` config must always be specified to choose which
|
152
|
+
zone you want to actually use, however. This looks like this:
|
153
|
+
|
154
|
+
```ruby
|
155
|
+
Vagrant.configure("2") do |config|
|
156
|
+
|
157
|
+
config.vm.box = "gce"
|
158
|
+
|
159
|
+
config.vm.provider :google do |google|
|
160
|
+
google.google_project_id = "my_project"
|
161
|
+
google.google_client_email = "hashstring@example.com"
|
162
|
+
google.google_key_location = "/tmp/private-key.p12"
|
163
|
+
|
164
|
+
# Make sure to set this to trigger the zone_config
|
165
|
+
google.zone = "us-central1-f"
|
166
|
+
|
167
|
+
google.zone_config "us-central1-f" do |zone1f|
|
168
|
+
zone1f.name = "testing-vagrant"
|
169
|
+
zone1f.image = "debian-7-wheezy-v20140926"
|
170
|
+
zone1f.machine_type = "n1-standard-4"
|
171
|
+
zone1f.zone = "us-central1-f"
|
172
|
+
zone1f.metadata = {'custom' => 'metadata', 'testing' => 'foobarbaz'}
|
173
|
+
zone1f.tags = ['web', 'app1']
|
174
|
+
end
|
175
|
+
end
|
176
|
+
end
|
177
|
+
```
|
178
|
+
|
179
|
+
The zone-specific configurations will override the top-level configurations
|
180
|
+
when that zone is used. They otherwise inherit the top-level configurations,
|
181
|
+
as you would probably expect.
|
182
|
+
|
183
|
+
There are a few example Vagrantfile's located in the
|
184
|
+
[vagrantfile_examples/ directory](https://github.com/mitchellh/vagrant-google/tree/master/vagrantfile_examples/)
|
185
|
+
|
186
|
+
## Networks
|
187
|
+
|
188
|
+
Networking features in the form of `config.vm.network` are not supported
|
189
|
+
with `vagrant-google`, currently. If any of these are specified, Vagrant will
|
190
|
+
emit a warning, but will otherwise boot the GCE machine.
|
191
|
+
|
192
|
+
## Synced Folders
|
193
|
+
|
194
|
+
There is minimal support for synced folders. Upon `vagrant up`,
|
195
|
+
`vagrant reload`, and `vagrant provision`, the Google provider will use
|
196
|
+
`rsync` (if available) to uni-directionally sync the folder to the remote
|
197
|
+
machine over SSH.
|
198
|
+
|
199
|
+
This is good enough for all built-in Vagrant provisioners (shell, chef, and
|
200
|
+
puppet) to work!
|
201
|
+
|
202
|
+
## Known Issues
|
203
|
+
|
204
|
+
* https://github.com/mitchellh/vagrant-google/issues/17
|
205
|
+
|
206
|
+
## Development
|
207
|
+
|
208
|
+
To work on the `vagrant-google` plugin, clone this repository out, and use
|
209
|
+
[Bundler](http://gembundler.com) to get the dependencies:
|
210
|
+
|
211
|
+
```
|
212
|
+
$ bundle
|
213
|
+
```
|
214
|
+
|
215
|
+
Once you have the dependencies, verify the unit tests pass with `rake`:
|
216
|
+
|
217
|
+
```
|
218
|
+
$ bundle exec rake
|
219
|
+
```
|
220
|
+
|
221
|
+
If those pass, you're ready to start developing the plugin. You can test
|
222
|
+
the plugin without installing it into your Vagrant environment by just
|
223
|
+
creating a `Vagrantfile` in the top level of this directory (it is gitignored)
|
224
|
+
that uses it, and uses bundler to execute Vagrant:
|
225
|
+
|
226
|
+
```
|
227
|
+
$ bundle exec vagrant up --provider=google
|
228
|
+
```
|
229
|
+
|
230
|
+
## Changelog
|
231
|
+
* See [CHANGELOG.md](https://github.com/mitchellh/vagrant-google/blob/master/CHANGELOG.md)
|
232
|
+
|
233
|
+
## Contributing
|
234
|
+
* See [CONTRIB.md](https://github.com/mitchellh/vagrant-google/blob/master/CONTRIB.md)
|
235
|
+
|
236
|
+
## Licensing
|
237
|
+
* See [LICENSE](https://github.com/mitchellh/vagrant-google/blob/master/LICENSE)
|