Step-by-Step Guide
This section walks you through the process of connecting your AWS EKS cluster to Scoutflo using the Connect Cluster feature.
Step 1: Accessing the Cluster Connection Interface
Log into Scoutflo:
Open your browser.
Sign in to the Scoutflo platform with your credentials.
Scoutflo Action: Authenticates your session and loads your workspace to prepare the environment for cluster management.
Navigate to "My Cluster":
Find the My Cluster section in the left sidebar, located below the workspace dropdown.
Scoutflo Action: Queries the database to display your currently connected clusters and sets up the UI for adding a new one.
Initiate Cluster Addition:
Click the +Add Cluster button in the top-right corner of the My Cluster screen.
What Scoutflo Does: Launches the cluster connection workflow, initializing the interface for AWS EKS integration.
Select Connection Option:
Choose Connect a Cluster from the available options.
What Scoutflo Does: Configures the connection form specifically for AWS EKS, enabling fields for credentials and cluster selection.
Tip: If you manage multiple clusters, you can connect them one at a time by repeating this process.
Step 2: Providing Required Details
Scoutflo needs specific information to locate and authenticate with your AWS EKS cluster. Here’s what to enter and why:
Cloud Credentials Name (Required):
Description: An AWS IAM credentials (Temporary access key ID and secret access key) you’ll provide.
Purpose: These credentials grant Scoutflo secure access to your AWS account to discover and manage your EKS cluster.
How to Set Up: Refer to the Cloud Connection setup guide - Here
Example: "Scoutflo-EKS-Prod-Creds"
What Scoutflo Does: Stores the credential name securely in its system, associating it with your workspace for future use.
AWS Region (Required):
Description: The AWS region where your EKS cluster is deployed (e.g.,
us-west-2,ap-southeast-1).Purpose: Specifies the geographic scope for Scoutflo to search for your cluster.
How to Find: Check your EKS cluster details in the AWS Management Console under “Clusters.”
Example:
us-east-1(North Virginia)What Scoutflo Does: Uses the region to narrow its API calls to the correct AWS endpoint, optimizing the cluster discovery process.
Step 3: Fetching and Selecting Your Cluster
Fetch Available Clusters:
After entering your credentials and region, click Fetch Cluster.
What Scoutflo Does: Uses the AWS SDK to call the
ListClustersandDescribeClusterAPIs, retrieving a list of EKS clusters in the specified region under your AWS account. It validates the credentials and permissions during this step.
Review and Select:
Scoutflo displays a list of detected clusters with details like cluster name, node count, and Kubernetes version.
Choose the cluster you want to connect by selecting it from the list.
What Scoutflo Does: Pulls additional metadata (e.g., endpoint, status) to confirm the cluster’s availability and compatibility with Scoutflo’s features.
Example: Select “prod-cluster-1” with Kubernetes v1.32 and 5 nodes.
Step 4: Connecting the Cluster
Initiate Connection:
Click Connect to link your selected cluster to Scoutflo.
What Scoutflo Does: Establishes a secure connection by:
Authenticating with the EKS API using your credentials.
Retrieving the cluster’s kubeconfig for Kubernetes API access.
Registering the cluster in Scoutflo’s backend, associating it with your workspace.
Validation and Confirmation:
Scoutflo verifies the connection by testing read access (and write access, if enabled) to the cluster.
Upon success, the cluster appears in your My Cluster dashboard with a “Pending” status.
Pre Checks:
Credential Errors: If Scoutflo reports invalid credentials, verify your access key/secret key pair in AWS IAM and ensure they match the entered values.
Cluster Not Listed: Double-check the AWS region; your cluster may be in a different region than specified.
Permission Denied: Confirm your IAM user/role has the required permissions (see Modes section). Update policies if necessary.
Last updated