-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2558 from fabriziopandini/clusterctl-cert-manager…
…-image-overrides ✨clusterctl: allow cert-manager image overrides
- Loading branch information
Showing
13 changed files
with
517 additions
and
20 deletions.
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| /* | ||
| Copyright 2020 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package config | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/docker/distribution/reference" | ||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| const ( | ||
| imagesConfigKey = "images" | ||
| allImageConfig = "all" | ||
| ) | ||
|
|
||
| // ImageMetaClient has methods to work with image meta configurations. | ||
| type ImageMetaClient interface { | ||
| // AlterImage alters an image name according to the current image override configurations. | ||
| AlterImage(component, image string) (string, error) | ||
| } | ||
|
|
||
| // imageMetaClient implements ImageMetaClient. | ||
| type imageMetaClient struct { | ||
| reader Reader | ||
| imageMetaCache map[string]*imageMeta | ||
| } | ||
|
|
||
| // ensure imageMetaClient implements ImageMetaClient. | ||
| var _ ImageMetaClient = &imageMetaClient{} | ||
|
|
||
| func newImageMetaClient(reader Reader) *imageMetaClient { | ||
| return &imageMetaClient{ | ||
| reader: reader, | ||
| imageMetaCache: map[string]*imageMeta{}, | ||
| } | ||
| } | ||
|
|
||
| func (p *imageMetaClient) AlterImage(component, image string) (string, error) { | ||
| // Gets the image meta that applies to the selected component; if none, returns early | ||
| meta, err := p.getImageMetaByComponent(component) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| if meta == nil { | ||
| return image, nil | ||
| } | ||
|
|
||
| // Apply the image meta to image name | ||
| return meta.ApplyToImage(image) | ||
| } | ||
|
|
||
| // getImageMetaByComponent returns the image meta that applies to the selected component | ||
| func (p *imageMetaClient) getImageMetaByComponent(component string) (*imageMeta, error) { | ||
| // if the image meta for the component is already known, return it | ||
| if im, ok := p.imageMetaCache[component]; ok { | ||
| return im, nil | ||
| } | ||
|
|
||
| // Otherwise read the image override configurations. | ||
| var meta map[string]imageMeta | ||
| if err := p.reader.UnmarshalKey(imagesConfigKey, &meta); err != nil { | ||
| return nil, errors.Wrap(err, "failed to unmarshal image override configurations") | ||
| } | ||
|
|
||
| // If there are not image override configurations, return. | ||
| if meta == nil { | ||
| p.imageMetaCache[component] = nil | ||
| return nil, nil | ||
| } | ||
|
|
||
| // Gets the image configuration and to the specific component, and returns the union of the two. | ||
| m := &imageMeta{} | ||
| if allMeta, ok := meta[allImageConfig]; ok { | ||
| m.Union(&allMeta) | ||
| } | ||
| if componentMeta, ok := meta[component]; ok { | ||
| m.Union(&componentMeta) | ||
| } | ||
|
|
||
| p.imageMetaCache[component] = m | ||
| return m, nil | ||
| } | ||
|
|
||
| // imageMeta allows to define transformations to apply to the image contained in the YAML manifests. | ||
| type imageMeta struct { | ||
| // repository sets the container registry to pull images from. | ||
| Repository string `json:"repository,omitempty"` | ||
|
|
||
| // Tag allows to specify a tag for the images. | ||
| Tag string `json:"tag,omitempty"` | ||
| } | ||
|
|
||
| // Union allows to merge two imageMeta transformation; in case both the imageMeta defines new values for the same field, | ||
| // the other transformation takes precedence on the existing one. | ||
| func (i *imageMeta) Union(other *imageMeta) { | ||
| if other.Repository != "" { | ||
| i.Repository = other.Repository | ||
| } | ||
| if other.Tag != "" { | ||
| i.Tag = other.Tag | ||
| } | ||
| } | ||
|
|
||
| // ApplyToImage changes an image name applying the transformations defined in the current imageMeta. | ||
| func (i *imageMeta) ApplyToImage(image string) (string, error) { | ||
| // Splits the image name into its own composing parts | ||
| ref, err := reference.ParseNormalizedNamed(image) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| // apply transformations | ||
| if i.Repository != "" { | ||
| // store tag & digest for rebuilding the image name | ||
| tagged, hasTag := ref.(reference.Tagged) | ||
| digested, hasDigest := ref.(reference.Digested) | ||
|
|
||
| // detect the image name, dropping host and path if any | ||
| name := ref.Name() | ||
| imageNameIndex := strings.LastIndex(name, "/") | ||
| if imageNameIndex != -1 { | ||
| name = strings.TrimPrefix(name[imageNameIndex+1:], "/") | ||
| } | ||
|
|
||
| // parse the new image resulting by concatenating the new repository and the image name | ||
| ref, err = reference.ParseNormalizedNamed(fmt.Sprintf("%s/%s", strings.TrimSuffix(i.Repository, "/"), name)) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| // applies back tag & digest | ||
| if hasTag { | ||
| ref, err = reference.WithTag(ref, tagged.Tag()) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| } | ||
|
|
||
| if hasDigest { | ||
| ref, err = reference.WithDigest(ref, digested.Digest()) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| } | ||
| } | ||
| if i.Tag != "" { | ||
| ref, err = reference.WithTag(reference.TrimNamed(ref), i.Tag) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| } | ||
|
|
||
| // returns the resulting image name | ||
| return ref.String(), nil | ||
| } |
Oops, something went wrong.