External components optional

[eguzki]

what

• Make spec.externalComponents fully optional. If struct fields do not exists, the apimanager controller will default to false.
  Currently the apimanager controller fills the *ExternalComponents` struct when not found:

apiVersion: apps.3scale.net/v1alpha1
kind: APIManager
metadata:
  name: apimanager1
spec:
  wildcardDomain: example.com

Is updated to

apiVersion: apps.3scale.net/v1alpha1
kind: APIManager
metadata:
  name: apimanager1
spec:
  wildcardDomain: example.com
  externalComponents:
    backend:
      redis: false
    system:
      database: false
      redis: false
    zync:
      database: false 

After the changes on the PR, the externalComponents struct will be nil and default behavior will be applied.

• Fix: When external component struct has changed, requeue.
• Documentation about the external databases new feature.

Verification steps

Deploy APIManager CR:

apiVersion: apps.3scale.net/v1alpha1
kind: APIManager
metadata:
  name: apimanager1
spec:
  wildcardDomain: example.com

After the controller updated the CR, spec.externalComponents should not be in the CR

[codeclimate]

Code Climate has analyzed commit 9674b76 and detected 5 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Duplication	4
Style	1

View more on Code Climate.

[sergioifg94]

Code changes look good, and verified that the externalComponents field is not set by default, creating all the components in-cluster:

apiVersion: apps.3scale.net/v1alpha1
kind: APIManager
metadata:
  annotations:
    apps.3scale.net/apimanager-threescale-version: master
    apps.3scale.net/threescale-operator-version: 0.9.0
  creationTimestamp: '2022-04-20T16:33:58Z'
  generation: 2
  managedFields:
    - apiVersion: apps.3scale.net/v1alpha1
      fieldsType: FieldsV1     
      manager: main
      operation: Update
      time: '2022-04-20T16:33:58Z'
    - apiVersion: apps.3scale.net/v1alpha1
      fieldsType: FieldsV1     
      manager: main
      operation: Update
      subresource: status
      time: '2022-04-20T16:34:47Z'
  name: apimanager1
  namespace: default
  resourceVersion: '106165'
  uid: f80b71e8-1cdc-4cf2-b70d-904ae4542083
spec:
  imageStreamTagImportInsecure: false
  resourceRequirementsEnabled: true
  system:
    appSpec:
      replicas: 1
    sidekiqSpec:
      replicas: 1
    sphinxSpec: {}
  appLabel: 3scale-api-management
  zync:
    appSpec:
      replicas: 1
    queSpec:
      replicas: 1
  backend:
    cronSpec:
      replicas: 1
    listenerSpec:
      replicas: 1
    workerSpec:
      replicas: 1
  tenantName: 3scale
  apicast:
    managementAPI: status
    openSSLVerify: false
    productionSpec:
      replicas: 1
    registryURL: 'http://apicast-staging:8090/policies'
    responseCodes: true
    stagingSpec:
      replicas: 1
  wildcardDomain: example.com
status:
  conditions:
    - lastTransitionTime: '2022-04-20T16:34:07Z'
      status: 'False'
      type: Available
  deployments:
    ready:
      - apicast-staging
      - backend-listener
      - system-memcache
      - zync
      - zync-database
      - zync-que
    starting:
      - apicast-production
      - backend-cron
      - backend-redis
      - backend-worker
      - system-mysql
      - system-redis
      - system-sidekiq
      - system-sphinx
    stopped:
      - system-app

lgtm