Merge pull request #827 from aws-quickstart/fix/ghActions

Fixing GH Actions
aws-quickstart · Aug 23, 2023 · e42d0ed · e42d0ed
2 parents 8420eb7 + f9fa97f
commit e42d0ed
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 46 deletions.
diff --git a/.github/workflows/docbuild.yml b/.github/workflows/docbuild.yml
@@ -19,4 +19,4 @@ jobs:
       - run: pip install mkdocs-material
       - run: npm install
       - run: npx typedoc --out docs/api lib/index.ts
-      - run: mkdocs gh-deploy
+      - run: mkdocs gh-deploy --force
diff --git a/lib/builders/index.ts b/lib/builders/index.ts
@@ -0,0 +1,3 @@
+export * from "./observability-builder";
+export * from "./windows-builder";
+
diff --git a/lib/builders/observability-builder.ts b/lib/builders/observability-builder.ts
@@ -1,24 +1,26 @@
-import * as blueprints from '../../lib';
+import { BlueprintBuilder } from '../../lib/stacks';
+import * as addons from '../../lib/addons';
 import * as utils from "../utils";
+import * as spi from '../../lib/spi';
 import { NestedStack, NestedStackProps } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
 
-export class ObservabilityBuilder extends blueprints.BlueprintBuilder {
+export class ObservabilityBuilder extends BlueprintBuilder {
 
     /**
      * This method helps you prepare a blueprint for setting up observability 
      * returning an array of blueprint addons for AWS native services
      */
     public enableNativePatternAddOns(): ObservabilityBuilder {
         return this.addOns(
-            new blueprints.addons.AwsLoadBalancerControllerAddOn(),
-            new blueprints.addons.CertManagerAddOn(),
-            new blueprints.addons.ContainerInsightsAddOn(),
-            new blueprints.addons.CoreDnsAddOn(),
-            new blueprints.addons.KubeProxyAddOn(),
-            new blueprints.addons.KubeStateMetricsAddOn(),
-            new blueprints.addons.MetricsServerAddOn(),
-            new blueprints.addons.PrometheusNodeExporterAddOn());
+            new addons.AwsLoadBalancerControllerAddOn(),
+            new addons.CertManagerAddOn(),
+            new addons.ContainerInsightsAddOn(),
+            new addons.CoreDnsAddOn(),
+            new addons.KubeProxyAddOn(),
+            new addons.KubeStateMetricsAddOn(),
+            new addons.MetricsServerAddOn(),
+            new addons.PrometheusNodeExporterAddOn());
     }
 
     /**
@@ -28,14 +30,14 @@ export class ObservabilityBuilder extends blueprints.BlueprintBuilder {
      */
     public enableMixedPatternAddOns(): ObservabilityBuilder {
         return this.addOns(
-            new blueprints.addons.AwsLoadBalancerControllerAddOn(),
-            new blueprints.addons.AdotCollectorAddOn(),
-            new blueprints.addons.CertManagerAddOn(),
-            new blueprints.addons.CoreDnsAddOn(),
-            new blueprints.addons.KubeProxyAddOn(),
-            new blueprints.addons.KubeStateMetricsAddOn(),
-            new blueprints.addons.MetricsServerAddOn(),
-            new blueprints.addons.PrometheusNodeExporterAddOn());
+            new addons.AwsLoadBalancerControllerAddOn(),
+            new addons.AdotCollectorAddOn(),
+            new addons.CertManagerAddOn(),
+            new addons.CoreDnsAddOn(),
+            new addons.KubeProxyAddOn(),
+            new addons.KubeStateMetricsAddOn(),
+            new addons.MetricsServerAddOn(),
+            new addons.PrometheusNodeExporterAddOn());
     }
 
     /**
@@ -44,19 +46,19 @@ export class ObservabilityBuilder extends blueprints.BlueprintBuilder {
      */
     public enableOpenSourcePatternAddOns(ampPrometheusEndpoint: string): ObservabilityBuilder {
         return this.addOns(
-            new blueprints.addons.AwsLoadBalancerControllerAddOn(),
-            new blueprints.addons.AdotCollectorAddOn(),
-            new blueprints.addons.AmpAddOn({
+            new addons.AwsLoadBalancerControllerAddOn(),
+            new addons.AdotCollectorAddOn(),
+            new addons.AmpAddOn({
                 ampPrometheusEndpoint: ampPrometheusEndpoint,
             }),
-            new blueprints.addons.CertManagerAddOn(),
-            new blueprints.addons.CoreDnsAddOn(),
-            new blueprints.addons.ExternalsSecretsAddOn(),
-            new blueprints.addons.GrafanaOperatorAddon(),
-            new blueprints.addons.KubeProxyAddOn(),
-            new blueprints.addons.KubeStateMetricsAddOn(),
-            new blueprints.addons.MetricsServerAddOn(),
-            new blueprints.addons.PrometheusNodeExporterAddOn());
+            new addons.CertManagerAddOn(),
+            new addons.CoreDnsAddOn(),
+            new addons.ExternalsSecretsAddOn(),
+            new addons.GrafanaOperatorAddon(),
+            new addons.KubeProxyAddOn(),
+            new addons.KubeStateMetricsAddOn(),
+            new addons.MetricsServerAddOn(),
+            new addons.PrometheusNodeExporterAddOn());
     }
 
     /**
@@ -66,7 +68,7 @@ export class ObservabilityBuilder extends blueprints.BlueprintBuilder {
     public static builder(): ObservabilityBuilder {
         const builder = new ObservabilityBuilder();
         builder.addOns(
-            new blueprints.NestedStackAddOn({
+            new addons.NestedStackAddOn({
                 id: "usage-tracking-addon",
                 builder: UsageTrackingAddOn.builder(),
             }));
@@ -77,11 +79,11 @@ export class ObservabilityBuilder extends blueprints.BlueprintBuilder {
 /**
  * Nested stack that is used as tracker for Observability Accelerator
  */
-export class UsageTrackingAddOn extends NestedStack {
+class UsageTrackingAddOn extends NestedStack {
 
     static readonly USAGE_ID = "qs-1u9l12gj7";
 
-    public static builder(): blueprints.NestedStackBuilder {
+    public static builder(): spi.NestedStackBuilder {
         return {
             build(scope: Construct, id: string, props: NestedStackProps) {
                 return new UsageTrackingAddOn(scope, id, props);

diff --git a/lib/builders/windows-builder.ts b/lib/builders/windows-builder.ts
@@ -1,5 +1,9 @@
-import * as blueprints from '../../lib';
+import { BlueprintBuilder } from '../../lib/stacks';
+import * as addons from '../../lib/addons';
 import * as utils from "../utils";
+import * as spi from '../../lib/spi';
+import * as clusterproviders from '../../lib/cluster-providers';
+import * as resourceproviders from '../../lib/resource-providers';
 import { NestedStack, NestedStackProps } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
 import * as eks from "aws-cdk-lib/aws-eks";
@@ -96,7 +100,7 @@ const defaultOptions: WindowsOptions = {
     kubernetesVersion: eks.KubernetesVersion.of("1.27"),
     instanceClass: ec2.InstanceClass.M5,
     instanceSize: ec2.InstanceSize.XLARGE4,
-    nodeRole: blueprints.getNamedResource("node-role") as iam.Role,
+    nodeRole: resourceproviders.getNamedResource("node-role") as iam.Role,
     windowsAmiType: NodegroupAmiType.WINDOWS_FULL_2022_X86_64,
     desiredNodeSize: 2,
     minNodeSize: 2,
@@ -127,7 +131,7 @@ const defaultOptions: WindowsOptions = {
  * 2. A non-windows nodegroup for standard software.
  * 3. A windows nodegroup to schedule windows workloads
  */
-export class WindowsBuilder extends blueprints.BlueprintBuilder {
+export class WindowsBuilder extends BlueprintBuilder {
 
     /**
      * This method helps you prepare a blueprint for setting up windows nodes with 
@@ -139,10 +143,10 @@ export class WindowsBuilder extends blueprints.BlueprintBuilder {
 
         builder
             .clusterProvider(
-                new blueprints.GenericClusterProvider({
+                new clusterproviders.GenericClusterProvider({
                     version: mergedOptions.kubernetesVersion,
                     tags: mergedOptions.clusterProviderTags,
-                    role: blueprints.getResource(context => {
+                    role: resourceproviders.getResource(context => {
                         return new iam.Role(context.scope, 'ClusterRole', { 
                             assumedBy: new iam.ServicePrincipal("eks.amazonaws.com"),
                             managedPolicies: [
@@ -158,7 +162,7 @@ export class WindowsBuilder extends blueprints.BlueprintBuilder {
                 })
             )
             .addOns(
-                new blueprints.NestedStackAddOn({
+                new addons.NestedStackAddOn({
                     id: "usage-tracking-addon",
                     builder: UsageTrackingAddOn.builder(),
                 })
@@ -170,11 +174,11 @@ export class WindowsBuilder extends blueprints.BlueprintBuilder {
 /**
  * Nested stack that is used as tracker for Windows Accelerator
  */
-export class UsageTrackingAddOn extends NestedStack {
+class UsageTrackingAddOn extends NestedStack {
 
     static readonly USAGE_ID = "qs-1ubotj5kl";
 
-    public static builder(): blueprints.NestedStackBuilder {
+    public static builder(): spi.NestedStackBuilder {
         return {
             build(scope: Construct, id: string, props: NestedStackProps) {
                 return new UsageTrackingAddOn(scope, id, props);
@@ -192,7 +196,7 @@ export class UsageTrackingAddOn extends NestedStack {
  * @param: options: WindowsOptions
  * @returns: blueprints.ManagedNodeGroup
  */
-function addGenericNodeGroup(options: WindowsOptions): blueprints.ManagedNodeGroup {
+function addGenericNodeGroup(options: WindowsOptions): clusterproviders.ManagedNodeGroup {
 
     return {
         id: "mng-linux",
@@ -215,8 +219,8 @@ function addGenericNodeGroup(options: WindowsOptions): blueprints.ManagedNodeGro
  * @param options: WindowsOptions
  * @returns: blueprints.ManagedNodeGroup
  */
-function addWindowsNodeGroup(options: WindowsOptions): blueprints.ManagedNodeGroup {
-    const result : blueprints.ManagedNodeGroup = {
+function addWindowsNodeGroup(options: WindowsOptions): clusterproviders.ManagedNodeGroup {
+    const result : clusterproviders.ManagedNodeGroup = {
         id: "mng-windows",
         amiType: options.windowsAmiType,
         instanceTypes: [new ec2.InstanceType(`${options.instanceClass}.${options.instanceSize}`)],
@@ -230,7 +234,7 @@ function addWindowsNodeGroup(options: WindowsOptions): blueprints.ManagedNodeGro
     };
 
     if(options.noScheduleForWindowsNodes) {
-        blueprints.utils.setPath(result, "taints", [
+        utils.setPath(result, "taints", [
             {
                 key: "os",
                 value: "windows",

diff --git a/lib/index.ts b/lib/index.ts
@@ -1,6 +1,9 @@
 export * from './addons';
 export * as addons from './addons';
 
+export * from './builders';
+export * as builders from './builders';
+
 export * from './stacks';
 export * as stacks from './stacks';
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@aws-quickstart/eks-blueprints",
-    "version": "1.11.0",
+    "version": "1.11.1",
     "license": "Apache-2.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",