Skip to content
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

feat(cmd): improve kamel promote #4621

Merged
merged 3 commits into from
Aug 1, 2023
Merged

feat(cmd): improve kamel promote #4621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e16d31
fix(cmd): don't validate on dry-run
squakez Jul 28, 2023
81a8df8
feat(cmd): promote image only
squakez Jul 28, 2023
acca79e
feat(cmd): promote multi tenancy
squakez Jul 28, 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
100 changes: 69 additions & 31 deletions pkg/cmd/promote.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,31 +49,38 @@ func newCmdPromote(rootCmdOptions *RootCmdOptions) (*cobra.Command, *promoteCmdO
RootCmdOptions: rootCmdOptions,
}
cmd := cobra.Command{
Use: "promote my-it --to [namespace]",
Use: "promote my-it [--to <namespace>] [-x <promoted-operator-id>]",
Short: "Promote an Integration/Pipe from an environment to another",
Long: "Promote an Integration/Pipe from an environment to another, for example from a Development environment to a Production environment",
PreRunE: decode(&options),
RunE: options.run,
}

cmd.Flags().String("to", "", "The namespace where to promote the Integration")
cmd.Flags().String("to", "", "The namespace where to promote the Integration/Pipe")
cmd.Flags().StringP("to-operator", "x", "", "The operator id which will reconcile the promoted Integration/Pipe")
cmd.Flags().StringP("output", "o", "", "Output format. One of: json|yaml")
cmd.Flags().BoolP("image", "i", false, "Output the container image only")

return &cmd, &options
}

type promoteCmdOptions struct {
*RootCmdOptions
To string `mapstructure:"to" yaml:",omitempty"`
ToOperator string `mapstructure:"to-operator" yaml:",omitempty"`
OutputFormat string `mapstructure:"output" yaml:",omitempty"`
Image bool `mapstructure:"image" yaml:",omitempty"`
}

func (o *promoteCmdOptions) validate(_ *cobra.Command, args []string) error {
if len(args) != 1 {
return errors.New("promote expects an Integration/Pipe name argument")
return errors.New("promote requires an Integration/Pipe name argument")
}
if o.To == "" {
return errors.New("promote expects a destination namespace as --to argument")
return errors.New("promote requires a destination namespace as --to argument")
}
if o.To == o.Namespace {
return errors.New("source and destination namespaces must be different in order to avoid promoted Integration/Pipe clashes with the source Integration/Pipe")
}
return nil
}
Expand All @@ -88,19 +95,23 @@ func (o *promoteCmdOptions) run(cmd *cobra.Command, args []string) error {
if err != nil {
return fmt.Errorf("could not retrieve cluster client: %w", err)
}
opSource, err := operatorInfo(o.Context, c, o.Namespace)
if err != nil {
return fmt.Errorf("could not retrieve info for Camel K operator source: %w", err)
}
opDest, err := operatorInfo(o.Context, c, o.To)
if err != nil {
return fmt.Errorf("could not retrieve info for Camel K operator destination: %w", err)
}
if !o.isDryRun() {
// Skip these checks if in dry mode
opSource, err := operatorInfo(o.Context, c, o.Namespace)
if err != nil {
return fmt.Errorf("could not retrieve info for Camel K operator source: %w", err)
}
opDest, err := operatorInfo(o.Context, c, o.To)
if err != nil {
return fmt.Errorf("could not retrieve info for Camel K operator destination: %w", err)
}

err = checkOpsCompatibility(cmd, opSource, opDest)
if err != nil {
return fmt.Errorf("could not verify operators compatibility: %w", err)
err = checkOpsCompatibility(cmd, opSource, opDest)
if err != nil {
return fmt.Errorf("could not verify operators compatibility: %w", err)
}
}

promotePipe := false
var sourceIntegration *v1.Integration
// We first look if a Pipe with the name exists
Expand All @@ -118,41 +129,51 @@ func (o *promoteCmdOptions) run(cmd *cobra.Command, args []string) error {
if sourceIntegration.Status.Phase != v1.IntegrationPhaseRunning {
return fmt.Errorf("could not promote an Integration in %s status", sourceIntegration.Status.Phase)
}
err = o.validateDestResources(c, sourceIntegration)
if err != nil {
return fmt.Errorf("could not validate destination resources: %w", err)

// Image only mode
if o.Image {
showImageOnly(cmd, sourceIntegration)
return nil
}

if !o.isDryRun() {
// Skip these checks if in dry mode
err = o.validateDestResources(c, sourceIntegration)
if err != nil {
return fmt.Errorf("could not validate destination resources: %w", err)
}
}

// Pipe promotion
if promotePipe {
destPipe := o.editPipe(sourcePipe, sourceIntegration)
if o.OutputFormat != "" {
return showPipeOutput(cmd, destPipe, o.OutputFormat, c.GetScheme())
}
// Ensure the destination namespace has access to the source namespace images
err = addSystemPullerRoleBinding(o.Context, c, sourceIntegration.Namespace, destPipe.Namespace)
if err != nil {
return err
}
replaced, err := o.replaceResource(destPipe)
if o.OutputFormat != "" {
return showPipeOutput(cmd, destPipe, o.OutputFormat, c.GetScheme())
}
if !replaced {
fmt.Fprintln(cmd.OutOrStdout(), `Promoted Integration "`+name+`" created`)
fmt.Fprintln(cmd.OutOrStdout(), `Promoted Pipe "`+name+`" created`)
} else {
fmt.Fprintln(cmd.OutOrStdout(), `Promoted Integration "`+name+`" updated`)
fmt.Fprintln(cmd.OutOrStdout(), `Promoted Pipe "`+name+`" updated`)
}
return err
}

// Plain Integration promotion
destIntegration := o.editIntegration(sourceIntegration)
if o.OutputFormat != "" {
return showIntegrationOutput(cmd, destIntegration, o.OutputFormat)
}
// Ensure the destination namespace has access to the source namespace images
err = addSystemPullerRoleBinding(o.Context, c, sourceIntegration.Namespace, destIntegration.Namespace)
if err != nil {
return err
}
if o.OutputFormat != "" {
return showIntegrationOutput(cmd, destIntegration, o.OutputFormat)
}
replaced, err := o.replaceResource(destIntegration)
if !replaced {
fmt.Fprintln(cmd.OutOrStdout(), `Promoted Integration "`+name+`" created`)
Expand Down Expand Up @@ -441,7 +462,7 @@ func (o *promoteCmdOptions) editIntegration(it *v1.Integration) *v1.Integration
dst := v1.NewIntegration(o.To, it.Name)
contImage := it.Status.Image
dst.Spec = *it.Spec.DeepCopy()
dst.Annotations = cloneAnnotations(it.Annotations)
dst.Annotations = cloneAnnotations(it.Annotations, o.ToOperator)
dst.Labels = cloneLabels(it.Labels)
if dst.Spec.Traits.Container == nil {
dst.Spec.Traits.Container = &traitv1.ContainerTrait{}
Expand All @@ -450,14 +471,23 @@ func (o *promoteCmdOptions) editIntegration(it *v1.Integration) *v1.Integration
return &dst
}

// Return all annotations but the ones specific to source (ie, the operator).
func cloneAnnotations(ann map[string]string) map[string]string {
// Return all annotations overriding the operator Id if provided.
func cloneAnnotations(ann map[string]string, operatorID string) map[string]string {
operatorIDAnnotationSet := false
newMap := make(map[string]string)
for k, v := range ann {
if k != v1.OperatorIDAnnotation {
if k == v1.OperatorIDAnnotation {
if operatorID != "" {
newMap[v1.OperatorIDAnnotation] = operatorID
operatorIDAnnotationSet = true
}
} else {
newMap[k] = v
}
}
if !operatorIDAnnotationSet && operatorID != "" {
newMap[v1.OperatorIDAnnotation] = operatorID
}
return newMap
}

Expand All @@ -473,7 +503,7 @@ func cloneLabels(lbs map[string]string) map[string]string {
func (o *promoteCmdOptions) editPipe(kb *v1.Pipe, it *v1.Integration) *v1.Pipe {
dst := v1.NewPipe(o.To, kb.Name)
dst.Spec = *kb.Spec.DeepCopy()
dst.Annotations = cloneAnnotations(kb.Annotations)
dst.Annotations = cloneAnnotations(kb.Annotations, o.ToOperator)
dst.Labels = cloneLabels(kb.Labels)
contImage := it.Status.Image
if dst.Spec.Integration == nil {
Expand Down Expand Up @@ -503,6 +533,10 @@ func (o *promoteCmdOptions) replaceResource(res k8sclient.Object) (bool, error)
return kubernetes.ReplaceResource(o.Context, o._client, res)
}

func (o *promoteCmdOptions) isDryRun() bool {
return o.OutputFormat != "" || o.Image
}

// RoleBinding is required to allow access to images in one namespace
// by another namespace. Without this on rbac-enabled clusters, the
// image cannot be pulled.
Expand Down Expand Up @@ -533,3 +567,7 @@ func addSystemPullerRoleBinding(ctx context.Context, c client.Client, sourceNS s

return err
}

func showImageOnly(cmd *cobra.Command, integration *v1.Integration) {
fmt.Fprintln(cmd.OutOrStdout(), integration.Status.Image)
}
102 changes: 97 additions & 5 deletions pkg/cmd/promote_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,8 @@ func TestIntegrationNotCompatible(t *testing.T) {
srcCatalog := createTestCamelCatalog(srcPlatform)
dstCatalog := createTestCamelCatalog(dstPlatform)

promoteCmdOptions, promoteCmd, _ := initializePromoteCmdOptions(t, &srcPlatform, &dstPlatform, &defaultIntegration, &srcCatalog, &dstCatalog)
_, err := test.ExecuteCommand(promoteCmd, cmdPromote, "my-it-test", "--to", "prod-namespace", "-o", "yaml", "-n", "default")
assert.Equal(t, "yaml", promoteCmdOptions.OutputFormat)
_, promoteCmd, _ := initializePromoteCmdOptions(t, &srcPlatform, &dstPlatform, &defaultIntegration, &srcCatalog, &dstCatalog)
_, err := test.ExecuteCommand(promoteCmd, cmdPromote, "my-it-test", "--to", "prod-namespace", "-n", "default")
assert.NotNil(t, err)
assert.Equal(t,
fmt.Sprintf("could not verify operators compatibility: source (%s) and destination (0.0.1) Camel K operator versions are not compatible", defaults.Version),
Expand Down Expand Up @@ -137,7 +136,6 @@ metadata:
creationTimestamp: null
name: my-kb-test
namespace: prod-namespace
resourceVersion: "1"
spec:
integration:
traits:
Expand Down Expand Up @@ -238,7 +236,6 @@ metadata:
my-label: my-value
name: my-kb-test
namespace: prod-namespace
resourceVersion: "1"
spec:
integration:
traits:
Expand All @@ -249,3 +246,98 @@ spec:
status: {}
`, output)
}

func TestItImageOnly(t *testing.T) {
srcPlatform := v1.NewIntegrationPlatform("default", platform.DefaultPlatformName)
srcPlatform.Status.Version = defaults.Version
srcPlatform.Status.Build.RuntimeVersion = defaults.DefaultRuntimeVersion
srcPlatform.Status.Phase = v1.IntegrationPlatformPhaseReady
dstPlatform := v1.NewIntegrationPlatform("prod-namespace", platform.DefaultPlatformName)
dstPlatform.Status.Version = defaults.Version
dstPlatform.Status.Build.RuntimeVersion = defaults.DefaultRuntimeVersion
dstPlatform.Status.Phase = v1.IntegrationPlatformPhaseReady
defaultIntegration := nominalIntegration("my-it-test")
srcCatalog := createTestCamelCatalog(srcPlatform)
dstCatalog := createTestCamelCatalog(dstPlatform)

_, promoteCmd, _ := initializePromoteCmdOptions(t, &srcPlatform, &dstPlatform, &defaultIntegration, &srcCatalog, &dstCatalog)
output, err := test.ExecuteCommand(promoteCmd, cmdPromote, "my-it-test", "--to", "prod-namespace", "-i", "-n", "default")
assert.Nil(t, err)
assert.Equal(t, "my-special-image\n", output)
}

func TestPipeImageOnly(t *testing.T) {
srcPlatform := v1.NewIntegrationPlatform("default", platform.DefaultPlatformName)
srcPlatform.Status.Version = defaults.Version
srcPlatform.Status.Build.RuntimeVersion = defaults.DefaultRuntimeVersion
srcPlatform.Status.Phase = v1.IntegrationPlatformPhaseReady
dstPlatform := v1.NewIntegrationPlatform("prod-namespace", platform.DefaultPlatformName)
dstPlatform.Status.Version = defaults.Version
dstPlatform.Status.Build.RuntimeVersion = defaults.DefaultRuntimeVersion
dstPlatform.Status.Phase = v1.IntegrationPlatformPhaseReady
defaultKB := nominalPipe("my-kb-test")
defaultIntegration := nominalIntegration("my-kb-test")
srcCatalog := createTestCamelCatalog(srcPlatform)
dstCatalog := createTestCamelCatalog(dstPlatform)

_, promoteCmd, _ := initializePromoteCmdOptions(t, &srcPlatform, &dstPlatform, &defaultKB, &defaultIntegration, &srcCatalog, &dstCatalog)
output, err := test.ExecuteCommand(promoteCmd, cmdPromote, "my-kb-test", "--to", "prod-namespace", "-i", "-n", "default")
assert.Nil(t, err)
assert.Equal(t, "my-special-image\n", output)
}

func TestIntegrationToOperatorId(t *testing.T) {
srcPlatform := v1.NewIntegrationPlatform("default", platform.DefaultPlatformName)
srcPlatform.Status.Version = defaults.Version
srcPlatform.Status.Build.RuntimeVersion = defaults.DefaultRuntimeVersion
srcPlatform.Status.Phase = v1.IntegrationPlatformPhaseReady
dstPlatform := v1.NewIntegrationPlatform("prod-namespace", platform.DefaultPlatformName)
dstPlatform.Status.Version = defaults.Version
dstPlatform.Status.Build.RuntimeVersion = defaults.DefaultRuntimeVersion
dstPlatform.Status.Phase = v1.IntegrationPlatformPhaseReady
defaultIntegration := nominalIntegration("my-it-test")
srcCatalog := createTestCamelCatalog(srcPlatform)
dstCatalog := createTestCamelCatalog(dstPlatform)

// Verify default (missing) operator Id
promoteCmdOptions, promoteCmd, _ := initializePromoteCmdOptions(t, &srcPlatform, &dstPlatform, &defaultIntegration, &srcCatalog, &dstCatalog)
output, err := test.ExecuteCommand(promoteCmd, cmdPromote, "my-it-test", "-x", "my-prod-operator", "-o", "yaml", "--to", "prod")
assert.Equal(t, "yaml", promoteCmdOptions.OutputFormat)
assert.Nil(t, err)
assert.Equal(t, `apiVersion: camel.apache.org/v1
kind: Integration
metadata:
annotations:
camel.apache.org/operator.id: my-prod-operator
creationTimestamp: null
name: my-it-test
namespace: prod
spec:
traits:
container:
image: my-special-image
status: {}
`, output)
// Verify also when the operator Id is set in the integration
defaultIntegration.Annotations = map[string]string{
"camel.apache.org/operator.id": "camel-k",
}
promoteCmdOptions, promoteCmd, _ = initializePromoteCmdOptions(t, &srcPlatform, &dstPlatform, &defaultIntegration, &srcCatalog, &dstCatalog)
output, err = test.ExecuteCommand(promoteCmd, cmdPromote, "my-it-test", "-x", "my-prod-operator", "-o", "yaml", "--to", "prod")
assert.Equal(t, "yaml", promoteCmdOptions.OutputFormat)
assert.Nil(t, err)
assert.Equal(t, `apiVersion: camel.apache.org/v1
kind: Integration
metadata:
annotations:
camel.apache.org/operator.id: my-prod-operator
creationTimestamp: null
name: my-it-test
namespace: prod
spec:
traits:
container:
image: my-special-image
status: {}
`, output)
}