puppetlabs/vmpooler-provider-gce
2
0
Fork 0
mirror of https://github.com/puppetlabs/vmpooler-provider-gce.git synced 2026-01-25 19:18:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
VMpooler provider for GCE
26 commits 2 branches 11 tags 338 KiB
Find a file
Exact
Samuel 614c474305
Update version.rb 
preparation for releasing gem
2022-01-10 15:53:44 -06:00
.github Add a release workflow for pushing to Rubygems 2021-12-08 10:33:29 -05:00
lib Update version.rb 2022-01-10 15:53:44 -06:00
scripts fix dns_setup as zone was already a method 2022-01-06 16:39:53 -06:00
spec fix dns_setup as zone was already a method 2022-01-06 16:39:53 -06:00
.gitignore Adding the cloud DNS API library and related methods 2021-12-29 08:21:51 -06:00
.jrubyrc fix simplecov with jruby, add a .rubocop.yml config file 2021-12-10 12:34:06 -06:00
.rubocop.yml fix rubocop and spec tests 2021-12-29 12:02:55 -06:00
CODEOWNERS (DIO-2768) Initial gce provider 2021-12-02 14:27:31 -06:00
Gemfile (DIO-2768) Initial gce provider 2021-12-02 14:27:31 -06:00
LICENSE adding spec tests 2021-12-07 08:41:55 -06:00
Rakefile (DIO-2768) Initial gce provider 2021-12-02 14:27:31 -06:00
README.md code review fixes 2021-12-29 12:17:25 -06:00
vmpooler-provider-gce.gemspec code review fixes 2021-12-29 12:17:25 -06:00
vmpooler.yaml.example refactor dns_zone to be renamed domain to match the global parameter being overwritten 2021-12-31 10:30:18 -06:00

README.md

vmpooler-provider-gce

This is a provider for VMPooler allows using GCE to create instances, disks, snapshots, or destroy instances for specific pools.

Usage

Include this gem in the same Gemfile that you use to install VMPooler itself and then define one or more pools with the provider key set to gce. VMPooler will take care of the rest. See what configuration is needed for this provider in the example file.

Examples of deploying VMPooler with extra providers can be found in the puppetlabs/vmpooler-deployment repository.

GCE authorization is handled via a service account (or personal account) private key (json format) and can be configured via

  1. GOOGLE_APPLICATION_CREDENTIALS environment variable eg GOOGLE_APPLICATION_CREDENTIALS=/my/home/directory/my_account_key.json

DNS

DNS is integrated via Google's CloudDNS service. To enable, a CloudDNS zone name must be provided in the config (see the example yaml file dns_zone_resource_name)

An A record is then created in that zone upon instance creation with the VM's internal IP, and deleted when the instance is destroyed.

Labels

This provider adds labels to all resources that are managed

resource labels note
instance vm=$vm_name, pool=$pool_name for example vm=foo-bar, pool=pool1
disk vm=$vm_name, pool=$pool_name for example vm=foo-bar and pool=pool1
snapshot snapshot_name=$snapshot_name, vm=$vm_name, pool=$pool_name for example snapshot_name=snap1, vm=foo-bar, pool=pool1

Also see the usage of vmpooler's optional purge_unconfigured_resources, which is used to delete any resource found that do not have the pool label, and can be configured to allow a specific list of unconfigured pool names.

Pre-requisite

  • A service account needs to be created and a private json key generated (see usage section)
  • The service account needs to be given permissions to the project (broad permissions would be compute v1 admin and dns admin). A yaml file is provided that lists the least-privilege permissions needed
  • if using DNS, a DNS zone needs to be created in CloudDNS, and configured in the provider's config section with the name of that zone (dns_zone_resource_name). When not specified, the DNS setup and teardown is skipped.

License

vmpooler-provider-gce is distributed under the Apache License, Version 2.0. See the LICENSE file for more details.