Module AppCluster

Table of Contents

This list provides an overview of all types, values and functions exported from this module. These are not necessarily defined in this module: in some cases, we also re-export items from other modules. When that is the case, we link to the appropriate definition.

• Type App

• Function app

• Type AppCluster

• Function new

Type App

An app is basically a docker image together with some parameters. You can deploy multiple apps in an AppCluster. For every app, the appropriate resources (including a separate load balancer, security group...) will be created.

type App:
  | App
      name: String
      image: String
      port: Int
      memory: Int
      managedPolicies: List<ManagedPolicy>
      logGroupName: Optional<String>

Constructor App

Fields

• name : String

• image : String

• port : Int

• memory : Int

• managedPolicies : List<ManagedPolicy>

• logGroupName : Optional<String>

Function app

Type

fun{name: String, image: String, logGroupName: Optional<String>, port: Optional<Int>, memory: Optional<Int>, managedPolicies: Optional<List<ManagedPolicy>>} -> App

Constructor to create a new App.

Arguments

• name: String

  Descriptive name for the application. Lowercase and hyphen is recommended.

• image: String

  Name of the docker image.

• logGroupName: Optional<String>

  CloudWatch log group name to send logs to.

• port: Optional<Int>

  Port on which your docker image listens. Defaults to 8000.

• memory: Optional<Int>

  Amount of memory available to the image, in MB. Defaults to 256.

• managedPolicies: Optional<List<ManagedPolicy>>

  Extra policies your docker image needs (e.g. SQS access). TODO: The use should be able to specify inline policies as well.

Returns

App

Type AppCluster

type AppCluster:
  cluster: Cluster
  services: List<Service>
  asg: AutoScalingGroup

Fields

• cluster : Cluster

• services : List<Service>

• asg : AutoScalingGroup

Function new

Type

fun{name: String, network: Network, apps: List<App>, size: Optional<Int>, keyName: Optional<String>} -> AppCluster

Create a new AppCluster

Arguments

• name: String

  Name of the cluster. Using lowercase and hyphens is recommended.

• network: Network

  Network to deploy the cluster in.

• apps: List<App>

• size: Optional<Int>

  Number of instances in the network. Defaults to the number apps + 1.

• keyName: Optional<String>

Returns

AppCluster