DEV Community

Cover image for Use CDK8S To Create AWS Controllers for Kubernetes Custom Resources
AWS Community Builders profile image 🚀 Vu Dao 🚀
🚀 Vu Dao 🚀 for AWS Community Builders

Posted on • Updated on

Use CDK8S To Create AWS Controllers for Kubernetes Custom Resources

#aws #ack #cloudopz #cdk8s

Abstract

  • There is question, How does ACK relate to cdk8s?
  • Answer: All of the ACK controllers watch for specific CRs and you can generate those resources using cdk8s. The two projects complement each other. cdk8s can create the Kubernetes resources and ACK uses those resources to create the AWS infrastructure.
  • This post gives example of generating kubernetes manifest of ACK using cdk8s typescript

Table Of Contents

🚀 Pre-requisite

🚀 Init cdk8s-app projen

  • You can just init cdk8s project using cdk8s init typescript-app but following is used projen to mange configuration through code
  • Init cdk8s-app-ts with projen in typescript. 
  ⚡ $ projen new cdk8s-app-ts --projenrc-ts
Enter fullscreen mode Exit fullscreen mode
  • cdk8s import 
  ⚡ $ cdk8s import --language typescript --output src/imports
  Importing k8s v1.22.0...
  Importing resources, this may take a few moments...
  k8s
Enter fullscreen mode Exit fullscreen mode

🚀 Import ACK CRDS As CDK8S API 

  ⚡ $ cdk8s import https://raw.githubusercontent.com/aws-controllers-k8s/s3-controller/main/helm/crds/s3.services.k8s.aws_buckets.yaml --output src/imports/
  Importing resources, this may take a few moments...
  s3.services.k8s.aws
    s3.services.k8s.aws/bucket
Enter fullscreen mode Exit fullscreen mode
  • rds-controller crds, rename file from rds.services.k8s.aws.ts to rds.services.db.instance.k8s.aws.ts after import due to that name is assigned for all CRDS with in the rds-controller crds 
  ⚡ $ cdk8s import https://raw.githubusercontent.com/aws-controllers-k8s/rds-controller/main/helm/crds/rds.services.k8s.aws_dbinstances.yaml --output src/imports/
  Importing resources, this may take a few moments...
  rds.services.k8s.aws
    rds.services.k8s.aws/dbinstance

  ⚡ $ mv src/imports/rds.services.k8s.aws.ts src/imports/rds.services.db.instance.k8s.aws.ts
Enter fullscreen mode Exit fullscreen mode
  • RDS subnet group, rename file from rds.services.k8s.aws.ts to rds.services.subnet.group.k8s.aws.ts 
  ⚡ $ cdk8s import https://raw.githubusercontent.com/aws-controllers-k8s/rds-controller/main/helm/crds/rds.services.k8s.aws_dbsubnetgroups.yaml --output src/imports/
  Importing resources, this may take a few moments...
  rds.services.k8s.aws
    rds.services.k8s.aws/dbsubnetgroup

  ⚡ $ mv src/imports/rds.services.k8s.aws.ts src/imports/rds.services.subnet.group.k8s.aws.ts
Enter fullscreen mode Exit fullscreen mode

🚀 Get your hands dirty with code now 

  rds
  ├── constants.ts
  ├── db-instance.ts
  └── subnet-group.ts
Enter fullscreen mode Exit fullscreen mode
  • DBInstance requires subnet group which contains private subnets in EKS VPC (subnet-group.ts) and secret keys to hold user credential. The k8s secret is not generated through code here.

  • db-instance.ts defines specs of DbInstance

  s3
  ├── constants.ts
  └── s3.ts
Enter fullscreen mode Exit fullscreen mode

🚀 Build manifest

  • Just run yarn build 
⚡ $ yarn build
yarn run v1.22.15
warning ../../../package.json: No license field
$ npx projen build
👾 build » default | ts-node --project tsconfig.dev.json .projenrc.ts
👾 build » compile | tsc --build
👾 build » post-compile » synth | cdk8s synth
No manifests synthesized
👾 build » test | jest --passWithNoTests --all --updateSnapshot
No tests found, exiting with code 0
----------|---------|----------|---------|---------|-------------------
File      | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
----------|---------|----------|---------|---------|-------------------
All files |       0 |        0 |       0 |       0 |
----------|---------|----------|---------|---------|-------------------
👾 build » test » eslint | eslint --ext .ts,.tsx --fix --no-error-on-unmatched-pattern src test build-tools .projenrc.js
Done in 25.90s.
Enter fullscreen mode Exit fullscreen mode
  • Output directory 
  dist
  ├── rds
  │   ├── rds-db-instance.yaml
  │   └── rds-subnet-group.yaml
  └── s3
      └── s3-test-bucket.yaml
Enter fullscreen mode Exit fullscreen mode
  • We can now use the yaml files to create the AWS infrastructure through ACK

🚀 Conclusion

  • Although we have to import ACK CRDS resources for cdk8s API, we can manage k8s manifests through code
vumdao image

🚀 Vu Dao 🚀

🚀 AWSome Devops | AWS Community Builder | AWS SA || ☁️ CloudOpz ☁️

GitHub logo vumdao / vumdao

Top comments (1)

Collapse
 
ductnn profile image
Duc Tran •

thank you :D

Read next

magpys profile image

Upload large files to AWS S3 using Multipart upload and presigned URLs

Daniel Griffiths -

sarvar_04 profile image

🚀"Streamlining Infrastructure Deployment: 💻 Seamless CloudFormation Stack Deployment with Git Sync🔄"

Sarvar Nadaf -

obinnadtq profile image

Query Postgres from CloudFront functions with Neon serverless driver

Obinna Isiwekpeni -

hardeepjethwani profile image

Soundtrack Sorcery: Extracting Hidden Harmonies from Your Videos with AWS

Hardeep Jethwani -