@grucloud/module-aws-vpc
v2.3.1
Published
A GruCloud module to create an AWS VPC suitable for EKS
Downloads
6
Readme
AWS VPC GruCloud module
The AWS VPC Grucloud module creates a base set of EC2 resources to be used by an EKS cluster.
Once again, a picture is worth a thousands words. This module packs and configures all these resources ready to be consumed by your application.
Resources
Below is the list of the resources involved as well a link towards their documentations:
All these resources are just the foundation to build real world applications on top of it, for instance a Kubernetes cluster
TL;DR: How to use this module in my project ?
Follow this simple 4 steps to use this module in your GruCloud project:
Install the @grucloud/module-aws-vpc module with npm:
npm install @grucloud/module-aws-vpc
In your iac.js, import the module:
const ModuleAwsVpc = require("@grucloud/module-aws-vpc");
In your createStack, provides the config to the AWS provider through the configs array:
const provider = AwsProvider({ configs: [config, ModuleAwsVpc.config] });
Create the resources:
const vpcResources = await ModuleAwsVpc.createResources({
provider,
});
That's it, as simple as that.
Refer to the example for the complete code.
Code
The Javascript describing this module is implemented in iac.js, which exports:
- createResources: creates the resources for this provider.
- config.js: the default configuration
Example
Refer to the example which shows off the usage of this module.
Testing
This module can be tested with the npm test
command. It executes the mocha test suite in the test directory.