Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 1.79 KB

quickstart-guide.md

File metadata and controls

36 lines (28 loc) · 1.79 KB
Raw

Install the 3scale operator through Operator Lifecycle Manager (OLM).

You will need access to an OpenShift Container Platform 4.1 cluster.

Procedure

  1. In the OpenShift Container Platform console, log in using an account with administrator privileges.
  2. Create new project operator-test in Projects > Create Project.
  3. Click Catalog > OperatorHub.
  4. In the Filter by keyword box, type 3scale operator to find the 3scale operator.
  5. Click the 3scale operator. Information about the Operator is displayed.
  6. Click Install. The Create Operator Subscription page opens.
  7. On the Create Operator Subscription page, accept all of the default selections and click Subscribe.
  8. After the subscription upgrade status is shown as Up to date, click Catalog > Installed Operators to verify that the 3scale operator ClusterServiceVersion (CSV) is displayed and its Status ultimately resolves to InstallSucceeded in the operator-test project.

Deploying 3scale using the operator

Deploying the APIManager custom resource will make the operator begin processing and will deploy a 3scale solution from it.

Procedure

  1. Click Catalog > Installed Operators. From the list of Installed Operators, click 3scale Operator.
  2. Click API Manager > Create APIManager
  3. Create APIManager object with the following content.
apiVersion: apps.3scale.net/v1alpha1
kind: APIManager
metadata:
  name: example-apimanager
spec:
  wildcardDomain: <wildcardDomain>

The wildcardDomain parameter can be any desired name you wish to give that resolves to an IP address, which is a valid DNS domain. Be sure to remove the placeholder marks for your parameters: < >.

Start using 3scale

When you deploy 3scale using the operator, a default tenant is created, with a fixed URL: https://3scale-admin.${wildcardDomain}