Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move all checks and default values for network stack to NetworkStack class #87

Merged
merged 3 commits into from
Dec 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bin/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ The OpenSearch Contributors require contributions made to
this file be licensed under the Apache-2.0 license or a
compatible open source license. */

import 'source-map-support/register';
import { App } from 'aws-cdk-lib';
import 'source-map-support/register';
import { OsClusterEntrypoint } from '../lib/os-cluster-entrypoint';

const app = new App();
Expand Down
61 changes: 39 additions & 22 deletions lib/networking/vpc-stack.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,50 @@
} from 'aws-cdk-lib/aws-ec2';
import { Construct } from 'constructs';

export interface vpcProps extends StackProps{
cidrBlock: string,
maxAzs: number,
vpcId: string,
securityGroupId: string,
serverAccessType: string,
restrictServerAccessTo: string,
export interface VpcProps extends StackProps{
/** CIDR Block for VPC */
cidr?: string,
/** VPC ID of existing VPC */
vpcId?: string,
/** Security Group to be used for all sources */
securityGroupId?: string,
/** The access type to restrict server. Choose from ipv4, ipv6, prefixList or securityGroupId */
serverAccessType?: string,
/** Restrict server access to */
restrictServerAccessTo?: string,
}

export class NetworkStack extends Stack {
public readonly vpc: IVpc;

public readonly osSecurityGroup: ISecurityGroup;

constructor(scope: Construct, id: string, props: vpcProps) {
let serverAccess: IPeer;
constructor(scope: Construct, id: string, props: VpcProps) {
super(scope, id, props);
if (props.vpcId === undefined) {

let serverAccess: IPeer;
// Properties and context variables check
let cidrRange = `${props?.cidr ?? scope.node.tryGetContext('cidr')}`;
if (cidrRange === 'undefined') {
cidrRange = '10.0.0.0/16';
}
const vpcId = `${props?.vpcId ?? scope.node.tryGetContext('vpcId')}`;
const serverAccessType = `${props?.serverAccessType ?? scope.node.tryGetContext('serverAccessType')}`;
const restrictServerAccessTo = `${props?.restrictServerAccessTo ?? scope.node.tryGetContext('restrictServerAccessTo')}`;
const secGroupId = `${props?.securityGroupId ?? scope.node.tryGetContext('securityGroupId')}`;

if (typeof restrictServerAccessTo === 'undefined' || typeof serverAccessType === 'undefined') {
throw new Error('serverAccessType and restrictServerAccessTo parameters are required - eg: serverAccessType=ipv4 restrictServerAccessTo=10.10.10.10/32');

Check warning on line 50 in lib/networking/vpc-stack.ts

View check run for this annotation

Codecov / codecov/patch

lib/networking/vpc-stack.ts#L50

Added line #L50 was not covered by tests
} else {
serverAccess = NetworkStack.getServerAccess(restrictServerAccessTo, serverAccessType);
}

// VPC specs
if (vpcId === 'undefined') {
console.log('No VPC-Id Provided, a new VPC will be created');

Check warning on line 57 in lib/networking/vpc-stack.ts

View workflow job for this annotation

GitHub Actions / build

Unexpected console statement
this.vpc = new Vpc(this, 'opensearchClusterVpc', {
cidr: (props.cidrBlock !== undefined) ? props.cidrBlock : '10.0.0.0/16',
maxAzs: props.maxAzs,
cidr: cidrRange,
maxAzs: 3,
subnetConfiguration: [
{
name: 'public-subnet',
Expand All @@ -50,25 +72,20 @@
],
});
} else {
console.log('VPC provided, using existing');

Check warning on line 75 in lib/networking/vpc-stack.ts

View workflow job for this annotation

GitHub Actions / build

Unexpected console statement
this.vpc = Vpc.fromLookup(this, 'opensearchClusterVpc', {
vpcId: props.vpcId,
vpcId,
});
}

if (typeof props.restrictServerAccessTo === 'undefined' || typeof props.serverAccessType === 'undefined') {
throw new Error('serverAccessType and restrictServerAccessTo parameters are required - eg: serverAccessType=ipv4 restrictServerAccessTo=10.10.10.10/32');
} else {
serverAccess = NetworkStack.getServerAccess(props.restrictServerAccessTo, props.serverAccessType);
}

if (props.securityGroupId === undefined) {
// Security Group specs
if (secGroupId === 'undefined') {
this.osSecurityGroup = new SecurityGroup(this, 'osSecurityGroup', {
vpc: this.vpc,
allowAllOutbound: true,
});
} else {
this.osSecurityGroup = SecurityGroup.fromSecurityGroupId(this, 'osSecurityGroup', props.securityGroupId);
this.osSecurityGroup = SecurityGroup.fromSecurityGroupId(this, 'osSecurityGroup', secGroupId);

Check warning on line 88 in lib/networking/vpc-stack.ts

View check run for this annotation

Codecov / codecov/patch

lib/networking/vpc-stack.ts#L88

Added line #L88 was not covered by tests
}

/* The security group allows all ip access by default to all the ports.
Expand All @@ -88,7 +105,7 @@
case 'securityGroupId':
return Peer.securityGroupId(restrictServerAccessTo);
default:
throw new Error('serverAccessType should be one of the below values: ipv4, ipv6, prefixList or securityGroupId');
throw new Error('serverAccessType should be one of the below values: ipv4, ipv6, prefixList or securityGroupId');

Check warning on line 108 in lib/networking/vpc-stack.ts

View check run for this annotation

Codecov / codecov/patch

lib/networking/vpc-stack.ts#L108

Added line #L108 was not covered by tests
}
}
}
11 changes: 0 additions & 11 deletions lib/os-cluster-entrypoint.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,6 @@ export class OsClusterEntrypoint {

const x64InstanceTypes: string[] = Object.keys(x64Ec2InstanceType);
const arm64InstanceTypes: string[] = Object.keys(arm64Ec2InstanceType);
const vpcId: string = scope.node.tryGetContext('vpcId');
const securityGroupId = scope.node.tryGetContext('securityGroupId');
const cidrRange = scope.node.tryGetContext('cidr');
const restrictServerAccessTo = scope.node.tryGetContext('restrictServerAccessTo');
const serverAccessType = scope.node.tryGetContext('serverAccessType');

const distVersion = `${scope.node.tryGetContext('distVersion')}`;
if (distVersion.toString() === 'undefined') {
Expand Down Expand Up @@ -233,12 +228,6 @@ export class OsClusterEntrypoint {
}

const network = new NetworkStack(scope, networkStackName, {
cidrBlock: cidrRange,
maxAzs: 3,
vpcId,
securityGroupId,
serverAccessType,
restrictServerAccessTo,
...props,
});

Expand Down
Loading