awsx-eks

• What is awsx-eks
• How to write plugin subcommand
• How to build / Test
• what it does
• command input
• command output
• How to run

awsx-eks

This is a plugin subcommand for awsx cli ( https://github.com/Appkube-awsx/awsx#awsx ) cli.

For details about awsx commands and how its used in Appkube platform , please refer to the diagram below:

This plugin subcommand will implement the Apis' related to EKS services , primarily the following API's:

• getConfigData

This cli collect data from metric / logs / traces of the EKS services and produce the data in a form that Appkube Platform expects.

This CLI , interacts with other Appkube services like Appkube vault , Appkube cloud CMDB so that it can talk with cloud services as well as filter and sort the information in terms of product/env/ services, so that Appkube platform gets the data that it expects from the cli.

How to write plugin subcommand

Please refer to the instaruction - https://github.com/Appkube-awsx/awsx#how-to-write-a-plugin-subcommand

It has detailed instruction on how to write a subcommand plugin , build/test/debug/publish and integrate into the main commmand.

How to build / Test

        go run main.go
            - Program will print Calling aws-cloudelements on console

        Another way of testing is by running go install command
        go install
        - go install command creates an exe with the name of the module (e.g. awsx-eks) and save it in the GOPATH
        - Now we can execute this command on command prompt as below
       awsx-eks getConfigData --zone=us-east-1 --accessKey=xxxxxxxxxx --secretKey=xxxxxxxxxx --crossAccountRoleArn=xxxxxxxxxx  --externalId=xxxxxxxxxx

what it does

This subcommand implement the following functionalities - getConfigData - It will get the resource count summary for a given AWS account id and region.

command input

1. --valutURL = URL location of vault - that stores credentials to call API
2. --acountId = The AWS account id.
3. --zone = AWS region
4. --accessKey = Access key for the AWS account
5. --secretKey = Secret Key for the Aws Account
6. --crossAccountRoleArn = Cross Acount Rols Arn for the account.
7. --external Id = The AWS External id.
8. --clusterName= Insert your cluster name which you craeted in aws account.

command output

cluster:{ Name: "myclustTT", PlatformVersion: "eks.5", ResourcesVpcConfig: { ClusterSecurityGroupId: "sg-090e4da3cac0756bf", EndpointPrivateAccess: false, EndpointPublicAccess: true, PublicAccessCidrs: ["0.0.0.0/0"], SecurityGroupIds: ["sg-068cd5380b837d8ad"], SubnetIds: ["subnet-0c455555dcb4d42ad","subnet-0fc2a8f7da0fdbae0","subnet-024553de2df0a4859"], VpcId: "vpc-0055ade73720f0f0c" }, RoleArn: "arn:aws:iam::657907747545:role/myclustTT-cluster-20220927072756876500000002", Status: "ACTIVE", Tags: { Terraform: "true", Environment: "dev" }, Version: "1.24" }

How to run

From main awsx command , it is called as follows:

awsx-eks  --zone=us-east-1 --accessKey=<> --secretKey=<> --crossAccountRoleArn=<>  --externalId=<>

If you build it locally , you can simply run it as standalone command as:

go run main.go  --zone=us-east-1 --accessKey=<> --secretKey=<> --crossAccountRoleArn=<> --externalId=<>

awsx-eks

eks extension

AWSX Commands for AWSX-eks Cli's :

1. CMD used to get list of eks instance's :

./awsx-eks --zone=us-east-1 --accessKey=<6f> --secretKey=<> --crossAccountRoleArn=<> --externalId=<>

1. CMD used to get Config data (metadata) of AWS eks instances :

./awsx-eks --zone=us-east-1 --accessKey=<#6f> --secretKey=<> --crossAccountRoleArn=<> --externalId=<> getConfigData --clusterName=<>