-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix 6323: allow compression of the configMap
Add the `--gzip-configmap=true` CLI parameter in order to compress the configMap, if it exeeds the max length. Signed-off-by: Nahshon Unna-Tsameret <nunnatsa@redhat.com>
- Loading branch information
Showing
8 changed files
with
676 additions
and
179 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# entries is a list of entries to include in | ||
# release notes and/or the migration guide | ||
entries: | ||
- description: > | ||
Allow compress the bundle content. Added a new cli flag `--gzip-configmap=true` to the `operator-sdk run bundle`. | ||
This will create compressed configmaps. Use it when getting this error: | ||
`... ConfigMap ... is invalid: []: Too long: must have at most 1048576 bytes`. | ||
Fixes issue [#6323](https://github.com/operator-framework/operator-sdk/issues/6323) | ||
# kind is one of: | ||
# - addition | ||
# - change | ||
# - deprecation | ||
# - removal | ||
# - bugfix | ||
kind: "bugfix" | ||
# Is this a breaking change? | ||
breaking: false |
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
240 changes: 240 additions & 0 deletions
240
internal/olm/operator/registry/fbcindex/configMapWriter.go
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,240 @@ | ||
// Copyright 2023 The Operator-SDK 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 fbcindex | ||
|
||
import ( | ||
"bytes" | ||
"compress/gzip" | ||
"fmt" | ||
"strings" | ||
|
||
corev1 "k8s.io/api/core/v1" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
) | ||
|
||
const ( | ||
yamlSeparator = "\n---\n" | ||
gzipSuffixLength = 13 | ||
maxGZIPLength = maxConfigMapSize - gzipSuffixLength | ||
|
||
ConfigMapEncodingAnnotationKey = "olm.contentEncoding" | ||
ConfigMapEncodingAnnotationGzip = "gzip+base64" | ||
) | ||
|
||
/* | ||
This file implements the actual building of the CM list. It uses the template method design pattern to implement both | ||
regular string VM, and compressed binary CM. | ||
The method itself is FBCRegistryPod.getConfigMaps. This file contains the actual implementation of the writing actions, | ||
used by the method. | ||
*/ | ||
|
||
type configMapWriter interface { | ||
reset() | ||
newConfigMap(string) *corev1.ConfigMap | ||
getFilePath() string | ||
isEmpty() bool | ||
exceedMaxLength(cmSize int, data string) (bool, error) | ||
closeCM(cm *corev1.ConfigMap) error | ||
addData(data string) error | ||
continueAddData(data string) error | ||
writeLastFragment(cm *corev1.ConfigMap) error | ||
} | ||
|
||
type defaultCMWriter struct { | ||
cmName string | ||
namespace string | ||
dataBuilder strings.Builder | ||
} | ||
|
||
func newDefaultWriter(name, namespace string) *defaultCMWriter { | ||
return &defaultCMWriter{ | ||
cmName: name, | ||
namespace: namespace, | ||
dataBuilder: strings.Builder{}, | ||
} | ||
} | ||
|
||
func (cmw *defaultCMWriter) reset() { | ||
cmw.dataBuilder = strings.Builder{} | ||
} | ||
|
||
func (cmw *defaultCMWriter) newConfigMap(name string) *corev1.ConfigMap { | ||
return &corev1.ConfigMap{ | ||
TypeMeta: metav1.TypeMeta{ | ||
APIVersion: corev1.SchemeGroupVersion.String(), | ||
Kind: "ConfigMap", | ||
}, | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Name: name, | ||
Namespace: cmw.namespace, | ||
}, | ||
Data: map[string]string{}, | ||
} | ||
} | ||
|
||
func (cmw *defaultCMWriter) isEmpty() bool { | ||
return cmw.dataBuilder.Len() > 0 | ||
} | ||
|
||
func (cmw *defaultCMWriter) exceedMaxLength(cmSize int, data string) (bool, error) { | ||
return cmSize+cmw.dataBuilder.Len()+len(data) > maxConfigMapSize, nil | ||
} | ||
|
||
func (cmw *defaultCMWriter) closeCM(cm *corev1.ConfigMap) error { | ||
cm.Data[defaultConfigMapKey] = cmw.dataBuilder.String() | ||
cmw.dataBuilder = strings.Builder{} | ||
return nil | ||
} | ||
|
||
func (cmw *defaultCMWriter) getFilePath() string { | ||
return fmt.Sprintf("%s.yaml", defaultConfigMapKey) | ||
} | ||
|
||
func (cmw *defaultCMWriter) addData(data string) error { | ||
cmw.dataBuilder.WriteString(data) | ||
return nil | ||
} | ||
|
||
// continueAddData completes adding the data after starting adding it in exceedMaxLength | ||
func (cmw *defaultCMWriter) continueAddData(data string) error { | ||
return cmw.addData(data) | ||
} | ||
|
||
func (cmw *defaultCMWriter) writeLastFragment(cm *corev1.ConfigMap) error { | ||
cm.Data[defaultConfigMapKey] = cmw.dataBuilder.String() | ||
|
||
return nil | ||
} | ||
|
||
type gzipCMWriter struct { | ||
actualBuff *bytes.Buffer | ||
helperBuff *bytes.Buffer | ||
actualWriter *gzip.Writer | ||
helperWriter *gzip.Writer | ||
cmName string | ||
namespace string | ||
} | ||
|
||
func newGZIPWriter(name, namespace string) *gzipCMWriter { | ||
actualBuff := &bytes.Buffer{} | ||
helperBuff := &bytes.Buffer{} | ||
|
||
return &gzipCMWriter{ | ||
actualBuff: actualBuff, | ||
helperBuff: helperBuff, | ||
actualWriter: gzip.NewWriter(actualBuff), | ||
helperWriter: gzip.NewWriter(helperBuff), | ||
cmName: name, | ||
namespace: namespace, | ||
} | ||
} | ||
|
||
func (cmw *gzipCMWriter) reset() { | ||
cmw.actualBuff.Reset() | ||
cmw.actualWriter.Reset(cmw.actualBuff) | ||
cmw.helperBuff.Reset() | ||
cmw.helperWriter.Reset(cmw.helperBuff) | ||
} | ||
|
||
func (cmw *gzipCMWriter) newConfigMap(name string) *corev1.ConfigMap { | ||
return &corev1.ConfigMap{ | ||
TypeMeta: metav1.TypeMeta{ | ||
APIVersion: corev1.SchemeGroupVersion.String(), | ||
Kind: "ConfigMap", | ||
}, | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Namespace: cmw.namespace, | ||
Name: name, | ||
Annotations: map[string]string{ | ||
ConfigMapEncodingAnnotationKey: ConfigMapEncodingAnnotationGzip, | ||
}, | ||
}, | ||
BinaryData: map[string][]byte{}, | ||
} | ||
} | ||
|
||
func (cmw *gzipCMWriter) getFilePath() string { | ||
return fmt.Sprintf("%s.yaml.gz", defaultConfigMapKey) | ||
} | ||
|
||
func (cmw *gzipCMWriter) isEmpty() bool { | ||
return cmw.actualBuff.Len() > 0 | ||
} | ||
|
||
func (cmw *gzipCMWriter) exceedMaxLength(cmSize int, data string) (bool, error) { | ||
_, err := cmw.helperWriter.Write([]byte(data)) | ||
if err != nil { | ||
return false, err | ||
} | ||
|
||
err = cmw.helperWriter.Flush() | ||
if err != nil { | ||
return false, err | ||
} | ||
|
||
return cmSize+cmw.helperBuff.Len() > maxGZIPLength, nil | ||
} | ||
|
||
func (cmw *gzipCMWriter) closeCM(cm *corev1.ConfigMap) error { | ||
err := cmw.actualWriter.Close() | ||
if err != nil { | ||
return err | ||
} | ||
|
||
err = cmw.actualWriter.Flush() | ||
if err != nil { | ||
return err | ||
} | ||
|
||
cm.BinaryData[defaultConfigMapKey] = make([]byte, cmw.actualBuff.Len()) | ||
copy(cm.BinaryData[defaultConfigMapKey], cmw.actualBuff.Bytes()) | ||
|
||
cmw.reset() | ||
|
||
return nil | ||
} | ||
|
||
func (cmw *gzipCMWriter) addData(data string) error { | ||
dataBytes := []byte(data) | ||
_, err := cmw.helperWriter.Write(dataBytes) | ||
if err != nil { | ||
return err | ||
} | ||
_, err = cmw.actualWriter.Write(dataBytes) | ||
if err != nil { | ||
return err | ||
} | ||
return nil | ||
} | ||
|
||
// continueAddData completes adding the data after starting adding it in exceedMaxLength | ||
func (cmw *gzipCMWriter) continueAddData(data string) error { | ||
_, err := cmw.actualWriter.Write([]byte(data)) | ||
if err != nil { | ||
return err | ||
} | ||
return nil | ||
} | ||
|
||
func (cmw *gzipCMWriter) writeLastFragment(cm *corev1.ConfigMap) error { | ||
err := cmw.actualWriter.Close() | ||
if err != nil { | ||
return err | ||
} | ||
|
||
cm.BinaryData[defaultConfigMapKey] = cmw.actualBuff.Bytes() | ||
return nil | ||
} |
Oops, something went wrong.