Deployment configuration and v1alpha2 version

[gazarenkov]

Description

This PR includes new way to configure Backstage deployment, now (in contrary to raw config) it is possible to add the changes as a and valid "fragment" of appsv1.deployment object inside Backstage CR and those fields will be merged with default (+raw) configuration, like:

apiVersion: rhdh.redhat.com/v1alpha2
kind: Backstage
metadata:
  name: my-backstage
spec:
  deployment:
    patch:
      spec:
        template:
          metadata:
             labels:
                label1: value1
          spec:
            containers:
              - name: backstage-backend
                 resources:
                    requests:
                        cpu: 250m
                        memory: 256Mi
             - name: my-sidecar
                image: my-sidecar
            volumes:
              - ephemeral:
                  volumeClaimTemplate:
                    spec:
                      storageClassName: "my-special-class"
                name: dynamic-plugins-root

Also, since this addition causes changes in the API, new API version v1alpha2 was added. So, as for Operator versions 0.3.x and 0.4.x (if we consider 3 months release cadency and 6 months API maintain) it will support as minimum both v1alpha1 and v1alpha2 (which become a storage version). After upgrading Operator to 0.3.x the following behaviour expected:

• existed v1alpha1 CRs are working and shown as v1alpha2
• both v1alpha1 and v1alpha2 CRs can be added/updated, all shown as v1alpha2

NOTE: v1alpha2 is backward compatible with v1alpha1 w/o data conversion

Openshift NOTE: deployment.patch field won't show up in the "Form view" when creating a CR from the OCP Web. To be able to edit it with ODC use "YAML view".

Which issue(s) does this PR fix or relate to

#352

PR acceptance criteria

• Tests
• Documentation, become part of Configuration documentation #129
• If the bundle manifests have been updated, make sure to review the rhdh-operator.csv.yaml file accordingly

How to test changes / Special notes to the reviewer

• Create v1alpha2 Backstage resource as mentioned above
• Create resource on 0.2.0 version, then upgrade operator and try to update old and create new resource

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from gazarenkov. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[github-actions]

⚠️ Files changed in bundle generation!

Those changes to the operator bundle manifests should have been pushed automatically to your PR branch.
You might also need to manually update the .rhdh/bundle/manifests/rhdh-operator.csv.yaml CSV file accordingly.

[github-actions]

PR images are available:

1. https://quay.io/janus-idp/operator:0.3.0-pr-388-e307937
2. https://quay.io/janus-idp/operator-bundle:0.3.0-pr-388-e307937
3. https://quay.io/janus-idp/operator-catalog:0.3.0-pr-388-e307937

[rm3l]

It looks like this new field won't show up in the "Form view" when creating a CR from the OCP Web Console. I guess because of the field type.

Could you investigate how we could display it there? Maybe as a descriptor in the CSV?

Note that it correctly shows up in the "YAML view" with the help of completion..

[gazarenkov]

I think it is due to field type, it is unstructured per se.

I think we can create an issue for ODC about it, meantime it should be solved by downstream documentation.

[gazarenkov]

added documentation note to PR

[github-actions]

⚠️ Files changed in bundle generation!

Those changes to the operator bundle manifests should have been pushed automatically to your PR branch.
You might also need to manually update the .rhdh/bundle/manifests/rhdh-operator.csv.yaml CSV file accordingly.

[github-actions]

PR images are available:

1. https://quay.io/janus-idp/operator:0.3.0-pr-388-14c1b91
2. https://quay.io/janus-idp/operator-bundle:0.3.0-pr-388-14c1b91
3. https://quay.io/janus-idp/operator-catalog:0.3.0-pr-388-14c1b91

[github-actions]

PR images are available:

1. https://quay.io/janus-idp/operator:0.3.0-pr-388-a0b14b1
2. https://quay.io/janus-idp/operator-bundle:0.3.0-pr-388-a0b14b1
3. https://quay.io/janus-idp/operator-catalog:0.3.0-pr-388-a0b14b1

[github-actions]

PR images are available:

1. https://quay.io/janus-idp/operator:0.3.0-pr-388-2aa8525
2. https://quay.io/janus-idp/operator-bundle:0.3.0-pr-388-2aa8525
3. https://quay.io/janus-idp/operator-catalog:0.3.0-pr-388-2aa8525