Skip to content


Yriser Documentation



Welcome to Yriser Open Source Documentation! 📄

You are currently in the Getting Started section where you can find general information and requirements to help start with the tool.

  • In the Tutorials section you will see how to take advantage of all the features in Yriser.
  • In the Best Practices section you will see who implement a tagging strategy.
  • In the Contact Us section you can find how to reach us out in case of technical issues.
  • In the About section you will find more information about the Yriser team and license.

About Yriser

Yriser is an Open Source FinOps tool to perform AWS tagging best practices, tagging strategy, continuous adjustments in cloud optimization.

Yriser will help you answer these questions:

  • How are tags enforced and what methods and automation will be used (proactive vs reactive)?
  • How are tagging effectiveness and goals measured?
  • How often should the tagging strategy be reviewed?
  • Who drives improvements? How is this done?

Twitter URL Linkedin

Quick Start

Yriser has been written in Shell using the jq, bc and AWS CLI.

See Requirements section to install jq, bc and AWS CLI.

Installation

Once Yriser repository is cloned, get into the folder and you can run it:

Requirements:

  • jq
  • bc
  • aws cli
  • AWS credentials

Commands:

git clone https://github.com/yris-ops/yriser
chmod -R +x yriser/
cd yriser
./yriser.sh -v

Requirements:

  • Have docker installed: https://docs.docker.com/get-docker/.
  • AWS credentials
  • In the command below, change -v to your local directory path in order to access the reports.

Commands:

docker run -it \
--name yriser \
--env AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \
--env AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \
--env AWS_SESSION_TOKEN=$AWS_SESSION_TOKEN \
-v /your/local/dir/config.txt:/home/yriser/config.txt \
czantoine/yriser:latest

Requirements:

  • brew install jq
  • brew install bc
  • aws cli
  • AWS credentials

Commands:

git clone https://github.com/yris-ops/yriser
chmod -R +x yriser/
cd yriser
./yriser.sh -v

Requirements:

  • sudo yum install jq
  • sudo yum install bc
  • AWS credentials

Commands:

git clone https://github.com/yris-ops/yriser
chmod -R +x yriser/
cd yriser
./yriser.sh -v

Requirements:

  • sudo yum install jq
  • sudo yum install bc
  • AWS credentials

Commands:

git clone https://github.com/yris-ops/yriser
chmod -R +x yriser/
cd yriser
./yriser.sh -v

Configuration file

Edit the configuration file 

vi config.txt

Below ## TAG KEY and between ## TAG VALUE place your tag keys.

Below ## TAG VALUE and between ## END place your tag values.

More options and executions methods that will save your time in Configuration file

High level architecture

You can run Yriser from your workstation, an EC2 instance, ECS Fargate or any other container, Codebuild, CloudShell, Cloud9 and many more.

Archi

Basic Usage

./yriser.sh

Short Display Yriser

Running the yriser.sh script whitout options will use your environment variable credentials, see Requirements section to review the credentials settings.

By default, Yriser will generate a CSV and HTM reports.

The HTML report will be located in the output directory as the other files and it will look like:

Report output HTML

More options and executions methods that will save your time in Commands

You can always use -h to access to the usage information and all the possible options:

./yriser.sh -h

AWS

You can always use -a to access to the usage information and all the possible options:

./yriser.sh -a

Use a custom AWS profile with -p and/or AWS regions which you want to audit with -r:

./yriser.sh -p <aws_profile> -r "us-east-1 eu-west-1"

By default, Yriser will scan all AWS regions.

See more details about AWS Authentication in Requirements.