fabio-hara/klb

Nash library to automate your cloud infrastructure (AWS/Azure)

klb

Nash library to mimic the life of @lborguetti (aka klb).

Ok, just kidding, use klb to automate the creation of your infrastructure on AWS or Azure.

Demo

Dependencies

• nash
• jq
• awscli

You can run the following command to install deps:

make deps

Install

Just run:

make install

To install klb on your NASHPATH.

Updating vendored dependencies

make vendor

Testing

Just run make testall.

For each cloud you'll need the environment variables. See the docs for each cloud to help you with each one.

Logging by default will be saved on files, since the tests can be pretty long running and you can check out the progress on the files.

Inside each test package the logs will be saved at ./testdata/logs.

To run redirecting logs to stdout:

Just run make testall logger=stdout.

Azure

You'll need the environment variables below:

• AZURE_SUBSCRIPTION_ID=<subscription id>
• AZURE_TENANT_ID=<tenant id>
• AZURE_CLIENT_ID=<AppId of service principal>
• AZURE_CLIENT_SECRET=<password of service principal>

If you already have a service principal configured, you can setup the environment variables using the getcredentials.sh script.

Basic usage:

λ> ./tools/azure/getcredentials.sh
Usage:  ./tools/azure/getcredentials.sh <(sh|nash)> <service principal name> <service secret>

For cool nash shells:

λ> ./tools/azure/getcredentials.sh nash klb-sp-tests 123456
setenv AZURE_SUBSCRIPTION_ID="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXXXX"
setenv AZURE_SUBSCRIPTION_NAME="CLOUDFORMATION - QA"
setenv AZURE_TENANT_ID="XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXX"
setenv AZURE_CLIENT_ID="XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXX"
setenv AZURE_CLIENT_SECRET="123456"

Redirect the output above to a file and import into your nash session:

λ> ./tools/azure/getcredentials.sh nash <service principal name> <service secret> > credentials
λ> import ./credentials

For lame linux shell (like bash):

λ> ./tools/azure/getcredentials.sh sh klb-sp-tests 123456
export AZURE_SUBSCRIPTION_ID="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXXXX"
export AZURE_SUBSCRIPTION_NAME="CLOUDFORMATION - QA"
export AZURE_TENANT_ID="XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXX"
export AZURE_CLIENT_ID="XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXX"
export AZURE_CLIENT_SECRET="123456"

Redirect the output above to a file and import into your lame shell session:

λ> ./tools/azure/getcredentials.sh sh <service principal name> <service secret> > credentials
λ> source ./credentials

Besides the credential your subscription must also be registered on some resource provider namespaces, since we will be creating resources.

To register on the required providers you can run:

λ> ./tools/azure/registerproviders.sh

If you have not configured the service principal yet, then the following section could be helpful.

Setting up the service principal

The values of AZURE_SUBSCRIPTION_ID and AZURE_TENANT_ID could be obtained from the command below:

λ> azure account show
info:    Executing command account show
data:    Name                        : <SUBSCRIPTION NAME>
data:    ID                          : <AZURE_SUBSCRIPTION_ID>
data:    State                       : Enabled
data:    Tenant ID                   : <AZURE_TENANT_ID>
data:    Is Default                  : true
data:    Environment                 : AzureCloud
data:    Has Certificate             : No
data:    Has Access Token            : Yes
data:    User name                   : <your email address>
data:
info:    account show command OK

In the output above, ID is the AZURE_SUBSCRIPTION_ID and Tenant ID is the AZURE_TENANT_ID. The values of AZURE_CLIENT_ID and AZURE_CLIENT_SECRET came from a previously created service principal. To create a simple service principal to authenticate in the API, follow these steps below.

The following command will create a service principal called klb-sp-tests with a password of your choice. This password will be the value of AZURE_CLIENT_SECRET environment variable.

λ> azure ad sp create -n klb-sp-tests -p <your password>

You'll need to grant permissions to the service principal to authenticate on behalf of your subscription id.

You'll need the Object ID of the just created service principal. To get this value, run the command below and look for the service name klb-sp-tests:

λ> azure ad sp list

And then issue the command below to grant permissions to the klb-sp-tests:

λ> azure role assignment create --objectId <klb-sp-tests object id> -o Owner -c /subscriptions/{AZURE_SUBSCRIPTION_ID}/

To get the AZURE_CLIENT_ID env var value run:

azure ad app list

And get the AppId. For example:

data:    AppId:                   (AZURE_CLIENT_ID)
data:    ObjectId:                XXXX-XXXX-XXXX-XXXXXXXXX
data:    DisplayName:             klb-sp-tests
data:    IdentifierUris:          0=http://klb-sp-tests
data:    ReplyUrls:
data:    AvailableToOtherTenants: False
data:    HomePage:                http://klb-sp-tests

If everything worked as expected, then export the required environment variables and run:

λ> make testall

P.S.:

• barefoot running is not implemented.