rdsmon-go

command module
v0.0.0-...-8ec931b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 23, 2023 License: Apache-2.0 Imports: 1 Imported by: 0

README

rdsmon

commandline tool for monitoring aws RDS instances


Quick Start

The requirements for using rdsmon are relatively straight forward, however you will need:

Installation

Install the tool - go get -u github.com/symonk/rdsmon-go (to install the latest version)

Authentication

Typically you require an access token for a user that is configured for rds accessibility using aws IAM roles. Once your user has been created, you will require an access key and this should be either configured on disk, or exposed to the environment running rdsmon. It is completely unadvised to user the root user and the account running the tool should have as minimal permissions as possible. The IAM capabilities required by the tool are:

  • Todo

Important: Properly configured IAM roles/users should be in place, tokens should be kept secure, under no circumstances should you share them with anybody. rdsmon-go utilises the same mechanisms by the aws SDK for credential detection and usage.

To better understand IAM user and policies, please refer to:

AWS IAM user creation

AWS Access Tokens

Configuration on disk

Once you have appropriate IAM roles and have created an access_key, these should be stored in:

~/.aws/credentials

[default]
aws_access_key_id = YOUR_ACCESS_KEY
aws_secret_access_key = YOUR_SECRET_KEY

You may also want to add a default region to the aws configuration file, this should be set in:

~/.aws/config

[default]
region=us-east-1

Monitoring an RDS instance

Todo


Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL