awsx-waf
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 WAF services , primarily the following API's:
This cli collect data from metric / logs / traces of the WAF 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-waf) and save it in the GOPATH
- Now we can execute this command on command prompt as below
awsx-waf 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.
- --valutURL = URL location of vault - that stores credentials to call API
- --acountId = The AWS account id.
- --zone = AWS region
- --accessKey = Access key for the AWS account
- --secretKey = Secret Key for the Aws Account
- --crossAccountRoleArn = Cross Acount Rols Arn for the account.
- --external Id = The AWS External id.
- --webAclId= Insert your webAclId from your aws account.
command output
{
WebACLs: [
WebACLsName : {
}
]
}
How to run
From main awsx command , it is called as follows:
awsx-waf --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-waf
waf extension
AWSX Commands for AWSX-WAF Cli's :
- CMD used to get list of waf instance's :
./awsx-waf --zone=us-east-1 --accessKey=<6f> --secretKey=<> --crossAccountRoleArn=<> --externalId=<>
- CMD used to get Config data (metadata) of AWS waf instances :
./awsx-waf --zone=us-east-1 --accessKey=<#6f> --secretKey=<> --crossAccountRoleArn=<> --externalId=<> getConfigData --webAclId=<>