Dữ liệu FDE TimesViệc làm FDE đang mở 873▼9 Thay đổi số việc đang mở trong 7 ngày, so sánh cùng phạm vi: không tính việc của các công ty mới được theo dõi tuần nàyMới trong 7 ngày 55Công ty đang tuyển 181Nhận làm từ xa 25%Lương trung vị (Mỹ) $200kTuyển nhiều nhất Databricks 98
中文EN

Tờ báo của nghề Forward Deployed Engineer

Công cụ

AWS CDK giúp FDE dựng lại hạ tầng cho từng khách mà không chép tay

Cái bẫy thường nằm ở một tên bucket viết cứng hoặc một construct bị đổi tên.

Chia sẻLinkedInFacebookX

Tóm tắt nhanh

  • CDK định nghĩa hạ tầng bằng code thông thường rồi deploy qua CloudFormation, hỗ trợ 6 nhóm ngôn ngữ, trong đó có TypeScript.
  • Mỗi environment là một cặp account và Region. Cùng một lớp stack có thể khởi tạo cho từng khách, miễn là mỗi environment đã chạy bootstrap một lần.
  • Để CDK tự sinh tên tài nguyên, tách database ra stack riêng và commit cdk.context.json để lần deploy sau không lệch lần trước.
Sơ đồ: một construct DocIngest (tô cam) được dùng lại trong hai stack, khach-a-us và khach-b-eu. Hai stack này deploy tới hai environment: Khách A ở us-east-1 và Khách B ở eu-west-1. Mỗi environment phải chạy cdk bootstrap một lần.
Construct chứa logic dùng lại cho mọi khách. Stack chỉ ghép construct cho từng environment, tức một cặp tài khoản AWS và Region. Nguồn: tài liệu best practices của AWS CDK, theo bài viết.

Chỉ cần một tên bucket viết cứng trong code là bạn không thể dựng cùng một hạ tầng lần thứ hai trong cùng tài khoản AWS. Tài liệu best practices của AWS CDK cảnh báo đúng điều này. Với một FDE, đây là ranh giới giữa deployment lặp lại được và một tuần ngồi click console lại từ đầu cho khách mới.

Hiếm khi FDE chỉ làm cho một khách. Pattern bạn làm ra ở khách đầu tiên sớm muộn sẽ được mang sang khách thứ hai, thứ ba, có khi kèm yêu cầu dữ liệu phải nằm ở Region khác. Nếu hạ tầng của khách đầu chỉ tồn tại trong console và trong đầu bạn, khách sau sẽ phải bắt đầu lại từ số không.

AWS CDK biến hạ tầng thành một thư viện code dùng lại được. Muốn dùng nó cho tốt, bạn cần biết nó làm gì, nên đặt ranh giới ở đâu và những chỗ nào dễ làm hỏng việc.

Hạ tầng thành code thường, deploy qua CloudFormation

CDK là framework mã nguồn mở do AWS phát triển. Bạn mô tả hạ tầng bằng code, CDK provision nó qua CloudFormation. Framework hỗ trợ TypeScript, JavaScript, Python, Java, C#/.NET và Go. Mã nguồn nằm ở repo công khai aws/aws-cdk, giấy phép Apache-2.0.

Bản v2 ra mắt chính thức ngày 2/12/2021 và gom mọi thư viện construct ổn định vào một package duy nhất là aws-cdk-lib. Nhờ đó, một dự án mới chỉ cần một dependency chính thay vì hàng loạt package lẻ.

Lợi ích lớn nhất đến từ việc hạ tầng giờ là code bình thường. Bạn review nó qua pull request, viết unit test và quản lý bằng source control như mọi phần mềm khác. Khi bàn giao, khách nhận một repo đọc được chứ không phải một danh sách thao tác trong console.

Mỗi khách là một environment

Trong CDK, environment là cặp tài khoản AWS và Region mà stack được deploy tới. Tài liệu chính thức minh họa bằng cách khởi tạo cùng một lớp stack hai lần, một lần với env của Mỹ và một lần với env của EU. Đó cũng là pattern nền cho việc deploy theo từng khách.

AWS khuyên tách hai việc: model bằng construct, deploy bằng stack. Construct là đơn vị logic dùng lại được, chẳng hạn một pipeline nhận tài liệu. Stack chỉ ghép các construct cho một kịch bản deploy cụ thể. Thử hình dung khách A chạy ở Mỹ, khách B yêu cầu dữ liệu ở EU. Code tối thiểu sẽ trông như sau:

import { App, Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as s3 from 'aws-cdk-lib/aws-s3';

// Construct dùng lại cho mọi khách
class DocIngest extends Construct {
  constructor(scope: Construct, id: string) {
    super(scope, id);
    new s3.Bucket(this, 'Raw'); // không đặt bucketName, để CDK tự sinh tên
  }
}

class CustomerStack extends Stack {
  constructor(scope: Construct, id: string, props: StackProps) {
    super(scope, id, props);
    new DocIngest(this, 'DocIngest');
  }
}

const app = new App();
new CustomerStack(app, 'khach-a-us', { env: { account: '111111111111', region: 'us-east-1' } });
new CustomerStack(app, 'khach-b-eu', { env: { account: '222222222222', region: 'eu-west-1' } });

Cấu hình của từng khách nằm ngay trong source code thay vì trong template có tham số. AWS khuyến nghị đúng cách này, để mỗi commit sinh ra một template CloudFormation xác định cho từng environment. Khi khách hỏi “hạ tầng đang chạy là phiên bản nào”, câu trả lời là một commit hash.

Trước lần deploy đầu tiên, mỗi environment phải được bootstrap một lần bằng cdk bootstrap, vì các environment hoàn toàn độc lập với nhau. Lấy ví dụ 2 khách, mỗi khách có staging và production ở hai Region khác nhau: bạn có 4 environment và phải bootstrap 4 lần. Hãy đưa bước này vào checklist ngày đầu nhận quyền truy cập tài khoản của khách.

Ba chỗ dễ làm hỏng tính lặp lại

Chỗ thứ nhất là tên tài nguyên. Nếu bạn viết cứng tên bảng hay tên bucket, cùng một phần hạ tầng không thể deploy hai lần trong một tài khoản. Khi khách muốn có thêm môi trường thử nghiệm ngay cạnh production, cả hệ thống tắc lại. Cứ để CDK tự sinh tên rồi truyền tên đó cho ứng dụng.

Chỗ thứ hai nguy hiểm hơn. Đổi logical ID của một tài nguyên, chẳng hạn đổi tên construct trong lúc refactor, sẽ khiến tài nguyên đó bị thay bằng tài nguyên mới ở lần deploy tiếp theo. Với database của khách, đó là sự cố thật. AWS khuyên đặt tài nguyên có trạng thái như database vào stack riêng và bật termination protection.

Chỗ thứ ba là các truy vấn tra cứu như tìm VPC hay AMI. Kết quả được lưu trong cdk.context.json, và tệp này cần được commit cùng code để các lần chạy sau dùng đúng giá trị cũ. Môi trường của khách thường sống nhiều năm, nên chỉ một lần tra cứu cho ra kết quả khác cũng đủ làm lệch một deployment vốn đang ổn định.

Giới hạn cần biết trước khi hứa với khách

CDK provision qua CloudFormation, nên nó là công cụ cho hạ tầng trên AWS. Nếu khách chạy trên cloud khác, bạn cần tìm hướng khác. Bước bootstrap cũng đòi bạn có quyền trong từng tài khoản của khách. Ở doanh nghiệp lớn, việc xin quyền này có thể mất nhiều thời gian hơn viết code, vì vậy hãy đặt câu hỏi ngay từ buổi discovery.

Khi số khách tăng lên, deploy từ laptop không còn ổn. Module CDK Pipelines tự động hóa việc build, test và deploy app CDK, đồng thời tự cập nhật chính nó: thêm stage hay stack mới thì pipeline tự cấu hình lại để deploy phần mới. AWS khuyên tách các stage vào những environment riêng biệt, và cách này khớp với mô hình mỗi khách một tài khoản.

Học theo thứ tự nào

Bắt đầu bằng ranh giới giữa construct và stack, vì đây là quyết định thiết kế khó sửa nhất về sau. Tiếp theo là environment và bootstrap, sau đó là unit test cho template. CDK Pipelines để cuối cùng, khi bạn đã thực sự phải quản lý từ hai khách trở lên.

Khi đọc tin tuyển dụng FDE, hãy để ý các cụm như “infrastructure as code” hay “deploy vào môi trường của khách”. Trong CV, một dòng cụ thể như “một construct, triển khai vào N environment, có unit test” có sức nặng hơn hẳn câu “thành thạo AWS”. Cách chứng minh tốt nhất là một repo công khai làm đúng việc đó.

Ở khách đầu tiên, CDK có thể trông như việc thừa. Đến khách thứ hai, bạn sẽ thấy nó đáng giá.

Bài này có hữu ích không?

Dùng cùng trợ lý AIHỏi Claude ↗Hỏi ChatGPT ↗
7 nguồn
Đọc tiếp trên lộ trình · Chặng 2: Kỹ thuật rộngKhách chưa cấp staging? Testcontainers cho bạn Postgres và Redis thậtChỉ cần Docker, mỗi lần chạy test có database riêng, chạy xong là xoá, không phải chờ ai cấp quyền.