Skip to content

Latest commit

 

History

History
111 lines (60 loc) · 4.67 KB

API.md

File metadata and controls

111 lines (60 loc) · 4.67 KB
Raw

API Reference

Classes

Name Description
MyMongo MongoDB Stateful Set class.

Structs

Name Description
ResourceQuantity No description
ResourceRequirements No description
STSOptions No description

class MyMongo 🔹

MongoDB Stateful Set class.

Implements: IConstruct Extends: Construct

Initializer

new MyMongo(scope: Construct, name: string, opts: STSOptions)
  • scope (Construct) No description
  • name (string) No description
  • opts (STSOptions) No description
    • image (string) The Docker image to use for this app.
    • createStorageClass (boolean) Option to create storage class, if enabled, a storage class will be created for the statefulset. Default: true
    • defaultReplicas (number) Number of replicas. Default: 3
    • namespace (string) The Kubernetes namespace where this app to be deployed. Default: 'default'
    • nodeSelectorParams (Map<string, string>) nodeSelector params. Default: undefined
    • resources (ResourceRequirements) Resources requests for the DB. Default: Requests = { CPU = 200m, Mem = 256Mi }, Limits = { CPU = 400m, Mem = 512Mi }
    • storageClassName (string) The storage class to use for our PVC. Default: 'gp2-expandable'
    • storageClassParams (Map<string, string>) Storage class params. Default: { type = gp2, fsType: ext4 }
    • volumeProvisioner (string) Each StorageClass has a provisioner that determines what volume plugin is used for provisioning PVs. Default: 'kubernetes.io/aws-ebs'
    • volumeSize (string) The Volume size of our DB in string, e.g 10Gi, 20Gi. Optional

Properties

Name Type Description
name🔹 string
namespace🔹 string

struct ResourceQuantity 🔹

Name Type Description
cpu?🔹 string Default: no limit
memory?🔹 string Default: no limit

struct ResourceRequirements 🔹

Name Type Description
limits?🔹 ResourceQuantity Maximum resources for the web app.
Default: CPU = 400m, Mem = 512Mi
requests?🔹 ResourceQuantity Required resources for the web app.
Default: CPU = 200m, Mem = 256Mi

struct STSOptions 🔹

Name Type Description
image🔹 string The Docker image to use for this app.
createStorageClass?🔹 boolean Option to create storage class, if enabled, a storage class will be created for the statefulset.
Default: true
defaultReplicas?🔹 number Number of replicas.
Default: 3
namespace?🔹 string The Kubernetes namespace where this app to be deployed.
Default: 'default'
nodeSelectorParams?🔹 Map<string, string> nodeSelector params.
Default: undefined
resources?🔹 ResourceRequirements Resources requests for the DB.
Default: Requests = { CPU = 200m, Mem = 256Mi }, Limits = { CPU = 400m, Mem = 512Mi }
storageClassName?🔹 string The storage class to use for our PVC.
Default: 'gp2-expandable'
storageClassParams?🔹 Map<string, string> Storage class params.
Default: { type = gp2, fsType: ext4 }
volumeProvisioner?🔹 string Each StorageClass has a provisioner that determines what volume plugin is used for provisioning PVs.
Default: 'kubernetes.io/aws-ebs'
volumeSize?🔹 string The Volume size of our DB in string, e.g 10Gi, 20Gi.
Optional