This page provides information that can be used to help you understand how much resource (such as CPU and RAM) is required to install and use Services Toolkit.

Note: At present it is not possible to alter default resource configurations for Services Toolkit as part of the installation process. We are planning to add support for this at some point in the future.

Deployments

In order to better understand resource requirements and utilisation, it is important to consider the various Kubernetes Deployments that get created as part of installation, and subsequent usage of, Services Toolkit.

Upon installation of Services Toolkit to a cluster, a single Deployment named scp-toolkit-controller-manager will be created and it defines a container with the following resource configuration:

  resources:
    limits:
      cpu: 200m
      memory: 500Mi
    requests:
      cpu: 100m
      memory: 100Mi

Note: Please refer to the Kubernetes documentation on Managing Resources for Containers for further information on resource management in Kubernetes.

Then, for each DownstreamClusterLink resource created as part of configuring a Projection Plane (see Service API Projection and Service Resource Replication), 1 additional Deployment will be created on the downstream cluster. This Deployment defines a container with the following resource configuration:

  resources:
    limits:
      cpu: 100m
      memory: 100Mi
    requests:
      cpu: 100m
      memory: 20Mi

And finally, there will be one additional Deployment for each ClusterResourceExportMonitor and ClusterResourceImportMonitor resource that gets created upon configuration of Resource Replication (see Service API Projection and Service Resource Replication). This Deployment defines a container with the following resource configuration:

  resources:
    limits:
      cpu: 100m
      memory: 100Mi
    requests:
      cpu: 100m
      memory: 20Mi

Taking the above into consideration, the minimum set of resources required to support the federation of an API between a Workload Cluster and a Service Cluster can be broken down as follows:

  • Workload Cluster

    • 1 x SCP controller manager deployment
    • requests 100m CPU and 100Mi memory
    • 1 x API proxy deployment
    • requests 100m CPU and 20Mi memory
    • 1 x ClusterResourceImportMonitor deployment
    • requests 100m CPU and 20Mi memory
  • Service Cluster

    • 1 x SCP controller manager deployment
    • requests 100m CPU and 100Mi memory
    • 1 x ClusterResourceExportMonitor deployment
    • requests 100m CPU and 20Mi memory
  • Total min resource requirements

    • Workload Cluster = 300m CPU and 140Mi memory
    • Service Cluster = 200m CPU and 120Mi

Note that Services Toolkit does not require the use of volumes or any external storage.

check-circle-line exclamation-circle-line close-line
Scroll to top icon