Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
78 lines (54 loc) · 4.24 KB

DEVELOPMENT.md

File metadata and controls

78 lines (54 loc) · 4.24 KB

Development

This document describes recommended practices for developing and testing against this pattern.

Testing Environments

While you may bring your own (BYO) OpenShift cluster, Red Hat associates and partners may utilize Red Hat Demo Platform (RHDP) to provision OpenShift environments for use as targets for pattern development and testing.

Provisioning

The following Catalog Item (CI) has been verified and is recommended when provisioning OpenShift clusters as it meets the prerequisites set form within the pattern:

The following options should be selected:

  • Activity: Practice / Enablement
  • Purpose: Trying out a technical solution
  • Salesforce ID: Can be omitted (See note below)
  • OpenShift Version: 4.20+
  • Features
    • Enable Cert Manager
    • Enable Cert Manager API
  • Control Plane Count: 3

NOTE: The Salesforce ID requirement is not needed by those that that are members of the RHDP development team.

Once a cluster has been provisioned, there are additional steps which need to be performed in order to avoid overlapping capabilities that are implemented within this pattern:

Cert-Manager Removal

While cert-manager is a key feature offered within this pattern, RHDP deploys an instance to support the generation of API and Ingress certificates. Utilize the following steps to remove the conflicting resources.

  1. Login to the Web Console of the provisioned OpenShift cluster with the provided authentication details.
  2. Under Operators on the left hand navigation ad select Installed Operators
  3. Locate cert-manager Operator for Red Hat OpenShift and click the kabob (3 vertical dots) from the right hand column and select Uninstall Operator
  4. The OperatorGroup associated with Cert Manager must also be uninstalled. Under Home on the left hand navigation, select API Explorer
  5. From the project dropdown at the top of the screen, select cert-manager-operator as the Project
  6. In the search textbox, enter OperatorGroup and select the link underneath the Name column associated with API Version v1 in the Version column.
  7. Click on the Instances tab
  8. Locate any instances and click the kabob (3 vertical dots) from the right hand column and select Delete OperatorGroup

Inactivity Timeout

RHDP enables an inactivity timeout on tokens generated from the OpenShift OAuth server which logs a user out of the Web Console and CLI. To avoid such timeouts, the setting can be disabled by executing the following command:

oc patch oauth cluster  --type json   -p='[{"op": "remove", "path": "/spec/tokenConfig/accessTokenInactivityTimeout"}]'

The updated setting will become enabled upon next login.

Reducing the storage required

By default, NooBaa requires 100 Gi of disk space: 50 Gi for the database and 50 Gi for the default BackingStore. While this might make sense for production, in our development environment we will only be using a few images for testing, so it may be excessive.

If we want to save some space, we can add these overrides to the noobaa-mcg component in the values-hub.yaml file:

    noobaa-mcg:
      name: noobaa-mcg
      namespace: openshift-storage
      project: hub
      path: charts/noobaa-mcg
      annotations:
        argocd.argoproj.io/sync-wave: "5"
      overrides:
        - name: noobaa.dbSize
          value: 10Gi
        - name: noobaa.pvPool.resources.requests.storage
          value: 25Gi

Analytics Tracking

Metrics are captured to track the use of any of the Validated Patterns. It is important than an accurate depiction of pattern use by customers, partners and those from the community are captured. Red Hat associates should not factor into this calculation and support is available in the Validated Patterns framework to opt out of being captured.

To implement the opt-out capability, create a file in the location ~/.config/validated-patterns/pattern-uuid. The file does not need to have to be populated with any specific content. Its mere presence is all that is necessary for usage of the pattern to not be tracked.