Synchronizing Kubernetes Resources from AWS

Overview

QueryPie supports AWS integration for Kubernetes cluster registration and management. You can synchronize resources within AWS, register them as clusters managed by QueryPie, and grant Kubernetes API access permissions and configure policies for users and groups on the synchronized clusters.

Modifying AWS EKS Authentication Mode

QueryPie utilizes the EKS access entry API during synchronization for AWS EKS Kubernetes cluster connections. Therefore, if the cluster authentication mode is set to ConfigMap only, there may be connection difficulties, and we recommend changing the mode in the AWS console in advance for smooth synchronization.

1. Access AWS Console with an account that has EKS administrator privileges
2. Navigate to the Elastic Kubernetes Service (EKS) menu
3. Move to the region where the target EKS cluster is located
   • 예)
4. Select the target EKS cluster to navigate to the details page
5. Click the Access tab to view the Access configuration status
6. If the Authentication mode is “ConfigMap”, click the Manage access button on the right
7. Change the Cluster authentication mode to “EKS API and ConfigMap”
8. Click Save changes to save the changes

Registering AWS Integration Information in QueryPie

1. Navigate to Administrator > Kubernetes > Connection Management > Cloud Providers menu
2. Click the + Create Provider button in the top right
3. Enter a name that can distinguish this provider in the Name field
4. Select Amazon Web Services from the Cloud Provider field
5. Select the region of the resources you want to synchronize from the Region field
6. Enter the Credential information required to synchronize resources

1. Default Credentials : If the QueryPie server is installed in the same AWS account, you can assign an IAM role to the EC2 instance where QueryPie is installed to synchronize resources within the same AWS
2. Cross Account Role : You can create an IAM role to synchronize resources from other AWS accounts. Please create permissions for synchronization and assign policies according to the steps displayed on the screen
3. Use Search Filter to retrieve a list of specific resource types you want to synchronize
   1. Search Filter works the same way as AWS search. You can use values such as names and tags as filters, and conveniently enter search conditions and filters using the Enter key in the following order:
      1. Enter Key value and press Enter → Select search condition and press Enter → Enter Value value and press Enter
   2. For more detailed usage, please refer to User Guide for Linux Instances (AWS) 
4. Select the synchronization method from the Replication Frequency field
   1. Manual : A method that synchronizes manually only when you want to synchronize
   2. Scheduling : A method that synchronizes resources through periodic scheduling. Cron Expressions are provided
5. (You can click the Dry Run button to check in advance if there will be any issues with synchronization)
6. Click the Save button to save the Cloud Provider

Synchronizing and Managing Registered AWS Cloud Provider

1. Navigate to Administrator > Kubernetes > Connection Management > Cloud Providers menu
2. Click on the registered Cloud Provider to enter the details screen
3. Click the Synchronize button in the top right to synchronize resources from AWS
   1. Please refer to Dry Run/Synchronization Log Notation below for notation definitions
   2. You can check the synchronization progress in the displayed Synchronization Log, and you can also check the synchronization history in Settings > Systems > Jobs menu
4. Once a Cloud Provider is registered, some information cannot be changed
   1. Name : Can be changed
   2. Cloud Provider : Cannot be changed
   3. Region : Cannot be changed
   4. Credential : Cannot be changed
   5. Role ARN : Cannot be changed
   6. Search Filter : Can be changed
   7. Replication Frequency : Can be changed

Dry Run/Synchronization Log Notation

	발생 시점	문구
✔️	Dry Run 또는 Synchronize 동기화 시작	Cluster synchronization started.
✔️	신규 클러스터 추가 완료	New Cluster is added: {Cluster Name} ({API URL}).
✔️	기존 클러스터 정보 업데이트 완료	Cluster {Cluster Name} is updated
✔️	기존 클러스터 제거 완료	Cluster {Cluster Name} is removed
✔️	Dry Run 또는 Synchronize 동기화 성공적으로 종료	Cluster synchronization succeeded.
	EKS 클러스터의 인증 모드가 EKS API를 허용하지 않는 경우 동기화 스킵. ConfigMap 모드에서 EKS API를 허용하도록 변경 필요.	Skipping sync. Cluster {Cluster Name}’s authentication mode blocks EKS access entry API. To manage access, enable EKS API access.
❌	이미 중복된 클러스터명이 확인되어 동기화 실패	Cluster synchronization failed. The cluster name “{Cluster Name}” is already in use by another cluster. To synchronize it, delete the existing cluster.
❌	Dry Run 또는 Synchronize 동기화 실패 종료	Cluster synchronization failed. + {additional statement}