Menu Close
Settings Close

Language and Page Formatting Options

Chapter 5. Capabilities: Provisioning 3scale services and configurations via the operator

This document contains information about 3scale operator for Capabilities, which involves provisioning 3scale services and configurations via the 3scale operator through the OpenShift Container Platform user interface.

Important

3scale operator for Capabilities is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

5.1. Prerequisites

  • A 3scale 2.6 On-Premises instance
  • You must have the 3scale operator installed.
  • OpenShift Container Platform 4.1

    • A user account with administrator privileges in the OpenShift cluster
Warning

When using the 3scale operator to update API configurations in 3scale, the custom resource definitions (CRDs) are the source of truth. If changes are made in the Admin user interface, they will not persist and eventually be overridden by the definition in the CRD.

5.3. Deploying optional tenants custom resource

Optionally, you may create other tenants deploying Tenant custom resource objects.

Procedure

  1. Click Catalog > Installed Operators.

    1. From the list of Installed Operators, click 3scale Operator.
  2. Click the Tenant tab.
  3. Click Create Tenant.
  4. Clear the sample content and add the following YAML definitions to the editor, then click Create.

    apiVersion: capabilities.3scale.net/v1alpha1
    kind: Tenant
    metadata:
      name: ecorp-tenant
    spec:
      username: admin
      systemMasterUrl: https://master.<wildcardDomain>
      email: admin@ecorp.com
      organizationName: ECorp
      masterCredentialsRef:
        name: system-seed
      passwordCredentialsRef:
        name: ecorp-admin-secret
      tenantSecretRef:
        name: ecorp-tenant-secret
        namespace: operator-test

    Tenant provider_key and admin domain URL will be stored in a secret. You can specify the secret location by using tenantSecretRef tenant spec key.

    Note

    For more information about the Tenant Custom Resource fields and possible values, refer to the Tenant CRD Reference documentation.

5.4. Deleting created custom resources

The following procedure details how to delete the custom resources.

Procedure

  1. Click Catalog > Installed Operators.

    1. From the list of Installed Operators, click 3scale Operator.
  2. Click the tab for the resource you wish to delete.

    1. You will see the resource listed if one has previously been created.
  3. Click the name to see the overview.
  4. Click Action > Delete.
  5. Confirm the deletion by clicking Delete or Cancel to return to the previous screen.

Alternatively, to delete the 3scale operator, its associated roles and service accounts, do the following.

Procedure

  1. Click Catalog > Installed Operators.

    1. From the list of Installed Operators, click 3scale Operator.
  2. Click Action > Delete Cluster Service Version.
  3. Confirm the deletion by clicking Delete or Cancel to return to the previous screen.