vagrant-google 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +17 -0
- data/CHANGELOG.md +14 -0
- data/CONTRIB.md +64 -0
- data/Gemfile +24 -0
- data/LICENSE +201 -0
- data/README.md +249 -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/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 +136 -0
- data/lib/vagrant-google/action/sync_folders.rb +84 -0
- data/lib/vagrant-google/action/terminate_instance.rb +39 -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/action.rb +140 -0
- data/lib/vagrant-google/config.rb +241 -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/lib/vagrant-google.rb +31 -0
- data/locales/en.yml +105 -0
- data/spec/vagrant-google/config_spec.rb +195 -0
- data/vagrant-google.gemspec +75 -0
- metadata +176 -0
data/.gitignore
ADDED
data/CHANGELOG.md
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
# 0.1.3 (July 2014)
|
2
|
+
|
3
|
+
* Updated all image references
|
4
|
+
* Fixed fog deprecation warning
|
5
|
+
* Updated example box `google.box`
|
6
|
+
* Got spec tests passing again
|
7
|
+
|
8
|
+
# 0.1.1 (October 11, 2013)
|
9
|
+
|
10
|
+
* Fixed bug with instance ready/SSH
|
11
|
+
|
12
|
+
# 0.1.0 (August 14, 2013)
|
13
|
+
|
14
|
+
* 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,249 @@
|
|
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 does not yet work using standard Vagrant 1.1+ plugin installation methods.
|
21
|
+
To install, clone and build the repo, and install from there. Something similar to the below
|
22
|
+
```sh
|
23
|
+
mkdir -p ~/tmp && cd ~/tmp
|
24
|
+
git clone https://github.com/mitchellh/vagrant-google
|
25
|
+
cd vagrant-google
|
26
|
+
bundle
|
27
|
+
rake build
|
28
|
+
cd ~
|
29
|
+
````
|
30
|
+
|
31
|
+
# change out of the plugin source directory to avoid bundler issues
|
32
|
+
|
33
|
+
```sh
|
34
|
+
vagrant plugin install ~/tmp/vagrant-google/pkg/vagrant-google-0.1.2.gem
|
35
|
+
```
|
36
|
+
|
37
|
+
After installing, be sure to put a `Vagrant.require_plugin "vagrant-google"` at the top of your Vagrantfile so that Vagrant knows about the plugin.
|
38
|
+
`vagrant up` and specify the `google` provider. For example,
|
39
|
+
|
40
|
+
```sh
|
41
|
+
$ vagrant up --provider=google
|
42
|
+
```
|
43
|
+
|
44
|
+
Of course, prior to this you'll need to obtain a GCE-compatible box file for
|
45
|
+
Vagrant.
|
46
|
+
|
47
|
+
## Google Cloud Platform Setup
|
48
|
+
|
49
|
+
Prior to using this plugin, you will first need to make sure you have a
|
50
|
+
Google Cloud Platform account, enable Google Compute Engine, and create a
|
51
|
+
Service Account for API Access.
|
52
|
+
|
53
|
+
1. Log in with your Google Account and go to
|
54
|
+
[Google Cloud Platform](https://cloud.google.com) and click on the
|
55
|
+
`Try it now` button.
|
56
|
+
1. Create a new project and remember to record the `Project ID` you
|
57
|
+
specify.
|
58
|
+
1. Next, visit the [API Console](https://code.google.com/apis/console/),
|
59
|
+
select `Services` and enable the `Google Compute Engine` service for
|
60
|
+
your project. If prompted, review and agree to the terms of service.
|
61
|
+
1. While still in the API Console, go to `API Access` and click on the
|
62
|
+
`Create another client ID...` button. In the pop-up dialog, select
|
63
|
+
the `Service Account` radio button and the click the `Create client ID`
|
64
|
+
button.
|
65
|
+
1. When prompted, select the `Download private key` button and make sure
|
66
|
+
to save this file in a secure and reliable location. This key file
|
67
|
+
will be used to authorize all Vagrant commands available in this plugin.
|
68
|
+
1. Still on the same page, find the newly created `Service Account` text
|
69
|
+
block on the API Access page. Record the `Email address` associated
|
70
|
+
with the new Service Account you just created. You will need this
|
71
|
+
email address and the location of the private key file to properly
|
72
|
+
configure this Vagrant plugin.
|
73
|
+
|
74
|
+
## Quick Start
|
75
|
+
|
76
|
+
After installing the plugin (instructions above), the quickest way to get
|
77
|
+
started is to actually use a dummy Google box and specify all the details
|
78
|
+
manually within a `config.vm.provider` block. So first, add the Google box
|
79
|
+
using any name you want:
|
80
|
+
|
81
|
+
```sh
|
82
|
+
$ vagrant box add gce https://github.com/mitchellh/vagrant-google/raw/master/google.box
|
83
|
+
...
|
84
|
+
```
|
85
|
+
|
86
|
+
And then make a Vagrantfile that looks like the following, filling in
|
87
|
+
your information where necessary.
|
88
|
+
|
89
|
+
```ruby
|
90
|
+
Vagrant.configure("2") do |config|
|
91
|
+
config.vm.box = "gce"
|
92
|
+
|
93
|
+
config.vm.provider :google do |google, override|
|
94
|
+
google.google_project_id = "YOUR_GOOGLE_CLOUD_PROJECT_ID"
|
95
|
+
google.google_client_email = "YOUR_SERVICE_ACCOUNT_EMAIL_ADDRESS"
|
96
|
+
google.google_key_location = "/PATH/TO/YOUR/PRIVATE_KEY.p12"
|
97
|
+
|
98
|
+
override.ssh.username = "USERNAME"
|
99
|
+
override.ssh.private_key_path = "~/.ssh/id_rsa"
|
100
|
+
#override.ssh.private_key_path = "~/.ssh/google_compute_engine"
|
101
|
+
end
|
102
|
+
|
103
|
+
end
|
104
|
+
```
|
105
|
+
|
106
|
+
And then run `vagrant up --provider=google`.
|
107
|
+
|
108
|
+
This will start an Debian 7 (Wheezy) instance in the us-central1-a zone,
|
109
|
+
with an n1-standard-1 machine, and the "default" network within your project.
|
110
|
+
And assuming your SSH information was filled in properly within your
|
111
|
+
Vagrantfile, SSH and provisioning will work as well.
|
112
|
+
|
113
|
+
Note that normally a lot of this boilerplate is encoded within the box file,
|
114
|
+
but the box file used for the quick start, the "google" box, has no
|
115
|
+
preconfigured defaults.
|
116
|
+
|
117
|
+
## Box Format
|
118
|
+
|
119
|
+
Every provider in Vagrant must introduce a custom box format. This provider
|
120
|
+
introduces `google` boxes. You can view an example box in the
|
121
|
+
[example_box/](https://github.com/mitchellh/vagrant-google/tree/master/example_box).
|
122
|
+
That directory also contains instructions on how to build a box.
|
123
|
+
|
124
|
+
The box format is basically just the required `metadata.json` file along with
|
125
|
+
a `Vagrantfile` that does default settings for the provider-specific
|
126
|
+
configuration for this provider.
|
127
|
+
|
128
|
+
## Configuration
|
129
|
+
|
130
|
+
This provider exposes quite a few provider-specific configuration options:
|
131
|
+
|
132
|
+
* `google_client_email` - The Client Email address for your Service Account.
|
133
|
+
* `google_key_location` - The location to the private key file matching your
|
134
|
+
Service Account.
|
135
|
+
* `google_project_id` - The Project ID for your Google Cloud Platform account.
|
136
|
+
* `image` - The image name to use when booting your instance.
|
137
|
+
* `instance_ready_timeout` - The number of seconds to wait for the instance
|
138
|
+
to become "ready" in GCE. Defaults to 20 seconds.
|
139
|
+
* `machine_type` - The machine type to use. The default is "n1-standard-1".
|
140
|
+
* `metadata` - Custom key/value pairs of metadata to add to the instance.
|
141
|
+
* `name` - The name of your instance. The default is "new".
|
142
|
+
* `network` - The name of the network to use for the instance. Default is
|
143
|
+
"default".
|
144
|
+
* `zone` - The zone name where the instance will be created.
|
145
|
+
|
146
|
+
These can be set like typical provider-specific configuration:
|
147
|
+
|
148
|
+
```ruby
|
149
|
+
Vagrant.configure("2") do |config|
|
150
|
+
# ... other stuff
|
151
|
+
|
152
|
+
config.vm.provider :google do |google|
|
153
|
+
google.google_project_id = "my_project"
|
154
|
+
google.google_client_email = "hashstring@example.com"
|
155
|
+
google.google_key_location = "/tmp/private-key.p12"
|
156
|
+
end
|
157
|
+
end
|
158
|
+
```
|
159
|
+
|
160
|
+
In addition to the above top-level configs, you can use the `zone_config`
|
161
|
+
method to specify zone-specific overrides within your Vagrantfile. Note
|
162
|
+
that the top-level `zone` config must always be specified to choose which
|
163
|
+
zone you want to actually use, however. This looks like this:
|
164
|
+
|
165
|
+
```ruby
|
166
|
+
Vagrant.configure("2") do |config|
|
167
|
+
|
168
|
+
config.vm.box = "gce"
|
169
|
+
|
170
|
+
config.vm.provider :google do |google|
|
171
|
+
google.google_project_id = "my_project"
|
172
|
+
google.google_client_email = "hashstring@example.com"
|
173
|
+
google.google_key_location = "/tmp/private-key.p12"
|
174
|
+
|
175
|
+
# Make sure to set this to trigger the zone_config
|
176
|
+
google.zone = "us-central2-a"
|
177
|
+
|
178
|
+
google.zone_config "us-central2-a" do |zone2a|
|
179
|
+
zone2a.name = "testing-vagrant"
|
180
|
+
zone2a.image = "debian-7-wheezy-v20140619"
|
181
|
+
zone2a.machine_type = "n1-standard-4"
|
182
|
+
zone2a.zone = "us-central2-a"
|
183
|
+
zone2a.metadata = {'custom' => 'metadata', 'testing' => 'foobarbaz'}
|
184
|
+
end
|
185
|
+
end
|
186
|
+
end
|
187
|
+
```
|
188
|
+
|
189
|
+
The zone-specific configurations will override the top-level configurations
|
190
|
+
when that zone is used. They otherwise inherit the top-level configurations,
|
191
|
+
as you would probably expect.
|
192
|
+
|
193
|
+
There are a few example Vagrantfile's located in the
|
194
|
+
[vagrantfile_examples/ directory](https://github.com/mitchellh/vagrant-google/tree/master/vagrantfile_examples/)
|
195
|
+
|
196
|
+
## Networks
|
197
|
+
|
198
|
+
Networking features in the form of `config.vm.network` are not supported
|
199
|
+
with `vagrant-google`, currently. If any of these are specified, Vagrant will
|
200
|
+
emit a warning, but will otherwise boot the GCE machine.
|
201
|
+
|
202
|
+
## Synced Folders
|
203
|
+
|
204
|
+
There is minimal support for synced folders. Upon `vagrant up`,
|
205
|
+
`vagrant reload`, and `vagrant provision`, the Google provider will use
|
206
|
+
`rsync` (if available) to uni-directionally sync the folder to the remote
|
207
|
+
machine over SSH.
|
208
|
+
|
209
|
+
This is good enough for all built-in Vagrant provisioners (shell, chef, and
|
210
|
+
puppet) to work!
|
211
|
+
|
212
|
+
## Known Issues
|
213
|
+
|
214
|
+
* Can't boot from persistent disk - The underlying fog library does not
|
215
|
+
currently support booting from a persistent disk.
|
216
|
+
* No Tags - Tag support does not yet exist in the underlying fog library.
|
217
|
+
|
218
|
+
## Development
|
219
|
+
|
220
|
+
To work on the `vagrant-google` plugin, clone this repository out, and use
|
221
|
+
[Bundler](http://gembundler.com) to get the dependencies:
|
222
|
+
|
223
|
+
```
|
224
|
+
$ bundle
|
225
|
+
```
|
226
|
+
|
227
|
+
Once you have the dependencies, verify the unit tests pass with `rake`:
|
228
|
+
|
229
|
+
```
|
230
|
+
$ bundle exec rake
|
231
|
+
```
|
232
|
+
|
233
|
+
If those pass, you're ready to start developing the plugin. You can test
|
234
|
+
the plugin without installing it into your Vagrant environment by just
|
235
|
+
creating a `Vagrantfile` in the top level of this directory (it is gitignored)
|
236
|
+
that uses it, and uses bundler to execute Vagrant:
|
237
|
+
|
238
|
+
```
|
239
|
+
$ bundle exec vagrant up --provider=google
|
240
|
+
```
|
241
|
+
|
242
|
+
## Changelog
|
243
|
+
* See [CHANGELOG.md](https://github.com/mitchellh/vagrant-google/blob/master/CHANGELOG.md)
|
244
|
+
|
245
|
+
## Contributing
|
246
|
+
* See [CONTRIB.md](https://github.com/mitchellh/vagrant-google/blob/master/CONTRIB.md)
|
247
|
+
|
248
|
+
## Licensing
|
249
|
+
* See [LICENSE](https://github.com/mitchellh/vagrant-google/blob/master/LICENSE)
|
data/Rakefile
ADDED
@@ -0,0 +1,35 @@
|
|
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
|
+
require 'rubygems'
|
16
|
+
require 'bundler/setup'
|
17
|
+
require 'rspec/core/rake_task'
|
18
|
+
|
19
|
+
# Immediately sync all stdout so that tools like buildbot can
|
20
|
+
# immediately load in the output.
|
21
|
+
$stdout.sync = true
|
22
|
+
$stderr.sync = true
|
23
|
+
|
24
|
+
# Change to the directory of this file.
|
25
|
+
Dir.chdir(File.expand_path("../", __FILE__))
|
26
|
+
|
27
|
+
# This installs the tasks that help with gem creation and
|
28
|
+
# publishing.
|
29
|
+
Bundler::GemHelper.install_tasks
|
30
|
+
|
31
|
+
# Install the `spec` task so that we can run tests.
|
32
|
+
RSpec::Core::RakeTask.new
|
33
|
+
|
34
|
+
# Default task is to run the unit tests
|
35
|
+
task :default => "spec"
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Vagrant Google Example Box
|
2
|
+
|
3
|
+
Vagrant providers each require a custom provider-specific box format.
|
4
|
+
This folder shows the example contents of a box for the `google` provider.
|
5
|
+
To turn this into a box:
|
6
|
+
|
7
|
+
```
|
8
|
+
$ tar cvzf ../google.box ./metadata.json ./Vagrantfile
|
9
|
+
```
|
10
|
+
|
11
|
+
This box works by using Vagrant's built-in Vagrantfile merging to setup
|
12
|
+
defaults for Google. These defaults can easily be overwritten by higher-level
|
13
|
+
Vagrantfiles (such as project root Vagrantfiles).
|
data/google.box
ADDED
Binary file
|
@@ -0,0 +1,49 @@
|
|
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
|
+
require "fog"
|
15
|
+
require "log4r"
|
16
|
+
|
17
|
+
module VagrantPlugins
|
18
|
+
module Google
|
19
|
+
module Action
|
20
|
+
# This action connects to Google, verifies credentials work, and
|
21
|
+
# puts the Google connection object into the `:google_compute` key
|
22
|
+
# in the environment.
|
23
|
+
class ConnectGoogle
|
24
|
+
def initialize(app, env)
|
25
|
+
@app = app
|
26
|
+
@logger = Log4r::Logger.new("vagrant_google::action::connect_google")
|
27
|
+
end
|
28
|
+
|
29
|
+
def call(env)
|
30
|
+
provider_config = env[:machine].provider_config
|
31
|
+
|
32
|
+
# Build the fog config
|
33
|
+
fog_config = {
|
34
|
+
:provider => :google,
|
35
|
+
:google_project => provider_config.google_project_id,
|
36
|
+
:google_client_email => provider_config.google_client_email,
|
37
|
+
:google_key_location => provider_config.google_key_location
|
38
|
+
}
|
39
|
+
|
40
|
+
@logger.info("Connecting to Google...")
|
41
|
+
env[:google_compute] = Fog::Compute.new(fog_config)
|
42
|
+
|
43
|
+
@app.call(env)
|
44
|
+
@logger.info("...Connected!")
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|