AWS AmazonCloudWatch: CloudWatch agent on-premises install: links, credential paths
Summary
Updates links to the Systems Manager hybrid/multicloud docs, adds a cross-reference for S3 download links, rewords minor instructions, adds a note that the agent reads the Region from a `config` file next to a non-default `shared_credential_file`, and corrects example credential file paths for Linux and Windows.
Security assessment
The only credential-adjacent change is a troubleshooting note explaining that when `shared_credential_file` points to a non-default location, the Region must be supplied in a sibling `config` file, otherwise `fetch-config` fails. This is configuration/region-resolution guidance, not a fix for a vulnerability, and the remaining edits are link updates, wording tweaks, and corrected example paths (`/home/username/.aws/credentials`, `C:\\Users\\username\\.aws\\credentials`). No specific weakness, CVE, or incident is referenced.
Evidence
+If you use `shared_credential_file` in `common-config.toml` to point to a credentials file in a non-default location, the agent reads the Region from a file named `config` in the same directory as the credentials file. Add the Region to that file under the profile, as in the following example. If the agent can't find a Region, the `fetch-config` command fails with the error `please make sure the credentials and region set correctly on your hosts`.
Diff
diff --git a/AmazonCloudWatch/latest/monitoring/install-CloudWatch-Agent-on-premise.md b/AmazonCloudWatch/latest/monitoring/install-CloudWatch-Agent-on-premise.md index e65de19..77eeed2 100644 --- a//AmazonCloudWatch/latest/monitoring/install-CloudWatch-Agent-on-premise.md +++ b//AmazonCloudWatch/latest/monitoring/install-CloudWatch-Agent-on-premise.md @@ -15 +15 @@ If you downloaded the CloudWatch agent on a computer and created your agent conf -You can download the CloudWatch agent package using either Systems Manager Run Command or an Amazon S3 download link. +You can download the CloudWatch agent package using either Systems Manager Run Command or an Amazon S3 download link. For information about using an Amazon S3 download link, see [Download the CloudWatch agent package](./download-CloudWatch-Agent-on-EC2-Instance-commandline-first.html). @@ -19 +19 @@ You can download the CloudWatch agent package using either Systems Manager Run C -To use Systems Manager Run Command, you must register your on-premises server with Amazon EC2 Systems Manager. For more information, see [ Setting Up Systems Manager in Hybrid Environments](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html) in the _AWS Systems Manager User Guide_. +To use Systems Manager Run Command, you must register your on-premises server with Amazon EC2 Systems Manager. For more information, see [Managing nodes in hybrid and multicloud environments with Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-hybrid-multicloud.html) in the _AWS Systems Manager User Guide_. @@ -41 +41 @@ If the AWS Systems Manager home page opens, scroll down and choose **Explore Run - 5. In the **Targets** area, select the server to install the CloudWatch agent on. If you don't see a specific server, it might not be configured for Run Command. For more information, see [Setting Up AWS Systems Manager for Hybrid Environments](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html) in the _AWS Systems Manager User Guide_. + 5. In the **Targets** area, select the server to install the CloudWatch agent on. If you don't see a specific server, it might not be configured for Run Command. For more information, see [Managing nodes in hybrid and multicloud environments with Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-hybrid-multicloud.html) in the _AWS Systems Manager User Guide_. @@ -47 +47 @@ If the AWS Systems Manager home page opens, scroll down and choose **Explore Run - 8. Keep **Version** blank to install the latest version of the agent. + 8. Leave **Version** blank to install the latest version of the agent. @@ -73,0 +74,8 @@ If you name this profile `AmazonCloudWatchAgent`, you don't need to do anything +Note + +If you use `shared_credential_file` in `common-config.toml` to point to a credentials file in a non-default location, the agent reads the Region from a file named `config` in the same directory as the credentials file. Add the Region to that file under the profile, as in the following example. If the agent can't find a Region, the `fetch-config` command fails with the error `please make sure the credentials and region set correctly on your hosts`. + + + [profile AmazonCloudWatchAgent] + region = us-west-1 + @@ -93 +101 @@ On Windows Server, open PowerShell as an administrator, enter the following comm -The CloudWatch agent includes a configuration file called `common-config.toml`. You can optionally use this file to specify proxy and Region information. +The CloudWatch agent includes a configuration file called `common-config.toml`. You can use this file to optionally specify proxy and Region information. @@ -123 +130 @@ All lines are commented out initially. To set the credential profile or proxy se - * `shared_credential_profile` – For on-premises servers, this line specifies the IAM user credential profile to use to send data to CloudWatch. If you keep this line commented out, `AmazonCloudWatchAgent` is used. For more information about creating this profile, see (Installing on an on-premises server) Specify IAM credentials and AWS Region. + * `shared_credential_profile` – For on-premises servers, this line specifies the IAM user credential profile to use to send data to CloudWatch. If you keep this line commented out, `AmazonCloudWatchAgent` is used. For more information about creating this profile for an on-premises server, see (Installing on an on-premises server) Specify IAM credentials and AWS Region. @@ -133 +140 @@ The first example below shows the syntax of a valid `shared_credential_file` lin - shared_credential_file= "/usr/username/credentials" + shared_credential_file= "/home/username/.aws/credentials" @@ -135 +142 @@ The first example below shows the syntax of a valid `shared_credential_file` lin - shared_credential_file= "C:\\Documents and Settings\\username\\.aws\\credentials" + shared_credential_file= "C:\\Users\\username\\.aws\\credentials" @@ -150 +157 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Install the CloudWatch agent using AWS Systems Manager +On Amazon EKS @@ -152 +159 @@ Install the CloudWatch agent using AWS Systems Manager -Install the CloudWatch agent on Azure +On Azure