Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.64 KB

containership.md

File metadata and controls

34 lines (28 loc) · 1.64 KB
Raw

Containership Engine

Description

The Containership engine integrates with Containership Kubernetes Engine to provide cloud agnostic autoscaling on a multitude of cloud providers.

Configuration

In order for the Containership engine to scale your cluster, you will need various configuration parameters.

Field Required Default Type Description
address false https://provision.containership.io string The Containership provision API address.
tokenEnvVarName true string The environment variable name to use to get the Containership API token.
organizationID true string The ID of the organization to which the cluster belongs. You can find this value on the "Organization Settings" page in Containership Cloud.
clusterID true string The ID of the cluster that should be monitored and scaled. You can find this value in your URL once you click into a cluster in Containership Cloud.

Note: You can acquire the Containership Cloud API key on the cluster itself by running the following command:

kubectl get secret containership-env-secret -n containership-core -o jsonpath='{.data.CONTAINERSHIP_CLOUD_CLUSTER_API_KEY}' | base64 -D

Example

apiVersion: cerebral.containership.io/v1alpha1
kind: AutoscalingEngine
metadata:
  name: containership
spec:
  type: containership
  configuration:
    tokenEnvVarName:      CONTAINERSHIP_CLOUD_CLUSTER_API_KEY
    organizationID:       15608402-d588-48c8-b326-db14b012d83e
    clusterID:            5253100f-dc07-462e-9b93-2fc2c0d5431f