Containers

This library allows deploying arbitrary containers with Wing.

Installation

Use npm to install this library:

npm i @winglibs/containers

Bring it

The containers.Workload resource represents a containerized workload.

bring containers;

new containers.Workload(
  name: "hello",
  image: "paulbouwer/hello-kubernetes:1",
  port: 8080,
  readiness: "/",
  replicas: 4,
  env: {
    "MESSAGE" => message,
  }
);

Forwarding

The workload.forward() method returns an IForward object with a fromXxx() method for each supported handler type.

For example, this is how you can forward cloud.Api requests:

let work = new containers.Workload(...);
let api = new cloud.Api();
api.get("/my_request", work.forward().fromApi());

You can pass an optional route and method to forward() in order to customize the behavior:

work.forward(route: "/your_request", method: cloud.HttpMethod.PUT);

sim

When executed in the Wing Simulator, the workload is started within a local Docker container.

tf-aws

To deploy containerized workloads on AWS, we will need an EKS cluster. Unless other specified, a cluster will be automatically provisioned for each Wing application.

However, it a common practice to reuse a single EKS cluster for multiple applications. To reference an existing cluster, you will need to specify the following platform values:

• eks.cluster_name: The name of the cluster
• eks.endpoint: The URL of the Kubernetes API endpoint of the cluster
• eks.certificate: The certificate authority of this cluster.

This information can be obtained from the AWS Console or through the script eks-values.sh:

$ ./eks-values.sh CLUSTER-NAME > values.yaml
$ wing compile -t tf-aws --values ./values.yaml main.w

To create a new EKS cluster, you can use the tfaws.Cluster resource:

eks.main.w:

bring containers;

new containers.tfaws.Cluster() as "my-wing-cluster";

And provision it using Terraform:

wing compile -t tf-aws eks.main.w
cd target/eks.main.tfaws
terraform init
terraform apply
./eks-values.sh my-wing-cluster > values.yaml

This might take a up to 20 minutes to provision (now you see why we want to share it across apps?). The last command will populate values.yaml with the the cluster information needed to deploy workloads.

To connect to this cluster using kubectl, use:

aws eks update-kubeconfig --name my-wing-cluster

Then:

$ kubectl get all
NAME                 TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)   AGE
service/kubernetes   ClusterIP   172.20.0.1   <none>        443/TCP   36m

Roadmap

See Captain's Log in the Wing Slack.

• EKS as a singleton
• Container logs to Wing logs
• Add support for local Dockerfiles (currently only images from Docker Hub are supported), this includes publishing into an ECR.
• Invalidation of local docker image (both local and in registry). Check what cdk-assets is doing.
• Reference existing EKS repository.
• Use a cloud.Redis database
• Implement cloud.Service using containers.
• Reference workload from another workload (without going through the load balancer) - Microservice example.
• internalUrl() in the simulator/aws.
• publicUrl() in simulator/aws.
• Logging in tf-aws (Disabled logging because aws-logging configmap was not found. configmap "aws-logging" not found).
• Logging in sim.
• Publish the library
• Generate helm charts under target directory
• Implement start() and stop().
• Sidecar containers
• Domains
• How can we vend ./eks-value.sh as part of this library?
• SSL
• Nodes - what should we do there? Use Fargate profiles in EKS instead of managed node groups?
• Open bugs
• Restore microservice test (fails on GitHub).

License

Licensed under the MIT License.

API Reference

Table of Contents

• Classes
  • Workload
  • sim.Workload_sim
  • helm.Chart
  • eks.Workload_tfaws
  • eks.Vpc
  • eks.Cluster
  • eks.ClusterBase
  • eks.Repository
  • eks.Aws
• Interfaces
  • IForward
  • IWorkload
• Structs
  • ContainerOpts
  • ForwardOptions
  • WorkloadProps

Workload (preflight class)

No description

Constructor

new(props: WorkloadProps): Workload

Properties

Name	Type	Description
internalUrl	str?	No description
publicUrl	str?	No description

Methods

Signature	Description
forward(opts: ForwardOptions?): IForward	No description

sim.Workload_sim (preflight class)

No description

Constructor

new(props: WorkloadProps): Workload_sim

Properties

Name	Type	Description
internalUrl	str?	No description
publicUrl	str?	No description

Methods

Signature	Description
forward(opts: ForwardOptions?): IForward	No description

helm.Chart (preflight class)

No description

Constructor

new(props: WorkloadProps): Chart

Properties

Name	Type	Description
apiObjects	Array	Returns all the included API objects.
labels	Map	Labels applied to all resources in this chart.
namespace	str?	The default namespace for all objects in this chart.

Methods

Signature	Description
forward(opts: ForwardOptions?): IForward	No description
toHelm(workdir: str): str	No description
static toHelmChart(wingdir: str, chart: Chart): str	No description
addDependency(dependencies: Array): void	Create a dependency between this Chart and other constructs.
generateObjectName(apiObject: ApiObject): str	Generates a app-unique name for an object given it's construct node path.
static isChart(x: any): bool	Return whether the given object is a Chart.
static of(c: IConstruct): Chart	Finds the chart in which a node is defined.
toJson(): Array	Renders this chart to a set of Kubernetes JSON resources.

eks.Workload_tfaws (preflight class)

No description

Constructor

new(props: WorkloadProps): Workload_tfaws

Properties

Name	Type	Description
internalUrl	str?	No description
publicUrl	str?	No description

Methods

Signature	Description
forward(opts: ForwardOptions?): IForward	No description

eks.Vpc (preflight class)

No description

Constructor

new(props: VpcProps?): Vpc

Properties

Name	Type	Description
id	str	No description
privateSubnets	Array	No description
publicSubnets	Array	No description

Methods

No methods

eks.Cluster (preflight class)

No description

Constructor

new(clusterName: str): Cluster

Properties

No properties

Methods

Signature	Description
attributes(): ClusterAttributes	No description
static getOrCreate(scope: IResource): ICluster	No description
helmProvider(): TerraformProvider	No description
kubernetesProvider(): TerraformProvider	No description

eks.ClusterBase (preflight class)

No description

Constructor

new(): ClusterBase

Properties

No properties

Methods

Signature	Description
attributes(): ClusterAttributes	No description
helmProvider(): TerraformProvider	No description
kubernetesProvider(): TerraformProvider	No description

eks.Repository (preflight class)

No description

Constructor

new(props: RepositoryProps): Repository

Properties

Name	Type	Description
deps	Array	No description
image	str	No description

Methods

No methods

eks.Aws (preflight class)

No description

Constructor

new(): Aws

Properties

No properties

Methods

Signature	Description
accountId(): str	No description
static getOrCreate(scope: IResource): Aws	No description
region(): str	No description

IForward (interface)

No description

Properties

No properties

Methods

Signature	Description
fromApi(): inflight (request: ApiRequest): ApiResponse?	No description
fromBucketEvent(): inflight (key: str, type: BucketEventType): void	No description
fromQueue(): inflight (message: str): void	No description
fromSchedule(): inflight (): void	No description
fromTopic(): inflight (message: str): void	No description

IWorkload (interface)

No description

Properties

No properties

Methods

Signature	Description
forward(opts: ForwardOptions?): IForward	No description

ContainerOpts (struct)

No description

Properties

Name	Type	Description
args	Array?	No description
env	Map<str?>?	No description
image	str	No description
name	str	No description
port	num?	No description
public	bool?	No description
readiness	str?	No description
replicas	num?	No description
sourceHash	str?	No description
sources	str?	No description

ForwardOptions (struct)

No description

Properties

Name	Type	Description
method	HttpMethod?	No description
route	str?	No description

WorkloadProps (struct)

No description

Properties

Name	Type	Description
args	Array?	No description
env	Map<str?>?	No description
image	str	No description
name	str	No description
port	num?	No description
public	bool?	No description
readiness	str?	No description
replicas	num?	No description
sourceHash	str?	No description
sources	str?	No description