/tackle2-operator

Tackle Operator fully manages the deployment and life cycle of Tackle on OpenShift and Kubernetes.

Primary LanguageJinjaApache License 2.0Apache-2.0

Tackle Operator

The Tackle Operator fully manages the deployment and life cycle of Tackle on OpenShift and Kubernetes.

Prerequisites

Please ensure the following requirements are met prior installation.

Tackle Operator Installation

Installing latest on OpenShift

Installing latest requires creating a new catalog source.

  1. oc create -f tackle-operator-catalog.yaml
  2. Visit the OpenShift Web Console.
  3. Navigate to Operators => OperatorHub.
  4. Search for Tackle.
  5. There should be two Tackle available for installation now.
  6. Select the Tackle without the community tag.
  7. Proceed to install latest.

Installing latest on Kubernetes (or Minikube)

See k8s.md for details.

Tackle CR Creation on OpenShift

  1. Visit OpenShift Web Console, navigate to Operators => Installed Operators.
  2. Select Tackle.
  3. Locate Tackle on the top menu and click on it.
  4. Adjust settings if desired and click Create instance.

Note: Please review storage requirements prior creating the Tackle CR in case you need to adjust settings.

Tackle CR Settings

If operator defaults need to be altered, the Tackle CR spec can be customized to meet desired needs, see the table below for some of the most significant settings:

Name Default Description
hub_database_volume_size 5Gi Size requested for Hub database volume
hub_bucket_volume_size 100gi Size requested for Hub bucket volume
keycloak_database_data_volume_size 1Gi Size requested for Keycloak DB volume
pathfinder_database_data_volume_size 1Gi Size requested for Pathfinder DB volume
windup_data_volume_size 100Gi Size requested for Windup maven m2 repository volume
rwx_storage_class N/A Storage class requested for Tackle RWX volumes
rwo_storage_class N/A Storage class requested for Tackle RWO volumes

Tackle CR Customize Settings

Custom settings can be applied by editing the Tackle CR.

oc edit tackle -n <tackle-namespace>

Tackle Storage Requirements

Tackle requires a total of 5 persistent volumes (PVs) used by different components to successfully deploy, 3 RWO volumes and 2 RWX volumes will be requested via PVCs.

Name Default Size Access Mode Description
hub database 5Gi RWO Hub DB
hub bucket 100Gi RWX Hub file storage
keycloak postgresql 1Gi RWO Keycloak backend DB
pathfinder postgresql 1Gi RWO Pathfinder backend DB
windup 100Gi RWX Windup maven m2 repository

Tackle Storage Custom Settings Example

The example below requests a custom hub bucket volume size and RWX storage class

kind: Tackle
apiVersion: tackle.konveyor.io/v1alpha1
metadata:
  name: tackle
  namespace: konveyor-tackle
spec:
  hub_bucket_volume_size: "50Gi"
  rwx_storage_class: "nfs"

Tackle Documentation

See the Konveyor Tackle Documentation for detailed installation instructions as well as how to use Tackle.