awsx-glue

README

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

awsx-glue

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 GLUE services , primarily the following API's:

• getConfigData

This cli collect data from metric / logs / traces of the GLUE 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-glue) and save it in the GOPATH
        - Now we can execute this command on command prompt as below
       awsx-glue 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. --jobName= Insert jobName from GLUE service in aws account.

command output

{ JobNames: [ "test_etl_0_da8c3be6", "test_etl_1_115e15be", "test_etl_2_a4f07ba4", "test_etl_3_6cdfabbf", ] }

How to run

From main awsx command , it is called as follows:

awsx-glue  --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-glue

glue extension

AWSX Commands for AWSX-GLUE Cli's :

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

./awsx-glue --zone=us-east-1 --accessKey=<> --secretKey=<> --crossAccountRoleArn=<> --externalId=<>

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

./awsx-glue --zone=us-east-1 --accessKey=<> --secretKey=<> --crossAccountRoleArn=<> --externalId=<> getConfigData --jobName=<>

Documentation

Overview

Copyright © 2023 Afreen khan <afreen.khan@synectiks.com>