Threescale 7135 - Product Promotion

[Patryk-Stefanski]

Threescale-7135

What

Addition of proxyconfigpromote CRD that allows for single-use product promotion to stage or production.

Verification

1. Deploy 3scale-operator locally

2.Create dummy smtp secret

kubectl apply -f - <<EOF
---
kind: Secret
apiVersion: v1
metadata: 
  name: s3-credentials
  namespace: 3scale-test
data: 
  AWS_ACCESS_KEY_ID: UkVQTEFDRV9NRQ==
  AWS_BUCKET: UkVQTEFDRV9NRQ==
  AWS_REGION: UkVQTEFDRV9NRQ==
  AWS_SECRET_ACCESS_KEY: UkVQTEFDRV9NRQ==
type: Opaque
EOF

3.Create apimanager resource

kubectl apply -f - <<EOF
---
apiVersion: apps.3scale.net/v1alpha1
kind: APIManager
metadata: 
  name: apimanager-sample
  namespace: 3scale-test
spec: 
  system: 
    fileStorage: 
      simpleStorageService: 
        configurationSecretRef: 
          name: s3-credentials
  wildcardDomain: <cluster_domain>
EOF

cluster domain example : apps.pstefans.uq32.s1.devshift.org

4. Create Backend resource

kubectl apply -f - <<EOF
---
apiVersion: capabilities.3scale.net/v1beta1
kind: Backend
metadata:
  name: backend1-cr
  namespace: 3scale-test
spec:
  mappingRules:
    - httpMethod: GET
      increment: 1
      last: true
      metricMethodRef: hits
      pattern: /
  name: backend1
  privateBaseURL: 'https://api.example.com'
  systemName: backend1
EOF

5. Create product resources with the backend referenced

kubectl apply -f - <<EOF
---
apiVersion: capabilities.3scale.net/v1beta1
kind: Product
metadata:
  name: product1-cr
  namespace: 3scale-test
spec:
  name: product1
  backendUsages:
    backend1:
      path: /
EOF

6. Create proxyconfigpromote resources to promote product to staging.

kubectl apply -f - <<EOF
---
apiVersion: capabilities.3scale.net/v1beta1
kind: ProxyConfigPromote
metadata:
  name: product1-v1-staging
  namespace: 3scale-test
spec:
  productCRName: product1-cr
EOF

7. In 3scale UI check that product1 configuration was promoted to staging

8. Create proxyconfigpromote resource to promote a product to production and remove resource after successful promotion

kubectl apply -f - <<EOF
---
apiVersion: capabilities.3scale.net/v1beta1
kind: ProxyConfigPromote
metadata:
  name: product1-v1-production
  namespace: 3scale-test
spec:
  productCRName: product1-cr
  production: true
  deleteCR: true
EOF

10. In 3scale UI check that product1 configuration has been promoted to production and that the resource has been deleted in openshift UI

[openshift-ci]

Hi @Patryk-Stefanski. Thanks for your PR.

I'm waiting for a 3scale member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[Patryk-Stefanski]

@eguzki @MStokluska @KevFan
If anyone would have a chance to review it would be great.

[eguzki]

One tip after reading the verification steps and before going to the code. You do not need to create a secret with the admin access token to use it as accountref. When you deploy 3scale, a default tenant is created ready to be used. And admin access token is already available in 3scale namespace's secret. The operator will read that for you if your CR is deployed in the same namespace as 3scale. So, your backend, product and ProxyConfigPromote resources do not need providerAccountRef to be specified because they are deployed in the same namespace as 3scale. The code implementing that is here and documented here

[eguzki]

Thanks for the contribution! 🥳
I haven't gone through the details of the implementation. But let's discuss the current comments and I will review more later

[eguzki]

this is a required field. Remove omitempty json tag

[austincunningham]

👍

[eguzki]

I do not think it is necessary. The provider account ref will be read from the product CR. Adding provider account ref opens the door to have product from tenant A and proxyconfigpromote from tenant B having reference to the previous product.

[austincunningham]

Yes good idea, we can make this change.

[eguzki]

if it's optional, better to be a pointer to bool. That way you can differentiate between when the user did not set and when the user set that to false. Maybe not relevant for this use case, but still to be consistent with the other optional attributes in the operator CRDs.

[austincunningham]

👍

[eguzki]

nice!

As commented above, better to be a pointer to bool.

you can define a handy ProxyConfigPromote struct method to abstract the pointer type

func (p *ProxyConfigPromote) IsDeleteCR() bool {
    if p.Spec.DeleteCR == nil {
        return false
    }

   return *p.Spec.DeleteCR
}

[austincunningham]

👍

[austincunningham]

@MStokluska & @KevFan if you have time for a review

[austincunningham]

@eguzki thinking the unit-test failing on circle-ci is some issue on the circle-ci side as rerunning the test will fail for a different reason each time its run with no code changes. The same unit test pass on the ci/prow/test-unit, my guess is its the memory footprint, will try some memory logging to see if this is the case.

[eguzki]

The weird thing is that in master branch, tests pass.

[qlty-cloud-legacy]

Code Climate has analyzed commit d92f15d and detected 18 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	9
Duplication	1
Style	8

View more on Code Climate.

[austincunningham]

@eguzki yep looks like memory footprint
added https://github.com/3scale/3scale-operator/pull/742/files#diff-78a8a19706dbd2a4425dd72bdab0502ed7a2cef16365ab7030a5a0588927bf47R425

resource_class: large

to the unit tests and now passing on circleci
Looks like the tests are using about 7.5 GiB
with out the resource_class set the container gets a medium size which is about 4GiB
I left the memory log in the circleci yaml , output is as follows