Skip to content

Commit

Permalink
documentation updates (#1023)
Browse files Browse the repository at this point in the history
  • Loading branch information
shapirov103 authored Jun 19, 2024
1 parent faadf1e commit ec196da
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 18 deletions.
1 change: 0 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ const app = new cdk.App();
// AddOns for the cluster.
const addOns: Array<blueprints.ClusterAddOn> = [
new blueprints.addons.ArgoCDAddOn,
new blueprints.addons.CalicoAddOn,
new blueprints.addons.MetricsServerAddOn,
new blueprints.addons.ClusterAutoScalerAddOn,
new blueprints.addons.ContainerInsightsAddOn,
Expand Down
1 change: 0 additions & 1 deletion docs/cluster-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ export default class MultiRegionConstruct extends cdk.Construct {
const addOns: Array<blueprints.ClusterAddOn> = [
new blueprints.addons.NginxAddOn,
new blueprints.addons.ArgoCDAddOn,
new blueprints.addons.CalicoAddOn,
new blueprints.addons.MetricsServerAddOn,
new blueprints.addons.ClusterAutoScalerAddOn,
new blueprints.addons.ContainerInsightsAddOn,
Expand Down
25 changes: 16 additions & 9 deletions docs/cluster-providers/mng-cluster-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,25 @@ The `MngClusterProvider` allows you to provision an EKS cluster which leverages
## Usage

```typescript
const props: MngClusterProviderProps = {
import * as cdk from 'aws-cdk-lib';
import * as ec2 from 'aws-cdk-lib/aws-ec2';
import * as eks from 'aws-cdk-lib/aws-eks';
import * as bp from '@aws-quickstart/eks-blueprints';

const app = new cdk.App();

const props: bp.MngClusterProviderProps = {
minSize: 1,
maxSize: 10,
desiredSize: 4,
instanceTypes: [new InstanceType('m5.large')],
amiType: NodegroupAmiType.AL2_X86_64,
nodeGroupCapacityType: CapacityType.ON_DEMAND,
version: KubernetesVersion.V1_29,
amiReleaseVersion: "1.20.4-20210519" // this will upgrade kubelet to 1.20.4
}
const clusterProvider = new blueprints.MngClusterProvider(props);
new blueprints.EksBlueprint(scope, { id: 'blueprint', [], [], clusterProvider });
instanceTypes: [new ec2.InstanceType('m5.large')],
amiType: eks.NodegroupAmiType.AL2023_X86_64_STANDARD,
nodeGroupCapacityType: eks.CapacityType.ON_DEMAND,
amiReleaseVersion: "1.30.0-20240615" // this will upgrade kubelet to 1.30.0
};

const clusterProvider = new bp.MngClusterProvider(props);
new bp.EksBlueprint(app, { id: 'blueprint-1', addOns:[], teams: [], clusterProvider, version: eks.KubernetesVersion.V1_30 });
```

## Configuration
Expand Down
6 changes: 2 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,10 @@ blueprints.HelmAddOn.validateHelmVersions = true; // optional if you would like

const addOns: Array<blueprints.ClusterAddOn> = [
new blueprints.addons.ArgoCDAddOn(),
new blueprints.addons.CalicoOperatorAddOn(),
new blueprints.addons.MetricsServerAddOn(),
new blueprints.addons.ClusterAutoScalerAddOn(),
new blueprints.addons.AwsLoadBalancerControllerAddOn(),
new blueprints.addons.VpcCniAddOn(),
new blueprints.addons.VpcCniAddOn(), // support network policies ootb
new blueprints.addons.CoreDnsAddOn(),
new blueprints.addons.KubeProxyAddOn()
];
Expand Down Expand Up @@ -157,9 +156,8 @@ Congratulations! You have deployed your first EKS cluster with `eks-blueprints`.

- [x] A new Well-Architected VPC with both Public and Private subnets.
- [x] A new Well-Architected EKS cluster in the region and account you specify.
- [x] [Nginx](https://kubernetes.github.io/ingress-nginx/deploy/) into your cluster to serve as a reverse proxy for your workloads.
- [x] [Nginx](https://docs.nginx.com/nginx-ingress-controller/technical-specifications/) into your cluster to serve as a reverse proxy for your workloads.
- [x] [ArgoCD](https://argoproj.github.io/argo-cd/) into your cluster to support GitOps deployments.
- [x] [Calico](https://docs.projectcalico.org/getting-started/kubernetes/) into your cluster to support Network policies.
- [x] [Metrics Server](https://github.com/kubernetes-sigs/metrics-server) into your cluster to support metrics collection.
- [x] AWS and Kubernetes resources needed to support [Cluster Autoscaler](https://docs.aws.amazon.com/eks/latest/userguide/cluster-autoscaler.html).
- [x] AWS and Kubernetes resources needed to forward logs and metrics to [Container Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/deploy-container-insights-EKS.html).
Expand Down
5 changes: 2 additions & 3 deletions docs/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ const blueprint = blueprints.EksBlueprint.builder()
new blueprints.AwsLoadBalancerControllerAddOn,
new blueprints.ExternalDnsAddOn,
new blueprints.NginxAddOn,
new blueprints.CalicoAddOn,
new blueprints.MetricsServerAddOn,
new blueprints.ClusterAutoScalerAddOn,
new blueprints.ContainerInsightsAddOn)
new blueprints.ClusterAutoScalerAddOn
)
.teams(new team.TeamRikerSetup);
```

Expand Down

0 comments on commit ec196da

Please sign in to comment.