3scale-toolbox Packaging project

This project uses Chef's Omnibus toolchain to create full-stack platform-specific 3scale-toolbox packages.

Support for running 3scale-toolbox on the following platforms will be provided on a best-effort basis.

RELEASES

Download packages from latest release section.

PLATFORMS

• RHEL/Fedora
• Ubuntu/Debian
• Mac OS X
• Windows
• Docker
• Kubernetes

RHEL Fedora

1. Install the RPM package using the rpm installer utility.

rpm -Uvh `URL_RPM_PACKAGE`

Files will be installed in /opt/3scale-toolbox

2. Test executing help command.

3scale help

Ubuntu Debian

1. Download DEB package.

wget `URL_DEB_PACKAGE`

2. Install the package using the dpkg installer utility.

dpkg -i 3scale-toolbox_VERSION.deb

Files will be installed in /opt/3scale-toolbox

3. Test executing help command.

3scale help

Mac OS X

1. Install RVM

curl -sSL https://get.rvm.io | bash -s stable

2. Install Ruby 2.7.1

rvm install 2.7.1

2. Use Ruby 2.7.1

rvm use 2.7.1

3. Install 3scale_toolbox gem

gem install 3scale_toolbox

4. Test executing help command

3scale help

Windows

Requires 64 bit Windows 10.

1. Download and install MSI package.

2. By default, the toolbox will be installed in C:\3scale-toolbox.

3. [Optional] Add C:\3scale-toolbox\embedded\bin to the PATH env var.

4. From you command shell, test executing the help command.

C:\> .\3scale-toolbox\embedded\bin\3scale help

Docker

Docker repository

quay.io/redhat/3scale-toolbox

1. Test executing help command

docker run --rm quay.io/redhat/3scale-toolbox 3scale help

Kubernetes

Also working with Openshift.

1. Provision the 3scale-toolbox secret with your 3scale credentials

3scale remote add 3scale-instance "https://123...456@MY-TENANT-admin.3scale.net/"
kubectl create secret generic 3scale-toolbox --from-file="$HOME/.3scalerc.yaml"

2. Deploy Job template to run your 3scale command. In the example shown below, 3scale remote list command will be run.

Write the following yaml template content in a file called toolbox-job.yaml.

apiVersion: batch/v1
kind: Job
metadata:
  name: toolbox
spec:
  backoffLimit: 4
  activeDeadlineSeconds: 300
  template:
    spec:
      restartPolicy: Never
      containers:
        - name: toolbox-job
          image: quay.io/redhat/3scale-toolbox
          env:
            - name: HOME
              value: /var/lib/toolbox
          args:
            - 3scale
            - remote
            - list
          volumeMounts:
            - name: toolbox-config
              mountPath: /var/lib/toolbox
      volumes:
        - name: toolbox-config
          secret:
            secretName: 3scale-toolbox

Deploy the job

kubectl create -f toolbox-job.yaml

Check on the status of the Job

$ kubectl describe jobs/toolbox

Name:                     toolbox
Namespace:                test
Selector:                 controller-uid=057ec3ff-fa45-11e9-b43e-065562ed0850
Labels:                   controller-uid=057ec3ff-fa45-11e9-b43e-065562ed0850
                          job-name=toolbox
Annotations:              <none>
Parallelism:              1
Completions:              1
Start Time:               Tue, 29 Oct 2019 13:09:56 +0100
Completed At:             Tue, 29 Oct 2019 13:10:13 +0100
Duration:                 17s
Active Deadline Seconds:  300s
Pods Statuses:            0 Running / 1 Succeeded / 0 Failed
Pod Template:
  Labels:  controller-uid=057ec3ff-fa45-11e9-b43e-065562ed0850
           job-name=toolbox
  Containers:
   toolbox-job:
    Image:      quay.io/redhat/3scale-toolbox
    Port:       <none>
    Host Port:  <none>
    Args:
      3scale
      remote
      list
    Environment:
      HOME:  /var/lib/toolbox
    Mounts:
      /var/lib/toolbox from toolbox-config (rw)
  Volumes:
   toolbox-config:
    Type:        Secret (a volume populated by a Secret)
    SecretName:  3scale-toolbox
    Optional:    false
Events:
  Type    Reason            Age   From            Message
  ----    ------            ----  ----            -------
  Normal  SuccessfulCreate  24s   job-controller  Created pod: toolbox-94xsg

Troubleshooting

• There are known issues running 3scale toolbox when RVM is installed and active. You can take the following actions to resolve them:
  • Disable RVM for the current session, then run the toolbox

    rvm use system
    3scale help

  • Disable RVM just for running one command

    env -u GEM_PATH 3scale help