Chapter 2. Installing 3scale on OpenShift

1. Create an Identity and Access Management (IAM) policy with the following minimum permissions:

   {
       "Version": "2012-10-17",
       "Statement": [
           {
               "Effect": "Allow",
               "Action": "s3:ListAllMyBuckets",
               "Resource": "arn:aws:s3:::*"
           },
           {
               "Effect": "Allow",
               "Action": "s3:*",
               "Resource": [
                   "arn:aws:s3:::targetBucketName",
                   "arn:aws:s3:::targetBucketName/*"
               ]
           }
       ]
   }

2. Create a CORS configuration with the following rules:

   <?xml version="1.0" encoding="UTF-8"?>
   <CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
   <CORSRule>
       <AllowedOrigin>https://*</AllowedOrigin>
       <AllowedMethod>GET</AllowedMethod>
   </CORSRule>
   </CORSConfiguration>

Procedure

1. Navigate to the Registry Service Accounts page and log in.

2. Click New Service Account. Fill in the form on the Create a New Registry Service Account page.

   1. Add a name for the service account.

      Note: You will see a fixed-length, randomly generated number string before the form field.

3. Enter a Description.
4. Click Create.
5. Navigate back to your Service Accounts.
6. Click the Service Account you created.

7. Make a note of the username, including the prefix string, for example 12345678|username, and your password.

   1. This username and password is used to log in to registry.redhat.io.

      Note

      There are tabs available on the Token Information page that show you how to use the authentication token. For example, the Token Information tab shows the username in the format 12345678|username and the password string below it.

Procedure

1. From a terminal session log in to OpenShift as the cluster administrator:

   oc login

2. Select your project, or create a new project:

   oc project <project_name>

   oc new-project <project_name>

3. Enter the oc new-app command:

   1. Specify the --file option with the path to the amp.yml file you downloaded as part of Configuring nodes and entitlements.

   2. Specify the --param option with the WILDCARD_DOMAIN parameter set to the domain of your OpenShift cluster:

      oc new-app --file /opt/amp/templates/amp.yml --param WILDCARD_DOMAIN=<WILDCARD_DOMAIN>

      The terminal shows the master and tenant URLs and credentials for your newly created 3scale Admin Portal. This output should include the following information:

      • master admin username
      • master password
      • master token information
      • tenant username
      • tenant password
      • tenant token information

4. Log in to https://user-admin.3scale-project.example.com as admin/xXxXyz123.

   * With parameters:
   
    * ADMIN_PASSWORD=xXxXyz123 # generated
    * ADMIN_USERNAME=admin
    * TENANT_NAME=user
   
    * MASTER_NAME=master
    * MASTER_USER=master
    * MASTER_PASSWORD=xXxXyz123 # generated
   
   --> Success
   Access your application via route 'user-admin.3scale-project.example.com'
   Access your application via route 'master-admin.3scale-project.example.com'
   Access your application via route 'backend-user.3scale-project.example.com'
   Access your application via route 'user.3scale-project.example.com'
   Access your application via route 'api-user-apicast-staging.3scale-project.example.com'
   Access your application via route 'api-user-apicast-production.3scale-project.example.com'

5. Make a note of these details for future reference.

6. The 3scale deployment on OpenShift has been successful when the following command returns:

   oc wait --for=condition=available --timeout=-1s $(oc get dc --output=name)

   Note

   When the 3scale deployment on OpenShift has been successful, your login credentials will work.

Procedure

1. Download amp-s3.yml.

2. Log in to OpenShift from a terminal session :

   oc login

3. Select your project, or create a new project:

   oc project <project_name>

   OR

1. Enter the oc new-app command:

   • Specify the --file option with the path to the amp-s3.yml file.

   • Specify the --param options with the following values:

     • WILDCARD_DOMAIN: the parameter set to the domain of your OpenShift cluster.
     • AWS_BUCKET: with your target bucket name.
     • AWS_ACCESS_KEY_ID: with your AWS credentials ID.
     • AWS_SECRET_ACCESS_KEY: with your AWS credentials KEY.
     • AWS_REGION: with the AWS: region of your bucket.
     • AWS_HOSTNAME: Default: Amazon endpoints - AWS S3 compatible provider endpoint hostname.
     • AWS_PROTOCOL: Default: HTTPS - AWS S3 compatible provider endpoint protocol.
     • AWS_PATH_STYLE: Default: false - When set to true, the bucket name is always left in the request URI and never moved to the host as a sub-domain.

   • Optionally, specify the --param option with the TENANT_NAME parameter to set a custom name for the Admin Portal. If omitted, this defaults to 3scale

     oc new-app --file /path/to/amp-s3.yml \
     	--param WILDCARD_DOMAIN=<a-domain-that-resolves-to-your-ocp-cluster.com> \
     	--param TENANT_NAME=3scale \
     	--param AWS_ACCESS_KEY_ID=<your-aws-access-key-id> \
     	--param AWS_SECRET_ACCESS_KEY=<your-aws-access-key-secret> \
     	--param AWS_BUCKET=<your-target-bucket-name> \
     	--param AWS_REGION=<your-aws-bucket-region> \
     	--param FILE_UPLOAD_STORAGE=s3

     The terminal shows the master and tenant URLs, as well as credentials for your newly created 3scale Admin Portal. This output should include the following information:

   • master admin username
   • master password
   • master token information
   • tenant username
   • tenant password
   • tenant token information

2. Log in to https://user-admin.3scale-project.example.com as admin/xXxXyz123.

   ...
   
   * With parameters:
    * ADMIN_PASSWORD=xXxXyz123 # generated
    * ADMIN_USERNAME=admin
    * TENANT_NAME=user
    ...
   
    * MASTER_NAME=master
    * MASTER_USER=master
    * MASTER_PASSWORD=xXxXyz123 # generated
    ...
   
   --> Success
   Access your application via route 'user-admin.3scale-project.example.com'
   Access your application via route 'master-admin.3scale-project.example.com'
   Access your application via route 'backend-user.3scale-project.example.com'
   Access your application via route 'user.3scale-project.example.com'
   Access your application via route 'api-user-apicast-staging.3scale-project.example.com'
   Access your application via route 'api-user-apicast-production.3scale-project.example.com'
   Access your application via route 'apicast-wildcard.3scale-project.example.com'
   
   ...

3. Make a note of these details for future reference.

4. The 3scale deployment on OpenShift has been successful when the following command returns:

   oc wait --for=condition=available --timeout=-1s $(oc get dc --output=name)

   Note

   When the 3scale deployment on OpenShift has been successful, your login credentials will work.

Procedure

1. Download amp-postgresql.yml.

2. Log in to OpenShift from a terminal session :

   oc login

3. Select your project, or create a new project:

   oc project <project_name>

   OR

1. Enter the oc new-app command:

   • Specify the --file option with the path to the amp-postgresql.yml file.
   • Specify the --param options with the following values:
   • WILDCARD_DOMAIN: the parameter set to the domain of your OpenShift cluster.

   • Optionally, specify the --param option with the TENANT_NAME parameter to set a custom name for the Admin Portal. If omitted, this defaults to 3scale

     oc new-app --file /path/to/amp-postgresql.yml \
     	--param WILDCARD_DOMAIN=<a-domain-that-resolves-to-your-ocp-cluster.com> \
     	--param TENANT_NAME=3scale \

     The terminal shows the master and tenant URLs, as well as the credentials for your newly created 3scale Admin Portal. This output should include the following information:

   • master admin username
   • master password
   • master token information
   • tenant username
   • tenant password
   • tenant token information

2. Log in to https://user-admin.3scale-project.example.com as admin/xXxXyz123.

   ...
   
   * With parameters:
    * ADMIN_PASSWORD=xXxXyz123 # generated
    * ADMIN_USERNAME=admin
    * TENANT_NAME=user
    ...
   
    * MASTER_NAME=master
    * MASTER_USER=master
    * MASTER_PASSWORD=xXxXyz123 # generated
    ...
   
   --> Success
   Access your application via route 'user-admin.3scale-project.example.com'
   Access your application via route 'master-admin.3scale-project.example.com'
   Access your application via route 'backend-user.3scale-project.example.com'
   Access your application via route 'user.3scale-project.example.com'
   Access your application via route 'api-user-apicast-staging.3scale-project.example.com'
   Access your application via route 'api-user-apicast-production.3scale-project.example.com'
   Access your application via route 'apicast-wildcard.3scale-project.example.com'
   
   ...

3. Make a note of these details for future reference.

4. The 3scale deployment on OpenShift has been successful when the following command returns:

   oc wait --for=condition=available --timeout=-1s $(oc get dc --output=name)

   Note

   When the 3scale deployment on OpenShift has been successful, your login and credentials will work.

Procedure

1. If you are not already logged in, log in to OpenShift:

   oc login

   1. Using the oc patch command, specify the secret type where system-smtp is the name of the secret, followed by the -p option, and write the new values in JSON for the following variables:

      Variable	Description
      address	Allows you to specify a remote mail server as a relay
      username	Specify your mail server username
      password	Specify your mail server password
      domain	Specify a HELO domain
      port	Specify the port on which the mail server is listening for new connections
      authentication	Specify the authentication type of your mail server. Allowed values: plain (sends the password in the clear), login (send password Base64 encoded), or cram_md5 (exchange information and a cryptographic Message Digest 5 algorithm to hash important information)
      openssl.verify.mode	Specify how OpenSSL checks certificates when using TLS. Allowed values: none or peer.

      Example

      oc patch secret system-smtp -p '{"stringData":{"address":"<your_address>"}}'
      oc patch secret system-smtp -p '{"stringData":{"username":"<your_username>"}}'
      oc patch secret system-smtp -p '{"stringData":{"password":"<your_password>"}}'

2. After you have set the secret variables, redeploy the system-app and system-sidekiq pods:

   oc rollout latest dc/system-app
   oc rollout latest dc/system-sidekiq

3. Check the status of the rollout to ensure it has finished:

   oc rollout status dc/system-app
   oc rollout status dc/system-sidekiq

Procedure

1. Click Operators > Installed Operators.

   1. From the list of Installed Operators, click 3scale Operator.
2. Click the API Manager tab.
3. Click Create APIManager.

4. Clear the sample content and add the following YAML definitions to the editor, then click Create.

   • Before 3scale 2.8, you could configure the automatic addition of replicas by setting the highAvailability field to true. From 3scale 2.8, the addition of replicas is controlled through the replicas field in the APIManager CR as shown in the following example.

     Note

     The wildcardDomain parameter can be any desired name you wish to give that resolves to an IP address, which is a valid DNS domain.

   • APIManager CR with minimum requirements:

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

   • APIManager CR with replicas configured:

     apiVersion: apps.3scale.net/v1alpha1
     kind: APIManager
     metadata:
       name: apimanager-sample
     spec:
       system:
         appSpec:
           replicas: 1
         sidekiqSpec:
           replicas: 1
       zync:
         appSpec:
           replicas: 1
         queSpec:
           replicas: 1
       backend:
         cronSpec:
           replicas: 1
         listenerSpec:
           replicas: 1
         workerSpec:
           replicas: 1
       apicast:
         productionSpec:
           replicas: 1
         stagingSpec:
           replicas: 1
       wildcardDomain: example.com

1. Run the following commands to get the Admin Portal credentials:

   oc get secret system-seed -o json | jq -r .data.ADMIN_USER | base64 -d
   oc get secret system-seed -o json | jq -r .data.ADMIN_PASSWORD | base64 -d

   1. Log in as the Admin Portal administrator to verify these credentials are working.

2. Run the following commands to get the Master Admin Portal credentials:

   oc get secret system-seed -o json | jq -r .data.MASTER_USER | base64 -d
   oc get secret system-seed -o json | jq -r .data.MASTER_PASSWORD | base64 -d

   1. Log in as the Master Admin Portal administrator to verify these credentials are working.

Procedure

1. Click Operators > Installed Operators.
2. Click 3scale API Management from the list of Installed Operators.
3. Click the Subscription tab. Under the Subscription Details heading you will see the subheading Approval.
4. Click the link below Approval. The link is set to Automatic by default. A modal with the heading, Change Update Approval Strategy will pop up.
5. Choose the option of your preference: Automatic (default) or Manual, and then click Save.

Procedure

1. Write Lua code that defines the custom environment that you want to inject. For example, the following env1.lua file shows a custom logging policy that the 3scale operator loads for all services.

   local cjson = require('cjson')
   local PolicyChain = require('apicast.policy_chain')
   local policy_chain = context.policy_chain
   
   local logging_policy_config = cjson.decode([[
   {
     "enable_access_logs": false,
     "custom_logging": "\"{{request}}\" to service {{service.id}} and {{service.name}}"
   }
   ]])
   
   policy_chain:insert( PolicyChain.load_policy('logging', 'builtin', logging_policy_config), 1)
   
   return {
     policy_chain = policy_chain,
     port = { metrics = 9421 },
   }

2. Create a secret from the Lua file that defines the custom environment. For example:

   oc create secret generic custom-env-1 --from-file=./env1.lua

   A secret can contain multiple custom environments. Specify the `–from-file option for each file that defines a custom environment. The operator loads each custom environment.

3. Define an APIManager custom resource that references the secret you just created. The following example shows only content relative to referencing the secret that defines the custom environment.

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIManager
   metadata:
     name: apimanager-apicast-custom-environment
   spec:
     wildcardDomain: <desired-domain>
     apicast:
       productionSpec:
         customEnvironments:
           - secretRef:
               name: custom-env-1
       stagingSpec:
         customEnvironments:
           - secretRef:
               name: custom-env-1

   An APIManager custom resource can reference multiple secrets that define custom environments. The operator loads each custom environment.

4. Create the APIManager custom resource that adds the custom environment. For example:

   oc apply -f apimanager.yaml

Procedure

1. Create a secret from the files that define one custom policy. For example:

   oc create secret generic my-first-custom-policy-secret \
    --from-file=./apicast-policy.json \
    --from-file=./init.lua \
    --from-file=./my-first-custom-policy.lua

   If you have more than one custom policy, create a secret for each custom policy. A secret can contain only one custom policy.

2. Define an APIManager custom resource that references each secret that contains a custom policy. You can specify the same secret for APIcast staging and APIcast production. The following example shows only content relative to referencing secrets that contain custom policies.

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIManager
   metadata:
     name: apimanager-apicast-custom-policy
   spec:
     apicast:
       stagingSpec:
         customPolicies:
           - name: my-first-custom-policy
             version: "0.1"
             secretRef:
               name: my-first-custom-policy-secret
           - name: my-second-custom-policy
             version: "0.1"
             secretRef:
               name: my-second-custom-policy-secret
       productionSpec:
         customPolicies:
           - name: my-first-custom-policy
             version: "0.1"
             secretRef:
               name: my-first-custom-policy-secret
           - name: my-second-custom-policy
             version: "0.1"
             secretRef:
               name: my-second-custom-policy-secret

   An APIManager custom resource can reference multiple secrets that define different custom policies. The operator loads each custom policy.

3. Create the APIManager custom resource that references the secrets that contain the custom policies. For example:

   oc apply -f apimanager.yaml

Procedure

1. Define a secret that contains your OpenTracing configuration details in stringData.config. This is the only valid value for the attribute that contains your OpenTracing configuration details. Any other specification prevents APIcast from receiving your OpenTracing configuration details. The folowing example shows a valid secret definition:

   apiVersion: v1
   kind: Secret
   metadata:
     name: myjaeger
   stringData:
     config: |-
         {
         "service_name": "apicast",
         "disabled": false,
         "sampler": {
           "type": "const",
           "param": 1
         },
         "reporter": {
           "queueSize": 100,
           "bufferFlushInterval": 10,
           "logSpans": false,
           "localAgentHostPort": "jaeger-all-in-one-inmemory-agent:6831"
         },
         "headers": {
           "jaegerDebugHeader": "debug-id",
           "jaegerBaggageHeader": "baggage",
           "TraceContextHeaderName": "uber-trace-id",
           "traceBaggageHeaderPrefix": "testctx-"
         },
         "baggage_restrictions": {
             "denyBaggageOnInitializationFailure": false,
             "hostPort": "127.0.0.1:5778",
             "refreshInterval": 60
         }
         }
   type: Opaque

2. Create the secret. For example, if you saved the previous secret definition in the myjaeger.yaml file, you would run the following command:

   oc create secret generic myjaeger --from-file myjaeger.yaml

3. Define an APIManager custom resource that specifies OpenTracing attributes. In the CR definition, set the openTracing.tracingConfigSecretRef.name attribute to the name of the secret that contains your OpenTracing configuration details. The following example shows only content relative to configuring OpenTracing.

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIManager
   metadata:
     name: apimanager1
   spec:
     apicast:
       stagingSpec:
         ...
         openTracing:
           enabled: true
           tracingLibrary: jaeger
           tracingConfigSecretRef:
             name: myjaeger
       productionSpec:
         ...
           openTracing:
             enabled: true
             tracingLibrary: jaeger
             tracingConfigSecretRef:
               name: myjaeger

4. Create the APIManager custom resource that configures OpenTracing. For example, if you saved the APIManager custom resource in the apimanager1.yaml file, you would run the following command:

   oc apply -f apimanager1.yaml

Procedure

1. Create a secret from your valid certificate, for example:

   oc create secret tls mycertsecret --cert=server.crt --key=server.key

   The configuration exposes secret references in the APIManager CRD. You create the secret and then reference the name of the secret in the APIManager custom resource as follows:

   • Production: The APIManager CR exposes the certificate in the .spec.apicast.productionSpec.httpsCertificateSecretRef field.

   • Staging: The APIManager CR exposes the certificate in the .spec.apicast.stagingSpec.httpsCertificateSecretRef field.

     Optionally, you can configure the following:

   • httpsPort indicates which port APIcast should start listening on for HTTPS connections. If this clashes with the HTTP port APIcast uses this port for HTTPS only.

   • httpsVerifyDepth defines the maximum length of the client certificate chain.

     Note

     Provide a valid certificate and reference from the APImanager CR. If the configuration can access httpsPort but not httpsCertificateSecretRef, APIcast uses an embedded self-signed certificate. This is not recommended.

2. Click Operators > Installed Operators.
3. From the list of Installed Operators, click 3scale Operator.
4. Click the API Manager tab.
5. Click Create APIManager.

6. Add the following YAML definitions to the editor.

   1. If enabling for production, configure the following YAML defintions:

      spec:
        apicast:
          productionSpec:
            httpsPort: 8443
            httpsVerifyDepth: 1
            httpsCertificateSecretRef:
              name: mycertsecret

   2. If enabling for staging, configure the following YAML defintions:

      spec:
        apicast:
          stagingSpec:
            httpsPort: 8443
            httpsVerifyDepth: 1
            httpsCertificateSecretRef:
              name: mycertsecret

7. Click Create.

Procedure

1. Find the PVC containing the erroneous MySQL data with the oc get pvc command:

   # oc get pvc
   NAME                    STATUS    VOLUME    CAPACITY   ACCESSMODES   AGE
   backend-redis-storage   Bound     vol003    100Gi      RWO,RWX       4d
   mysql-storage           Bound     vol006    100Gi      RWO,RWX       4d
   system-redis-storage    Bound     vol008    100Gi      RWO,RWX       4d
   system-storage          Bound     vol004    100Gi      RWO,RWX       4d

2. Stop the deployment of the system-mysql pod by clicking cancel deployment in the OpenShift UI.
3. Delete everything under the MySQL path to clean the volume.
4. Start a new system-mysql deployment.

Procedure

1. Type the following command to verify the configuration of your container registry authentication:

   $ oc get secret

   • If your secret exists, you will see the following output in the terminal:

     threescale-registry-auth          kubernetes.io/dockerconfigjson        1         4m9s

   • However, if you do not see the output, you must do the following:
2. Use the credentials you previously set up while Creating a registry service account to create your secret.
3. Use the steps in Configuring registry authentication in OpenShift, replacing <your-registry-service-account-username> and <your-registry-service-account-password> in the oc create secret command provided.

4. Generate the threescale-registry-auth secret in the same namespace as the APIManager resource. You must run the following inside the <project-name>:

   oc project <project-name>
   oc create secret docker-registry threescale-registry-auth \
     --docker-server=registry.redhat.io \
     --docker-username="<your-registry-service-account-username>" \
     --docker-password="<your-registry-service-account-password>"
     --docker-email="<email-address>"

5. Delete and recreate the APIManager resource:

   $ oc delete -f apimanager.yaml
   apimanager.apps.3scale.net "example-apimanager" deleted
   
   $ oc create -f apimanager.yaml
   apimanager.apps.3scale.net/example-apimanager created

Verification

1. Type the following command to confirm that deployments have a status of Starting or Ready. The pods then begin to spawn:

   $ oc describe apimanager
   (...)
   Status:
     Deployments:
       Ready:
         apicast-staging
         system-memcache
         system-mysql
         system-redis
         zync
         zync-database
         zync-que
       Starting:
         apicast-production
         backend-cron
         backend-worker
         system-sidekiq
         system-sphinx
       Stopped:
         backend-listener
         backend-redis
         system-app

2. Type the following command to see the status of each pod:

   $ oc get pods
   NAME                               READY   STATUS             RESTARTS   AGE
   3scale-operator-66cc6d857b-sxhgm   1/1     Running            0          17h
   apicast-production-1-deploy        1/1     Running            0          17m
   apicast-production-1-pxkqm         0/1     Pending            0          17m
   apicast-staging-1-dbwcw            1/1     Running            0          17m
   apicast-staging-1-deploy           0/1     Completed          0          17m
   backend-cron-1-deploy              1/1     Running            0          17m

Procedure

1. The directories used for the persistent volumes MUST have the write permissions for the root group. Having read-write permissions for the root user is not enough as the MySQL service runs as a different user in the root group. Execute the following command as the root user:

   chmod -R g+w /path/for/pvs

2. Execute the following command to prevent SElinux from blocking access:

   chcon -Rt svirt_sandbox_file_t /path/for/pvs