Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You must have access to the Kubernetes environment where HM resides and also hav

This access requirement is different from other external database monitoring situations with HM, such as [self-managed](../mon_with_agent) deployments of Postgres, where fewer privileges are required.

You must also ensure that the user credentials stored in the Kubernetes secret (beacon-csp-credentials) have sufficient permissions for the AWS RDS environment being monitored. Without these permissions, the system can't retrieve all available metrics.
You must also ensure that the user credentials stored in a Kubernetes secret, for example `example-beacon-csp-credentials`, have sufficient permissions for the AWS RDS environment being monitored. Without these permissions, the system can't retrieve all available metrics.

To do this, you need to obtain an AWS access key of an IAM user with the following minimal permissions:

Expand Down Expand Up @@ -91,28 +91,32 @@ You can set up the agent to monitor all your AWS RDS deployments on HM.

Once you register an RDS region, the system adds every database you have in that RDS region. This can result in several resources being added to your estate. They are all under one project, so you either have access as a user to all the RDS databases or you don't have access to any of them.

1. Add your `beacon-csp-credentials` secret.
1. Add your `example-beacon-csp-credentials` secret.

Add your `beacon-csp-credentials` secret in your HM Kubernetes cluster's `upm-beacon` namespace:
Add your `example-beacon-csp-credentials` secret in your HM Kubernetes cluster's `upm-beacon` namespace.

Example `yaml` sample:

```
kubectl apply -f - <<EOF
apiVersion: v1
kind: Secret
metadata:
name: beacon-csp-credentials
namespace: upm-beacon
name: example-beacon-csp-credentials
namespace: upm-beacon
stringData:
AWS_ACCESS_KEY_ID: replace_with_your_access_key_id
AWS_SECRET_ACCESS_KEY: replace_with_your_secret_access_key
AWS_REGION: example-us-east-1
BEACON_PROVIDER_AWS_CONSTANT_REGIONS: example-us-east-1
BEACON_PROVIDER_AWS_CONSTANT_PROJECT_ID: your_project_id
BEACON_AGENT_PROVIDERS: appliance,aws
BEACON_PROVIDER_AWS_MODE: constant
BEACON_PROVIDER_AWS_CONSTANT_SERVICES: rds
AWS_ACCESS_KEY_ID: <your_access_key_id>
AWS_SECRET_ACCESS_KEY: <your_secret_access_key>
AWS_SESSION_TOKEN: <your_session_token>
AWS_REGION: example-us-east-1
BEACON_PROVIDER_AWS_CONSTANT_REGIONS: example-us-east-1
BEACON_PROVIDER_AWS_CONSTANT_PROJECT_ID: <your_project_id>
BEACON_AGENT_PROVIDERS: appliance,aws
BEACON_PROVIDER_AWS_MODE: constant
BEACON_PROVIDER_AWS_CONSTANT_SERVICES: rds
EOF
```

2. Restart the agent and external metrics receiver:

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ navTitle: Monitoring RDS deployments
description: Learn how to monitor AWS RDS deployments with Hybrid Manager.
---

You can monitor your Amazon Web Service (AWS) relational database service (RDS) deployments with Hybrid Manager (HM).
You can monitor your Amazon Web Service (AWS) Relational Database Service (RDS) deployments with Hybrid Manager (HM).

## Prerequisites

You must have access to the Kubernetes environment where HM resides and also have sufficient administrator privileges to change the settings on the entire HM cluster.

This access requirement is different from other external database monitoring situations with HM, such as [self-managed](../mon_with_agent) deployments of Postgres, where fewer privileges are required.

You must also ensure that the user credentials stored in the Kubernetes secret (beacon-csp-credentials) have sufficient permissions for the AWS RDS environment being monitored. Without these permissions, the system can't retrieve all available metrics.
You must also ensure that the user credentials stored in a Kubernetes secret, for example `example-beacon-csp-credentials`, have sufficient permissions for the AWS RDS environment being monitored. Without these permissions, the system can't retrieve all available metrics.

To do this, you need to obtain an AWS access key of an IAM user with the following minimal permissions:

Expand Down Expand Up @@ -91,28 +91,32 @@ You can set up the agent to monitor all your AWS RDS deployments on HM.

Once you register an RDS region, the system adds every database you have in that RDS region. This can result in several resources being added to your estate. They are all under one project, so you either have access as a user to all the RDS databases or you don't have access to any of them.

1. Add your `beacon-csp-credentials` secret.
1. Add your `example-beacon-csp-credentials` secret.

Add your `beacon-csp-credentials` secret in your HM Kubernetes cluster's `upm-beacon` namespace:
Add your `example-beacon-csp-credentials` secret in your HM Kubernetes cluster's `upm-beacon` namespace.

Example `yaml` sample:

```
kubectl apply -f - <<EOF
apiVersion: v1
kind: Secret
metadata:
name: beacon-csp-credentials
namespace: upm-beacon
name: example-beacon-csp-credentials
namespace: upm-beacon
stringData:
AWS_ACCESS_KEY_ID: replace_with_your_access_key_id
AWS_SECRET_ACCESS_KEY: replace_with_your_secret_access_key
AWS_REGION: example-us-east-1
BEACON_PROVIDER_AWS_CONSTANT_REGIONS: example-us-east-1
BEACON_PROVIDER_AWS_CONSTANT_PROJECT_ID: your_project_id
BEACON_AGENT_PROVIDERS: appliance,aws
BEACON_PROVIDER_AWS_MODE: constant
BEACON_PROVIDER_AWS_CONSTANT_SERVICES: rds
AWS_ACCESS_KEY_ID: <your_access_key_id>
AWS_SECRET_ACCESS_KEY: <your_secret_access_key>
AWS_SESSION_TOKEN: <your_session_token>
AWS_REGION: example-us-east-1
BEACON_PROVIDER_AWS_CONSTANT_REGIONS: example-us-east-1
BEACON_PROVIDER_AWS_CONSTANT_PROJECT_ID: <your_project_id>
BEACON_AGENT_PROVIDERS: appliance,aws
BEACON_PROVIDER_AWS_MODE: constant
BEACON_PROVIDER_AWS_CONSTANT_SERVICES: rds
EOF
```

2. Restart the agent and external metrics receiver:

```
Expand Down
Loading