EKS Deployment of DataKit¶
Introduction¶
Amazon Elastic Kubernetes Service (Amazon EKS) is an Amazon-provided Kubernetes managed service. Users can deploy containerized applications without needing to install, operate, or maintain the Kubernetes control panel or nodes.
There are two ways to deploy DataKit on EKS:
- First method: Use kubectl to execute datakit.yaml
- Second method: Install Helm and use Helm to deploy DataKit
This article describes deploying kubectl and eksctl on a single EC2 instance to connect to the EKS cluster, then deploying Helm on EC2 and using Helm to deploy DataKit.
Prerequisites¶
- You need to first create a Guance account.
- You need to first create an AWS account.
- Install EKS cluster
- One EC2 instance (Amazon Linux 2 AMI image)
Procedures¶
Warning
The version information used in this example is: DataKit 1.5.2, Kubernetes 1.24, kubectl v1.23.6, Helm v3.8.2
1 Install kubectl¶
Run the following commands to install kubectl.
wget https://dl.k8s.io/release/v1.23.6/bin/linux/amd64/kubectl
chmod +x kubectl
mv kubectl /bin/kubectl
Check the kubectl version.
2 Connect to EKS¶
2.1 Configure Amazon CLI¶
This example uses an AMI image with Amazon CLI pre-installed.
If you're not using an Amazon CLI image, you need to install it; please refer to Amazon CLI Installation.
Log into EC2 and enter aws configure. Follow the prompts to input the Access Key ID, Access Key, and region from the AWS account used to create EKS. Input json for Default output format.
2.2 Install eksctl¶
Run the following command to install eksctl.
curl --silent --location "https://github.com/weaveworks/eksctl/releases/latest/download/eksctl_$(uname -s)_amd64.tar.gz" | tar xz -C /tmp
mv /tmp/eksctl /bin
chmod +x /bin/eksctl
Check the eksctl version.
2.3 Configure EKS Cluster¶
Go to AWS's EKS console and check the cluster name.
Use the following command to configure the cluster, where region is cn-northwest-1 and name is the EKS cluster name.
Use the kubectl command to view the cluster Pods. If there are results, it means the connection to EKS has been successful.
3 Install Helm¶
Log into EC2 and use the following command to install Helm.
wget wget https://get.helm.sh/helm-v3.8.2-linux-amd64.tar.gz
tar -zxvf helm-v3.8.2-linux-amd64.tar.gz
mv linux-amd64/helm /usr/bin/helm
Check the Helm version.
4 Deploy DataKit¶
4.1 Obtain Token¶
Log into 「Guance」 - 「Manage」 - 「Settings」, find the Token, click on the copy icon on the right, which will be used in the next step.
4.2 Add Helm Repository¶
To deploy DataKit using Helm, first add the DataKit Helm repository.
Check if the repository was added successfully.
4.3 Configure DataKit¶
Download and extract the DataKit package from the repository to make it easier to add configurations.
Edit the values.yaml file and paste the obtained token into the red box position in the dataway_url below.
Add cluster_name_k8s=k8s-aws to global_tags, which adds the global Tag cluster_name_k8s for non-election metric collection.
Set the environment variable ENV_NAMESPACE value to k8s-aws, by default enabling DataKit election, ensuring only one DataKit collects election-based metrics within the workspace + this namespace, avoiding duplicate collection.
Also add the environment variable ENV_GLOBAL_ELECTION_TAGS, which adds the global Tag cluster_name_k8s for election-based metrics.
Note: All three instances of k8s-aws mentioned above can be changed to other strings, but they must differ across different clusters.
If you want to enable collectors, you can add configurations under dfconfig; the commented-out part is an example for enabling the mysql collector.
4.4 Install DataKit¶
Run the following command to deploy DataKit. If the datakit namespace already exists, you can remove the --create-namespace option.
After deployment, log into Guance 「Workspace」 and check kube-prefixed metrics in 「Metrics」 - 「Metric Management」. There should be a global tag cluster_name_k8s.
