Add ability to set individual replica count per region #387
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
It looks like the Azure SDK allows for there to be a global replica count as well as a regional replica count. I need to verify what happens when both values are set. @JenGoldstrich do you have insight on this by chance? |
nywilken
force-pushed
the
nywilken/target-region-replica-count
branch
from
90f50f1
to
5281a8c
Compare
This changes allows a user to set different replica counts for each target region defined with a shared_image_gallery_destination block. Closes: #386
For backwards compatibility setting shared_image_gallery_replica_count
with replication_regions, will set the replica count value for each
target region that is generated internally.
When setting replica counts using a target block the global attribute
for setting shared image gallery replica counts is not allowed.
```
~> packer validate
example/ubuntu_managed_image_sig.targetregions.pkr.hcl
Error: 1 error(s) occurred:
* `shared_image_gallery_replica_count` can not be defined alongside
`target_region`; you can specify the number of replicas per region
within a single target_region block.
on example/ubuntu_managed_image_sig.targetregions.pkr.hcl line 21:
(source code not available)
```
The replica count for the build location is set at the gallery level not the target region level in the API. To ensure the replica is set correctly, when using target_region blocks the replica count value for the build location is updated to match the value in target_region if set. If not set the global region count defaults to 1. When using replicated_regions the global replica count value is set as the value for the target region so that it matches the global count. In this situation the replica count will be honored by all target regions.
JenGoldstrich
force-pushed
the
nywilken/target-region-replica-count
branch
from
5281a8c
to
90e756f
Compare
JenGoldstrich
approved these changes
Apr 8, 2024
| if len(b.config.SharedGalleryDestination.SigDestinationTargetRegions) > 0 { | ||
| normalizedRegions := make([]TargetRegion, 0, len(b.config.SharedGalleryDestination.SigDestinationTargetRegions)) | ||
| for _, tr := range b.config.SharedGalleryDestination.SigDestinationTargetRegions { | ||
| tr.Name = normalizeAzureRegion(tr.Name) | ||
| normalizedRegions = append(normalizedRegions, tr) | ||
| if strings.EqualFold(tr.Name, buildLocation) && tr.ReplicaCount != 0 { |
| } | ||
|
|
||
| if c.SharedGalleryDestination.SigDestinationUseShallowReplicationMode { | ||
| if err := c.SharedGalleryDestination.ValidateShallowReplicationRegion(); err != nil { | ||
| errs = packersdk.MultiErrorAppend(errs, err) | ||
| } | ||
|
|
||
| if c.SharedGalleryImageVersionReplicaCount == 0 { |
| } | ||
|
|
||
| if (len(c.SharedGalleryDestination.SigDestinationTargetRegions) > 0) && c.SharedGalleryImageVersionReplicaCount != 0 { | ||
| errs = packersdk.MultiErrorAppend(errs, errors.New("`shared_image_gallery_replica_count` can not be defined alongside `target_region`; you can specify the number of replicas per region within target_region blocks.")) |
There was a problem hiding this comment.
Two notes on this I found the error message a bit confusing when talking about single target_region blocks so I reworded that
worth noting this is a breaking change since users would have had to set the replica count with shared_image_gallery_replica_count before, even when using a target_region block, so its worth making the next release a minor version bump, and calling this out in the release notes I think
|
getting the error when trying to use I tried different combinations of regional_replica_count, regionalReplicaCount, ReplicaCount and others, can you improve the documentation so that the target_region spec is more clear? currently is shows only you then expect to see something like this but nothing works? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This changes allows a user to set different replica counts for each
target region defined with a shared_image_gallery_destination block.
Closes: #386