Skip to content

(RE-15124) Implement DNS Plugins and Remove api v1 and v2 #551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yachub merged 19 commits into from
Mar 28, 2023
Merged

(RE-15124) Implement DNS Plugins and Remove api v1 and v2 #551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
ac96550
Stub out dns provider usage
yachub Feb 3, 2023
65f0425
Add delete_record
yachub Feb 7, 2023
b1e20a2
Get zone from config and add dns/base_spec
yachub Feb 7, 2023
89a4273
Add migration to readme
yachub Feb 7, 2023
6f3d853
Do not create/delete records if using dynamic dns
yachub Feb 15, 2023
268ff9f
Add dns_config method to provider base
yachub Feb 15, 2023
aeabb7e
Remove global domain usage from pool manager
yachub Feb 16, 2023
35dc7cb
Update domain in V2 api
yachub Feb 16, 2023
0119126
Update hostname_shorten and callers
yachub Feb 16, 2023
da4015f
Refactor obtaining and saving ip address
yachub Feb 17, 2023
eaa1104
Fix rubocops
yachub Feb 23, 2023
fb80d98
Removed api/v1 spec tests
yachub Feb 23, 2023
91248fe
Added spec tests for Vmpooler::Dns
yachub Feb 23, 2023
1df7ab6
Fix tests based on new dns config
yachub Feb 24, 2023
d0d97dd
Update docs
yachub Feb 27, 2023
9320175
Add v3 api and remove v2
yachub Mar 7, 2023
527f42c
Remove api reroute in favor of using versioned api directly
yachub Mar 7, 2023
528e963
exit application if domain setting is used
yachub Mar 14, 2023
669ecae
Point dashboard to v3 api
yachub Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 22 additions & 44 deletions .rubocop_todo.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
# SupportedStyles: with_first_parameter, with_fixed_indentation
Layout/ParameterAlignment:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 9
# Cop supports --auto-correct.
Expand All @@ -22,15 +21,13 @@ Layout/ParameterAlignment:
Layout/CaseIndentation:
Exclude:
- 'lib/vmpooler/api/helpers.rb'
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
# Cop supports --auto-correct.
Layout/ClosingParenthesisIndentation:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
# Cop supports --auto-correct.
Expand Down Expand Up @@ -61,25 +58,22 @@ Layout/EmptyLinesAroundModuleBody:
Layout/FirstHashElementIndentation:
Exclude:
- 'lib/vmpooler/api/helpers.rb'
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: Width, IgnoredPatterns.
Layout/IndentationWidth:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: symmetrical, new_line, same_line
Layout/MultilineMethodCallBraceLayout:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
# Cop supports --auto-correct.
Expand All @@ -93,16 +87,14 @@ Layout/SpaceAroundEqualsInParameterDefault:
# Cop supports --auto-correct.
Layout/SpaceAroundKeyword:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: AllowForAlignment.
Layout/SpaceAroundOperators:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 8
# Cop supports --auto-correct.
Expand All @@ -117,16 +109,14 @@ Layout/SpaceInsideHashLiteralBraces:
# Cop supports --auto-correct.
Layout/SpaceInsideParens:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 2
# Configuration parameters: AllowSafeAssignment.
Lint/AssignmentInCondition:
Exclude:
- 'lib/vmpooler/api/helpers.rb'
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 2
Lint/SuppressedException:
Expand Down Expand Up @@ -158,8 +148,7 @@ Lint/UselessAssignment:
Style/AndOr:
Exclude:
- 'lib/vmpooler/api/helpers.rb'
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
Style/CaseEquality:
Expand All @@ -180,33 +169,29 @@ Style/For:
Style/HashSyntax:
Exclude:
- 'lib/vmpooler/api/helpers.rb'
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: MaxLineLength.
Style/IfUnlessModifier:
Exclude:
- 'lib/vmpooler/api/helpers.rb'
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, SupportedStyles.
# SupportedStyles: both, prefix, postfix
Style/NegatedIf:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 3
# Cop supports --auto-correct.
Style/Not:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
# Cop supports --auto-correct.
Expand All @@ -215,30 +200,26 @@ Style/Not:
Style/NumericPredicate:
Exclude:
- 'spec/**/*'
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 2
# Cop supports --auto-correct.
Style/ParallelAssignment:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: AllowSafeAssignment.
Style/ParenthesesAroundCondition:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 2
# Cop supports --auto-correct.
Style/PerlBackrefs:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
Expand All @@ -254,8 +235,7 @@ Naming/PredicateName:
# Cop supports --auto-correct.
Style/RedundantParentheses:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 2
# Cop supports --auto-correct.
Expand All @@ -276,8 +256,7 @@ Style/RedundantSelf:
# SupportedStyles: single_quotes, double_quotes
Style/StringLiterals:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
# Cop supports --auto-correct.
Expand All @@ -292,8 +271,7 @@ Style/TernaryParentheses:
# SupportedStyles: snake_case, camelCase
Naming/VariableName:
Exclude:
- 'lib/vmpooler/api/v1.rb'
- 'lib/vmpooler/api/v2.rb'
- 'lib/vmpooler/api/v3.rb'

# Offense count: 1
# Cop supports --auto-correct.
Expand Down
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- [VMPooler](#vmpooler)
- [Usage](#usage)
- [Migrating to v3](#migrating-to-v3)
- [v2.0.0 note](#v200-note)
- [Installation](#installation)
- [Dependencies](#dependencies)
Expand All @@ -30,6 +31,38 @@ VMPooler provides configurable 'pools' of instantly-available (pre-provisioned)

At [Puppet, Inc.](http://puppet.com) we run acceptance tests on thousands of disposable VMs every day. VMPooler manages the life cycle of these VMs from request through deletion, with options available to pool ready instances, and provision on demand.

### Migrating to v3

Starting with the v3.x release, management of DNS records is implemented as DNS plugins, similar to compute providers. This means each pool configuration should be pointing to a configuration object in `:dns_config` to determine it's method of record management.

For those using the global `DOMAIN` environment variable or global `:config.domain` key, this means records were not previously being managed by VMPooler (presumably managed via dynamic dns), so it's value should be moved to `:dns_configs:<INSERT_YOUR_OWN_SYMBOL>:domain` with the value for `dns_class` for the config set to `dynamic-dns`.

For example, the following < v3.x configuration:

```yaml
:config:
domain: 'example.com'
```
Comment thread
genebean marked this conversation as resolved.

becomes:

```yaml
:dns_configs:
:example:
dns_class: dynamic-dns
domain: 'example.com'
```

Then any pools that should have records created via the dns config above should now reference the named dns config in the `dns_plugin` key:

```yaml
:pools:
- name: 'debian-8-x86_64'
dns_plugin: 'example'
```

For those using the GCE provider, [vmpooler-provider-gce](https://github.com/puppetlabs/vmpooler-provider-gce), as of version 1.x the DNS management has been decoupled. See <https://github.com/puppetlabs/vmpooler-provider-gce#migrating-to-v1>

### v2.0.0 note

As of version 2.0.0, all providers other than the dummy one are now separate gems. Historically the vSphere provider was included within VMPooler itself. That code has been moved to the [puppetlabs/vmpooler-provider-vsphere](https://github.com/puppetlabs/vmpooler-provider-vsphere) repository and the `vmpooler-provider-vsphere` gem. To migrate from VMPooler 1.x to 2.0 you will need to ensure that `vmpooler-provider-vsphere` is installed along side the `vmpooler` gem. See the [Provider API](docs/PROVIDER_API.md) docs for more information.
Expand Down
Loading