Skip to content

Latest commit

 

History

History
252 lines (150 loc) · 8.72 KB

API.md

File metadata and controls

252 lines (150 loc) · 8.72 KB
Raw

API Reference

Constructs

ClusterAutoScaler

Initializers 

import { ClusterAutoScaler } from '@opencdk8s/cdk8s-cluster-autoscaler-aws'

new ClusterAutoScaler(scope: Construct, name: string, opts: ClusterAutoScalerOptions)
Name Type Description
scope constructs.Construct No description.
name string No description.
opts ClusterAutoScalerOptions No description.
scopeRequired
  • Type: constructs.Construct
nameRequired
  • Type: string
optsRequired

Properties

Name Type Description
command string[] Extra commands for controller.
createServiceAccount boolean service account for aws-load-balancer-controller.
image string image for deployment.
namespace string Namespace.
serviceAccountName string Service Account Name.
commandOptional 
public readonly command: string[];
  • Type: string[]
  • Default: [ './cluster-autoscaler', '--v=4', '----stderrthreshold=info', '--cloud-provider=aws', '--skip-nodes-with-local-storage=false', '--expander=least-waste' ]

Extra commands for controller.

createServiceAccountOptional 
public readonly createServiceAccount: boolean;
  • Type: boolean
  • Default: true

service account for aws-load-balancer-controller.

imageOptional 
public readonly image: string;
  • Type: string

image for deployment.

namespaceOptional 
public readonly namespace: string;
  • Type: string
  • Default: kube-system

Namespace.

serviceAccountNameOptional 
public readonly serviceAccountName: string;
  • Type: string
  • Default: cluster-autoscaler

Service Account Name.

Structs

ClusterAutoScalerOptions

Initializer 

import { ClusterAutoScalerOptions } from '@opencdk8s/cdk8s-cluster-autoscaler-aws'

const clusterAutoScalerOptions: ClusterAutoScalerOptions = { ... }

Properties

Name Type Description
command string[] Extra commands for controller.
createServiceAccount boolean service account for aws-load-balancer-controller.
image string image for deployment.
namespace string Namespace.
serviceAccountName string Service Account Name.
commandOptional 
public readonly command: string[];
  • Type: string[]
  • Default: [ './cluster-autoscaler', '--v=4', '----stderrthreshold=info', '--cloud-provider=aws', '--skip-nodes-with-local-storage=false', '--expander=least-waste' ]

Extra commands for controller.

createServiceAccountOptional 
public readonly createServiceAccount: boolean;
  • Type: boolean
  • Default: true

service account for aws-load-balancer-controller.

imageOptional 
public readonly image: string;
  • Type: string

image for deployment.

namespaceOptional 
public readonly namespace: string;
  • Type: string
  • Default: kube-system

Namespace.

serviceAccountNameOptional 
public readonly serviceAccountName: string;
  • Type: string
  • Default: cluster-autoscaler

Service Account Name.

Classes

AwsClusterAutoScalerPolicyHelper

Aws External Dns Policy class ,help you add policy to your Iam Role for service account.

Initializers 

import { AwsClusterAutoScalerPolicyHelper } from '@opencdk8s/cdk8s-cluster-autoscaler-aws'

new AwsClusterAutoScalerPolicyHelper()
Name Type Description

Static Functions

Name Description
addPolicy No description.
addPolicy 
import { AwsClusterAutoScalerPolicyHelper } from '@opencdk8s/cdk8s-cluster-autoscaler-aws'

AwsClusterAutoScalerPolicyHelper.addPolicy(role: any)
roleRequired
  • Type: any